@akinon/eslint-plugin-projectzero 1.1.1 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.3.0
+
+## 1.2.0
+
+### Patch Changes
+
+- Add skipTrailingSlashRedirect rule.
+
 ## 1.1.1
 
 ## 1.1.0

package/README.md

@@ -1,5 +1,5 @@
 
-# eslint-plugin-projectzero
+# @akinon/eslint-plugin-projectzero
 
 ESLint plugin for **Project Zero PWA**.
 It includes core and recommended rule sets.
@@ -21,10 +21,10 @@ Add the following lines to **.eslintrc.js** file.
     extends: [
 		...
 		...
-		'plugin:projectzero/core', // DO NOT remove this config for stability
-		'plugin:projectzero/recommended' // Optional
+		'plugin:@akinon/projectzero/core', // DO NOT remove this config for stability
+		'plugin:@akinon/projectzero/recommended' // Optional
 	],
     plugins: [
 	    ...
-		'projectzero'
-	]
+		'@akinon/projectzero'
+	]

package/configs/core.ts

@@ -1,14 +1,16 @@
 export default {
   rules: {
-    'projectzero/image-import': 'error',
-    'projectzero/client-url': 'error',
-    'projectzero/link-import': 'error',
-    'projectzero/router-import': 'error',
-    "no-restricted-syntax": [
-      "error",
+    '@akinon/projectzero/image-import': 'error',
+    '@akinon/projectzero/client-url': 'error',
+    '@akinon/projectzero/link-import': 'error',
+    '@akinon/projectzero/router-import': 'error',
+    '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
+    'no-restricted-syntax': [
+      'error',
       {
-        "selector": "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
-        "message": "You should use it as 'Settings.commerceUrl'"
+        selector:
+          "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
+        message: "You should use it as 'Settings.commerceUrl'"
       }
     ]
   }

package/dist/configs/core.js

@@ -2,15 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'projectzero/image-import': 'error',
-        'projectzero/client-url': 'error',
-        'projectzero/link-import': 'error',
-        'projectzero/router-import': 'error',
-        "no-restricted-syntax": [
-            "error",
+        '@akinon/projectzero/image-import': 'error',
+        '@akinon/projectzero/client-url': 'error',
+        '@akinon/projectzero/link-import': 'error',
+        '@akinon/projectzero/router-import': 'error',
+        '@akinon/projectzero/skip-trailing-slash-redirect': 'error',
+        'no-restricted-syntax': [
+            'error',
             {
-                "selector": "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
-                "message": "You should use it as 'Settings.commerceUrl'"
+                selector: "MemberExpression[property.name='COMMERCE_URL'][object.property.name='env'][object.object.name='process']",
+                message: "You should use it as 'Settings.commerceUrl'"
             }
         ]
     }

package/dist/rules/index.js

@@ -8,5 +8,12 @@ const client_url_1 = __importDefault(require("./client-url"));
 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 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 };
+const skip_trailing_slash_redirect_1 = __importDefault(require("./skip-trailing-slash-redirect"));
+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
+};
 exports.rules = rules;

package/dist/rules/skip-trailing-slash-redirect.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("@typescript-eslint/types");
+const utils_1 = require("@typescript-eslint/utils");
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            VariableDeclarator(node) {
+                var _a;
+                if (node.id.type !== types_1.AST_NODE_TYPES.Identifier) {
+                    return;
+                }
+                if (node.id.name !== 'nextConfig') {
+                    return;
+                }
+                if (((_a = node.init) === null || _a === void 0 ? void 0 : _a.type) !== types_1.AST_NODE_TYPES.ObjectExpression) {
+                    return;
+                }
+                const skipTrailingSlashRedirectNode = node.init.properties.find((property) => 'key' in property &&
+                    property.key.type === types_1.AST_NODE_TYPES.Identifier &&
+                    property.key.name === 'skipTrailingSlashRedirect');
+                if (!skipTrailingSlashRedirectNode ||
+                    skipTrailingSlashRedirectNode.type !== types_1.AST_NODE_TYPES.Property) {
+                    return;
+                }
+                if (skipTrailingSlashRedirectNode.value.type === types_1.AST_NODE_TYPES.Literal &&
+                    skipTrailingSlashRedirectNode.value.value === true) {
+                    return;
+                }
+                context.report({
+                    node: skipTrailingSlashRedirectNode,
+                    messageId: 'skipTrailingSlashRedirect',
+                    fix: (fixer) => fixer.replaceText(skipTrailingSlashRedirectNode.value, 'true')
+                });
+            }
+        };
+    },
+    meta: {
+        messages: {
+            skipTrailingSlashRedirect: 'The `skipTrailingSlashRedirect` value must be true.'
+        },
+        type: 'problem',
+        fixable: 'code',
+        schema: []
+    },
+    defaultOptions: []
+});

package/package.json

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

package/rules/index.ts

@@ -1,8 +1,15 @@
 import clientUrl from './client-url';
 import imageImport from './image-import';
 import linkImport from './link-import';
-import routerImport from './router-import'
+import routerImport from './router-import';
+import skipTrailingSlashRedirect from './skip-trailing-slash-redirect';
 
-const rules = { 'client-url': clientUrl, 'image-import': imageImport, 'link-import': linkImport, 'router-import': routerImport };
+const rules = {
+  'client-url': clientUrl,
+  'image-import': imageImport,
+  'link-import': linkImport,
+  'router-import': routerImport,
+  'skip-trailing-slash-redirect': skipTrailingSlashRedirect
+};
 
 export { rules };

package/rules/skip-trailing-slash-redirect.ts

@@ -0,0 +1,60 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/types';
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    return {
+      VariableDeclarator(node) {
+        if (node.id.type !== AST_NODE_TYPES.Identifier) {
+          return;
+        }
+
+        if (node.id.name !== 'nextConfig') {
+          return;
+        }
+
+        if (node.init?.type !== AST_NODE_TYPES.ObjectExpression) {
+          return;
+        }
+
+        const skipTrailingSlashRedirectNode = node.init.properties.find(
+          (property) =>
+            'key' in property &&
+            property.key.type === AST_NODE_TYPES.Identifier &&
+            property.key.name === 'skipTrailingSlashRedirect'
+        );
+
+        if (
+          !skipTrailingSlashRedirectNode ||
+          skipTrailingSlashRedirectNode.type !== AST_NODE_TYPES.Property
+        ) {
+          return;
+        }
+
+        if (
+          skipTrailingSlashRedirectNode.value.type === AST_NODE_TYPES.Literal &&
+          skipTrailingSlashRedirectNode.value.value === true
+        ) {
+          return;
+        }
+
+        context.report({
+          node: skipTrailingSlashRedirectNode,
+          messageId: 'skipTrailingSlashRedirect',
+          fix: (fixer) =>
+            fixer.replaceText(skipTrailingSlashRedirectNode.value, 'true')
+        });
+      }
+    };
+  },
+  meta: {
+    messages: {
+      skipTrailingSlashRedirect:
+        'The `skipTrailingSlashRedirect` value must be true.'
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: []
+  },
+  defaultOptions: []
+});