@akinon/eslint-plugin-projectzero 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.5.0
+
+### Minor Changes
+
+- Add check-locale rule
+- Add rules for extended Metadata import
+
+## 1.4.0
+
 ## 1.3.0
 
 ## 1.2.0

package/configs/core.ts

@@ -5,6 +5,8 @@ export default {
     '@akinon/projectzero/link-import': 'error',
     '@akinon/projectzero/router-import': 'error',
     '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
+    '@akinon/projectzero/check-locale': 'error',
+    '@akinon/projectzero/meta-data-import': 'error',
     'no-restricted-syntax': [
       'error',
       {

package/dist/configs/core.js

@@ -7,6 +7,8 @@ exports.default = {
         '@akinon/projectzero/link-import': 'error',
         '@akinon/projectzero/router-import': 'error',
         '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
+        '@akinon/projectzero/check-locale': 'error',
+        '@akinon/projectzero/meta-data-import': 'error',
         'no-restricted-syntax': [
             'error',
             {

package/dist/rules/check-locale.js

@@ -0,0 +1,85 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const MONOREPO_LOCALES_DIR = path.resolve(__dirname, '../../../../apps/projectzeropwa/public/locales/en');
+const STANDARD_REPO_LOCALES_DIR = path.join(process.cwd(), 'public/locales/en');
+const LOCALES_DIR = fs.existsSync(MONOREPO_LOCALES_DIR)
+    ? MONOREPO_LOCALES_DIR
+    : STANDARD_REPO_LOCALES_DIR;
+const getAllKeysFromObject = (obj, prefix = '') => {
+    return Object.keys(obj).reduce((result, key) => {
+        if (typeof obj[key] === 'object' && !Array.isArray(obj[key])) {
+            return result.concat(getAllKeysFromObject(obj[key], `${prefix}${key}.`));
+        }
+        return result.concat(`${prefix}${key}`);
+    }, []);
+};
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            CallExpression(node) {
+                if (node.callee.type !== 'Identifier' || node.callee.name !== 't') {
+                    return;
+                }
+                const [firstArg] = node.arguments;
+                if (firstArg &&
+                    firstArg.type === 'Literal' &&
+                    typeof firstArg.value === 'string') {
+                    const key = firstArg.value;
+                    const filename = `${key.split('.')[0]}.json`;
+                    const filepath = path.join(LOCALES_DIR, filename);
+                    if (fs.existsSync(filepath)) {
+                        const jsonContent = JSON.parse(fs.readFileSync(filepath, 'utf-8'));
+                        const allKeys = getAllKeysFromObject(jsonContent, filename.replace('.json', '.'));
+                        if (!allKeys.includes(key)) {
+                            context.report({
+                                node: firstArg,
+                                messageId: 'missingLocalizationKey'
+                            });
+                        }
+                    }
+                    else {
+                        context.report({
+                            node: firstArg,
+                            messageId: 'missingLocalizationFile'
+                        });
+                    }
+                }
+            }
+        };
+    },
+    meta: {
+        messages: {
+            missingLocalizationKey: 'The localization key does not exist in the JSON files.',
+            missingLocalizationFile: 'The localization file does not exist.'
+        },
+        type: 'problem',
+        schema: []
+    },
+    defaultOptions: []
+});

package/dist/rules/index.js

@@ -9,11 +9,15 @@ const image_import_1 = __importDefault(require("./image-import"));
 const link_import_1 = __importDefault(require("./link-import"));
 const router_import_1 = __importDefault(require("./router-import"));
 const skip_trailing_slash_redirect_1 = __importDefault(require("./skip-trailing-slash-redirect"));
+const check_locale_1 = __importDefault(require("./check-locale"));
+const meta_data_import_1 = __importDefault(require("./meta-data-import"));
 const rules = {
     'client-url': client_url_1.default,
     'image-import': image_import_1.default,
     'link-import': link_import_1.default,
     'router-import': router_import_1.default,
-    'skip-trailing-slash-redirect': skip_trailing_slash_redirect_1.default
+    'skip-trailing-slash-redirect': skip_trailing_slash_redirect_1.default,
+    'check-locale': check_locale_1.default,
+    'meta-data-import': meta_data_import_1.default
 };
 exports.rules = rules;

package/dist/rules/meta-data-import.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            ImportDeclaration(node) {
+                const targetImportName = 'Metadata';
+                const importSpecifiers = node.specifiers
+                    .filter((specifier) => specifier.type === 'ImportSpecifier')
+                    .map((specifier) => specifier.local.name);
+                if (importSpecifiers.includes(targetImportName) &&
+                    node.source.value === 'next') {
+                    context.report({
+                        messageId: 'metaDataImport',
+                        node,
+                        fix: (fixer) => {
+                            if (node.specifiers.find((s) => s.type === 'ImportSpecifier')) {
+                                return null;
+                            }
+                            return fixer.replaceText(node, node.specifiers
+                                .map((specifier) => `import { ${specifier.local.name} } from '@akinon/next/types';`)
+                                .join('\n'));
+                        }
+                    });
+                }
+            }
+        };
+    },
+    meta: {
+        messages: {
+            metaDataImport: "Import '{ Metadata }' component from '@akinon/next/types'."
+        },
+        type: 'problem',
+        fixable: 'code',
+        schema: []
+    },
+    defaultOptions: []
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/eslint-plugin-projectzero",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "private": false,
   "description": "ESLint plugin for Project Zero Next",
   "main": "dist/index.js",

