honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(docs-infra): add profile picture size check (#41253) 

This commit updates the logic that validates contributors.json data and introduces a new check that verifies that profile images don't exceed specified limit.

PR Close #41253
This commit is contained in:
Andrew Kushnir 2021-03-17 16:14:23 -07:00 committed by Misko Hevery
parent fbdb19c263
commit 2ccb579e06
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
aio/scripts/contributors/validate-data.js
View File

@ -1,15 +1,28 @@
#!/usr/bin/env node #!/usr/bin/env node
// Imports // Imports
const {existsSync, readFileSync} = require('fs'); const {existsSync, readFileSync, statSync} = require('fs');
const {join, resolve} = require('path'); const {basename, join, resolve} = require('path');
// Constants // Constants
const MAX_IMAGE_SIZE = 30 * 1024; // 30kb
const CONTENT_DIR = resolve(__dirname, '../../content'); const CONTENT_DIR = resolve(__dirname, '../../content');
const IMAGES_DIR = join(CONTENT_DIR, 'images/bios'); const IMAGES_DIR = join(CONTENT_DIR, 'images/bios');
const CONTRIBUTORS_PATH = join(CONTENT_DIR, 'marketing/contributors.json'); const CONTRIBUTORS_PATH = join(CONTENT_DIR, 'marketing/contributors.json');
const EXISTING_GROUPS = new Set(['Angular', 'GDE', 'Collaborators']); const EXISTING_GROUPS = new Set(['Angular', 'GDE', 'Collaborators']);
// The list of profile images that exceed specified `MAX_IMAGE_SIZE` limit.
// These images were added before the size check was introduced. Exclude these images
// from size check for now, but still check other images (more importantly run the check
// for new PRs where profile images are added).
const EXCLUDE_FROM_SIZE_CHECK = new Set([
'alainchautard.png', 'ahsanayaz.jpg', 'alan-agius4.jpg', 'andrew-kushnir.jpg',
'brian-love.jpg', 'cexbrayat.jpg', 'christianliebel.jpg', 'patovargas.png', 'gerardsans.jpg',
'jessicajaniuk.jpg', 'JiaLiPassion.jpg', 'juristr.jpg', 'katerina.jpg', 'kimmaida.jpg',
'kyliau.jpg', 'lacolaco.jpg', 'leonardo.jpg', 'nirkaufman.jpg', 'sajee.jpg', 'sonukapoor.jpg',
'tracylee.jpg', 'twerske.jpg', 'wesgrimes.jpg'
]);
// Run // Run
_main(); _main();
@ -29,6 +42,16 @@ function _main() {
missingImages.map(path => `\n - ${path}`).join('')); missingImages.map(path => `\n - ${path}`).join(''));
} }
// Check that there are no images that exceed the size limit.
const tooLargeImages = expectedImages
.filter(path => !EXCLUDE_FROM_SIZE_CHECK.has(basename(path)))
.filter(path => statSync(path).size > MAX_IMAGE_SIZE);
if (tooLargeImages.length > 0) {
throw new Error(
`The following pictures exceed maximum size limit of ${MAX_IMAGE_SIZE / 1024}kb:` +
tooLargeImages.map(path => `\n - ${path}`).join(''));
}
// Verify that all keys are sorted alphabetically // Verify that all keys are sorted alphabetically
const keys = Object.keys(contributors); const keys = Object.keys(contributors);
for (let i = 1; i < keys.length; i++) { for (let i = 1; i < keys.length; i++) {