@akinon/eslint-plugin-projectzero 1.13.0 → 1.14.0

package/rules/check-locale.ts

@@ -1,78 +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: []
-});
+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/check-middleware-order.ts

@@ -1,64 +1,64 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-
-const correctOrder = [
-  'withOauthLogin',
-  'withLocale',
-  'withCurrency',
-  'withPrettyUrl',
-  'withRedirectionPayment',
-  'withThreeDRedirection',
-  'withUrlRedirection'
-];
-
-export default ESLintUtils.RuleCreator.withoutDocs({
-  create(context: any) {
-    return {
-      CallExpression(node: any) {
-        if (
-          node.callee.type === 'Identifier' &&
-          correctOrder.includes(node.callee.name)
-        ) {
-          let current = node;
-          const callSequence = [];
-
-          while (
-            current.type === 'CallExpression' &&
-            current.callee.type === 'Identifier'
-          ) {
-            if (correctOrder.includes(current.callee.name)) {
-              callSequence.unshift(current.callee.name);
-            }
-            current = current.parent;
-          }
-
-          let isValidOrder = true;
-          for (let i = 0; i < callSequence.length; i++) {
-            if (callSequence[i] !== correctOrder[i]) {
-              isValidOrder = false;
-              break;
-            }
-          }
-
-          // Report an error if the order is incorrect
-          if (!isValidOrder) {
-            context.report({
-              node,
-              message: `Incorrect order of middleware functions. Expected order: ${correctOrder.join(
-                ', '
-              )}. Found order: ${callSequence.join(', ')}.`
-            });
-          }
-        }
-      }
-    };
-  },
-  meta: {
-    type: 'problem',
-    schema: [],
-    messages: {
-      incorrectMiddlewareOrder:
-        'Incorrect middleware order. Expected {{expected}}, found {{found}}.'
-    }
-  },
-  defaultOptions: []
-});
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+const correctOrder = [
+  'withOauthLogin',
+  'withLocale',
+  'withCurrency',
+  'withPrettyUrl',
+  'withRedirectionPayment',
+  'withThreeDRedirection',
+  'withUrlRedirection'
+];
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context: any) {
+    return {
+      CallExpression(node: any) {
+        if (
+          node.callee.type === 'Identifier' &&
+          correctOrder.includes(node.callee.name)
+        ) {
+          let current = node;
+          const callSequence = [];
+
+          while (
+            current.type === 'CallExpression' &&
+            current.callee.type === 'Identifier'
+          ) {
+            if (correctOrder.includes(current.callee.name)) {
+              callSequence.unshift(current.callee.name);
+            }
+            current = current.parent;
+          }
+
+          let isValidOrder = true;
+          for (let i = 0; i < callSequence.length; i++) {
+            if (callSequence[i] !== correctOrder[i]) {
+              isValidOrder = false;
+              break;
+            }
+          }
+
+          // Report an error if the order is incorrect
+          if (!isValidOrder) {
+            context.report({
+              node,
+              message: `Incorrect order of middleware functions. Expected order: ${correctOrder.join(
+                ', '
+              )}. Found order: ${callSequence.join(', ')}.`
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    type: 'problem',
+    schema: [],
+    messages: {
+      incorrectMiddlewareOrder:
+        'Incorrect middleware order. Expected {{expected}}, found {{found}}.'
+    }
+  },
+  defaultOptions: []
+});

package/rules/client-url.ts

@@ -1,44 +1,44 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-
-export default ESLintUtils.RuleCreator.withoutDocs({
-  create(context) {
-    if (!context.getFilename().includes('urls.ts')) {
-      return {};
-    }
-
-    return {
-      Literal(node) {
-        const value = node.value?.toString();
-        const isStrLiteral = value?.includes('${');
-
-        if (!value) {
-          return;
-        }
-
-        if (value.endsWith('/')) {
-          context.report({
-            messageId: 'clientUrl',
-            node,
-            fix: (fixer) =>
-              fixer.replaceText(
-                node,
-                `${isStrLiteral ? '`' : `'`}${value.substring(
-                  0,
-                  value.length - 1
-                )}${isStrLiteral ? '`' : `'`}`
-              )
-          });
-        }
-      }
-    };
-  },
-  meta: {
-    messages: {
-      clientUrl: 'Client URLs must not end with slash(/).'
-    },
-    type: 'problem',
-    fixable: 'code',
-    schema: []
-  },
-  defaultOptions: []
-});
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    if (!context.getFilename().includes('urls.ts')) {
+      return {};
+    }
+
+    return {
+      Literal(node) {
+        const value = node.value?.toString();
+        const isStrLiteral = value?.includes('${');
+
+        if (!value) {
+          return;
+        }
+
+        if (value.endsWith('/')) {
+          context.report({
+            messageId: 'clientUrl',
+            node,
+            fix: (fixer) =>
+              fixer.replaceText(
+                node,
+                `${isStrLiteral ? '`' : `'`}${value.substring(
+                  0,
+                  value.length - 1
+                )}${isStrLiteral ? '`' : `'`}`
+              )
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      clientUrl: 'Client URLs must not end with slash(/).'
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/image-import.ts

@@ -1,44 +1,44 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-
-export default ESLintUtils.RuleCreator.withoutDocs({
-  create(context) {
-    if (context.getFilename().includes('components/image.tsx')) {
-      return {};
-    }
-
-    return {
-      ImportDeclaration(node) {
-        if (node.source.value === 'next/image') {
-          context.report({
-            messageId: 'imageImport',
-            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 'components';`
-                  )
-                  .join('\n')
-              );
-            }
-          });
-        }
-      }
-    };
-  },
-  meta: {
-    messages: {
-      imageImport: "Import 'Image' component from 'components'."
-    },
-    type: 'problem',
-    fixable: 'code',
-    schema: []
-  },
-  defaultOptions: []
-});
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    if (context.getFilename().includes('components/image.tsx')) {
+      return {};
+    }
+
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === 'next/image') {
+          context.report({
+            messageId: 'imageImport',
+            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 'components';`
+                  )
+                  .join('\n')
+              );
+            }
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      imageImport: "Import 'Image' component from 'components'."
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});

package/rules/index.ts

@@ -1,21 +1,23 @@
-import clientUrl from './client-url';
-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';
-import checkMiddlewareOrder from './check-middleware-order';
-
-const rules = {
-  'client-url': clientUrl,
-  'image-import': imageImport,
-  'link-import': linkImport,
-  'router-import': routerImport,
-  'skip-trailing-slash-redirect': skipTrailingSlashRedirect,
-  'check-locale': checkLocale,
-  'meta-data-import': metaDataImport,
-  'check-middleware-order': checkMiddlewareOrder
-};
-
-export { rules };
+import clientUrl from './client-url';
+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';
+import checkMiddlewareOrder from './check-middleware-order';
+import urlsWithoutSlash from './urls-without-slash';
+
+const rules = {
+  'client-url': clientUrl,
+  'image-import': imageImport,
+  'link-import': linkImport,
+  'router-import': routerImport,
+  'skip-trailing-slash-redirect': skipTrailingSlashRedirect,
+  'check-locale': checkLocale,
+  'meta-data-import': metaDataImport,
+  'check-middleware-order': checkMiddlewareOrder,
+  'urls-without-slash': urlsWithoutSlash
+};
+
+export { rules };

package/rules/link-import.ts

@@ -1,44 +1,44 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-
-export default ESLintUtils.RuleCreator.withoutDocs({
-  create(context) {
-    if (context.getFilename().includes('components/link.tsx')) {
-      return {};
-    }
-
-    return {
-      ImportDeclaration(node) {
-        if (node.source.value === 'next/link') {
-          context.report({
-            messageId: 'linkImport',
-            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 'components';`
-                  )
-                  .join('\n')
-              );
-            }
-          });
-        }
-      }
-    };
-  },
-  meta: {
-    messages: {
-      linkImport: "Import 'Link' component from 'components'."
-    },
-    type: 'problem',
-    fixable: 'code',
-    schema: []
-  },
-  defaultOptions: []
-});
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    if (context.getFilename().includes('components/link.tsx')) {
+      return {};
+    }
+
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === 'next/link') {
+          context.report({
+            messageId: 'linkImport',
+            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 'components';`
+                  )
+                  .join('\n')
+              );
+            }
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    messages: {
+      linkImport: "Import 'Link' component from 'components'."
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});