package/rules/check-locale.ts

@@ -0,0 +1,78 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import * as path from 'path';
+import * as fs from 'fs';
+
+const MONOREPO_LOCALES_DIR = path.resolve(
+  __dirname,
+  '../../../../apps/projectzeropwa/public/locales/en'
+);
+
+const STANDARD_REPO_LOCALES_DIR = path.join(process.cwd(), 'public/locales/en');
+
+const LOCALES_DIR = fs.existsSync(MONOREPO_LOCALES_DIR)
+  ? MONOREPO_LOCALES_DIR
+  : STANDARD_REPO_LOCALES_DIR;
+
+const getAllKeysFromObject = (obj: any, prefix = ''): string[] => {
+  return Object.keys(obj).reduce((result, key) => {
+    if (typeof obj[key] === 'object' && !Array.isArray(obj[key])) {
+      return result.concat(getAllKeysFromObject(obj[key], `${prefix}${key}.`));
+    }
+    return result.concat(`${prefix}${key}`);
+  }, [] as string[]);
+};
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context: any) {
+    return {
+      CallExpression(node: any) {
+        if (node.callee.type !== 'Identifier' || node.callee.name !== 't') {
+          return;
+        }
+
+        const [firstArg] = node.arguments;
+
+        if (
+          firstArg &&
+          firstArg.type === 'Literal' &&
+          typeof firstArg.value === 'string'
+        ) {
+          const key = firstArg.value;
+
+          const filename = `${key.split('.')[0]}.json`;
+          const filepath = path.join(LOCALES_DIR, filename);
+
+          if (fs.existsSync(filepath)) {
+            const jsonContent = JSON.parse(fs.readFileSync(filepath, 'utf-8'));
+            const allKeys = getAllKeysFromObject(
+              jsonContent,
+              filename.replace('.json', '.')
+            );
+
+            if (!allKeys.includes(key)) {
+              context.report({
+                node: firstArg,
+                messageId: 'missingLocalizationKey'
+              });
+            }
+          } else {
+            context.report({
+              node: firstArg,
+              messageId: 'missingLocalizationFile'
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      missingLocalizationKey:
+        'The localization key does not exist in the JSON files.',
+      missingLocalizationFile: 'The localization file does not exist.'
+    },
+    type: 'problem',
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/index.ts

@@ -3,13 +3,17 @@ import imageImport from './image-import';
 import linkImport from './link-import';
 import routerImport from './router-import';
 import skipTrailingSlashRedirect from './skip-trailing-slash-redirect';
+import checkLocale from './check-locale';
+import metaDataImport from './meta-data-import';
 
 const rules = {
   'client-url': clientUrl,
   'image-import': imageImport,
   'link-import': linkImport,
   'router-import': routerImport,
-  'skip-trailing-slash-redirect': skipTrailingSlashRedirect
+  'skip-trailing-slash-redirect': skipTrailingSlashRedirect,
+  'check-locale': checkLocale,
+  'meta-data-import': metaDataImport
 };
 
 export { rules };

package/rules/meta-data-import.ts

@@ -0,0 +1,50 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        const targetImportName = 'Metadata';
+
+        const importSpecifiers = node.specifiers
+          .filter((specifier) => specifier.type === 'ImportSpecifier')
+          .map((specifier) => specifier.local.name);
+
+        if (
+          importSpecifiers.includes(targetImportName) &&
+          node.source.value === 'next'
+        ) {
+          context.report({
+            messageId: 'metaDataImport',
+            node,
+            fix: (fixer) => {
+              if (node.specifiers.find((s) => s.type === 'ImportSpecifier')) {
+                return null;
+              }
+
+              return fixer.replaceText(
+                node,
+                node.specifiers
+                  .map(
+                    (specifier) =>
+                      `import { ${specifier.local.name} } from '@akinon/next/types';`
+                  )
+                  .join('\n')
+              );
+            }
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      metaDataImport:
+        "Import '{ Metadata }' component from '@akinon/next/types'."
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});