jprdonnelly/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-04-30 16:01:14 -04:00
Code Issues Projects Releases Wiki Activity

chore: remove validate-keys script (#64341)

Browse Source
This commit is contained in:
Oliver Eyton-Williams
2025-12-05 20:26:05 +01:00
committed by GitHub
parent bcacf747ed
commit 29420e8214
2 changed files with 1 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
client/package.json
View File

@@ -35,8 +35,7 @@
"serve-ci": "serve -l 8000 -c serve.json public",
"prestand-alone": "pnpm run prebuild",
"stand-alone": "gatsby develop",
"test": "vitest",
"validate-keys": "tsx --tsconfig ../tsconfig.json ../tools/scripts/lint/validate-keys"
"test": "vitest"
},
"dependencies": {
"@babel/plugin-proposal-export-default-from": "7.23.3",

103
tools/scripts/lint/validate-keys.ts
View File

@@ -1,103 +0,0 @@
import fs from 'fs';
import path from 'path';
import introObject from '../../../client/i18n/locales/english/intro.json';
import linksObject from '../../../client/i18n/locales/english/links.json';
import metaObject from '../../../client/i18n/locales/english/meta-tags.json';
import motivationObject from '../../../client/i18n/locales/english/motivation.json';
import translationsObject from '../../../client/i18n/locales/english/translations.json';
// If this trending.json is missing, most likely the download-trending script failed.
import trendingObject from '../../../client/i18n/locales/english/trending.json';
/**
* Function to flatten a nested object. Written specifically for
* our translation flow, the `namespace` value is used to create the
* property chains that are used in the i18n replacement scripts.
*/
const flattenAnObject = (
obj: Record<string, unknown>,
namespace = ''
): Record<string, unknown> => {
const flattened: Record<string, unknown> = {};
Object.keys(obj).forEach((key: string) => {
if (Array.isArray(obj[key])) {
flattened[namespace ? `${namespace}.${key}` : key] = obj[key];
} else if (typeof obj[key] === 'object') {
Object.assign(
flattened,
flattenAnObject(
obj[key] as Record<string, unknown>,
namespace ? `${namespace}.${key}` : key
)
);
} else {
flattened[namespace ? `${namespace}.${key}` : key] = obj[key];
}
});
return flattened;
};
const translationKeys: string[] = Object.keys(
flattenAnObject(translationsObject)
);
const metaKeys: string[] = Object.keys(flattenAnObject(metaObject));
const motivationKeys: string[] = Object.keys(flattenAnObject(motivationObject));
const introKeys: string[] = Object.keys(flattenAnObject(introObject));
const trendingKeys: string[] = Object.keys(flattenAnObject(trendingObject));
const linksKeys: string[] = Object.keys(flattenAnObject(linksObject));
/**
* Recursively read through the directory, grabbing .js files
* in each nested subdirectory and concatenating them all in
* to one string.
*/
const readComponentCode = (filePath: string): string => {
let code = '';
const isItFolder: boolean = fs.lstatSync(filePath).isDirectory();
if (isItFolder) {
const contents: string[] = fs.readdirSync(filePath);
contents.forEach((file: string) => {
code += readComponentCode(path.join(filePath + '/' + file));
});
} else {
if (!filePath.endsWith('.js') || filePath.endsWith('.test.js')) {
return '';
}
code += fs.readFileSync(filePath).toString();
}
return code;
};
const clientCodebase: string = readComponentCode(
path.join(process.cwd() + '/src')
);
for (const key of translationKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The translation key '${key}' appears to be unused.`);
}
}
for (const key of motivationKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The motivation key '${key}' appears to be unused.`);
}
}
for (const key of metaKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The meta key '${key}' appears to be unused.`);
}
}
for (const key of introKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The intro key '${key}' appears to be unused.`);
}
}
for (const key of trendingKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The trending key '${key}' appears to be unused.`);
}
}
for (const key of linksKeys) {
if (!clientCodebase.includes(key)) {
console.warn(`The links key '${key}' appears to be unused.`);
}
}