refactor(client): ts-migration of i18n/validate-keys.js (#44292)

* refactor - file extenstion change to .ts * fix - imports syntax * fix - migration complete * fix - lint:prettier warn * refactor - validate-keys in tools/scripts/lint/ * refactor - validate-keys.ts moved to tools/scripts/lint and added in tsconfig.json * refactor - tsconfig.json file for tools * fix - lint:ts script update and validate-keys.js added to .eslintignore * fix - lint:prettier and ts compilation * fix - ts compilation * refactor - changes in .gitignore and validate-keys script
2021-11-30 22:07:00 +05:30
parent bcb0465a50
commit 5b61c8a56f
9 changed files with 59 additions and 42 deletions
--- a/tools/scripts/lint/validate-keys.ts
+++ b/tools/scripts/lint/validate-keys.ts
@ -0,0 +1,105 @@
+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';
+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);
+  }
+  return code;
+};
+
+const clientCodebase: string = readComponentCode(
+  path.join(process.cwd() + '/src')
+);
+const serverCodebase: string = readComponentCode(
+  path.join(process.cwd() + '/../api-server/src/server')
+);
+
+for (const key of translationKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The translation key '${key}' appears to be unused.`);
+  }
+}
+for (const key of motivationKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The motivation key '${key}' appears to be unused.`);
+  }
+}
+for (const key of metaKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The meta key '${key}' appears to be unused.`);
+  }
+}
+for (const key of introKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The intro key '${key}' appears to be unused.`);
+  }
+}
+for (const key of trendingKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The trending key '${key}' appears to be unused.`);
+  }
+}
+for (const key of linksKeys) {
+  if (!clientCodebase.includes(key) && !serverCodebase.includes(key)) {
+    console.warn(`The links key '${key}' appears to be unused.`);
+  }
+}