@adonisjs/eslint-plugin 1.1.8 → 1.2.0

package/dist/src/index.js

@@ -1,6 +1,9 @@
 "use strict";
-const prefer_lazy_controller_import_1 = require("./rules/prefer_lazy_controller_import");
-const prefer_lazy_listener_import_1 = require("./rules/prefer_lazy_listener_import");
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const prefer_lazy_controller_import_1 = __importDefault(require("./rules/prefer_lazy_controller_import"));
+const prefer_lazy_listener_import_1 = __importDefault(require("./rules/prefer_lazy_listener_import"));
 module.exports = {
     rules: {
         'prefer-lazy-controller-import': prefer_lazy_controller_import_1.default,

package/dist/src/rules/prefer_lazy_controller_import.js

@@ -29,6 +29,13 @@ exports.default = (0, utils_2.createEslintRule)({
                 node.callee.property.type === utils_1.AST_NODE_TYPES.Identifier &&
                 httpMethods.includes(node.callee.property.name));
         }
+        function isRouteResourceCallExpression(node, identifier) {
+            return (node.callee.type === utils_1.AST_NODE_TYPES.MemberExpression &&
+                node.callee.object.type === utils_1.AST_NODE_TYPES.Identifier &&
+                node.callee.object.name === identifier &&
+                node.callee.property.type === utils_1.AST_NODE_TYPES.Identifier &&
+                node.callee.property.name === 'resource');
+        }
         return {
             /**
              * Track all imported identifiers
@@ -50,35 +57,54 @@ exports.default = (0, utils_2.createEslintRule)({
             CallExpression(node) {
                 /**
                  * Check if we are calling router.get() or any other http method
+                 * OR if we are calling router.resource that also takes a controller
+                 * as an argument
                  */
-                if (!isRouteCallExpression(node, routerIdentifier)) {
+                const isRouteCallExpr = isRouteCallExpression(node, routerIdentifier);
+                const isRouteResourceExpr = isRouteResourceCallExpression(node, routerIdentifier);
+                if (!isRouteCallExpr && !isRouteResourceExpr) {
                     return;
                 }
                 /**
-                 * Ensure the second argument is an array
+                 * Now let's extract the controller identifier from the call expression
+                 *
+                 * In the case of router.get/post/put.. we have to extract
+                 * the first element from the array
+                 *
+                 * router.get("/", [HomeController, 'index'])
                  */
-                const secondArgument = node.arguments[1];
-                if (secondArgument.type !== utils_1.AST_NODE_TYPES.ArrayExpression) {
-                    return;
+                let controller;
+                if (isRouteCallExpr) {
+                    const secondArgument = node.arguments[1];
+                    if (secondArgument.type !== utils_1.AST_NODE_TYPES.ArrayExpression)
+                        return;
+                    controller = secondArgument.elements[0];
                 }
-                for (const element of secondArgument.elements) {
-                    /**
-                     * If we are dealing with an Identifier that was imported
-                     * through a standard import, then report it as an error
-                     */
-                    if (element.type !== 'Identifier' || !importIdentifiers.includes(element.name)) {
-                        continue;
-                    }
-                    context.report({
-                        node: importNodes[element.name],
-                        messageId: 'preferLazyControllerImport',
-                        fix(fixer) {
-                            const importPath = importNodes[element.name].source.raw;
-                            const newImportDeclaration = `const ${element.name} = () => import(${importPath})`;
-                            return fixer.replaceText(importNodes[element.name], newImportDeclaration);
-                        },
-                    });
+                /**
+                 * In the case of router.resource, we just have to extract the first argument
+                 *
+                 * router.resource("foo", UserController)
+                 */
+                if (isRouteResourceExpr) {
+                    controller = node.arguments[1];
+                }
+                /**
+                 * If we are dealing with an Identifier that was imported
+                 * through a standard import, then report it as an error
+                 */
+                const element = controller;
+                if (element.type !== 'Identifier' || !importIdentifiers.includes(element.name)) {
+                    return;
                 }
+                context.report({
+                    node: importNodes[element.name],
+                    messageId: 'preferLazyControllerImport',
+                    fix(fixer) {
+                        const importPath = importNodes[element.name].source.raw;
+                        const newImportDeclaration = `const ${element.name} = () => import(${importPath})`;
+                        return fixer.replaceText(importNodes[element.name], newImportDeclaration);
+                    },
+                });
             },
         };
     },

package/dist/tests/prefer_lazy_controller_import.spec.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const runner_1 = require("@japa/runner");
 const ts_eslint_1 = require("@typescript-eslint/utils/ts-eslint");
-const prefer_lazy_controller_import_1 = require("../src/rules/prefer_lazy_controller_import");
+const prefer_lazy_controller_import_1 = __importDefault(require("../src/rules/prefer_lazy_controller_import"));
 const valids = [
     `
   import router from "@adonisjs/core/services/router"
@@ -40,6 +43,23 @@ const invalids = [
     })
     `,
     ],
+    /**
+     * When used with route.resource
+     */
+    [
+        `
+    import router from "@adonisjs/core/services/router"
+    import ProjectThreadsController from "./controller"
+
+    router.resource("project/:id/threads", ProjectThreadsController)
+    `,
+        `
+    import router from "@adonisjs/core/services/router"
+    const ProjectThreadsController = () => import("./controller")
+
+    router.resource("project/:id/threads", ProjectThreadsController)
+    `,
+    ],
 ];
 (0, runner_1.test)('Prefer lazy controller import', ({ assert }) => {
     const ruleTester = new ts_eslint_1.RuleTester({

package/dist/tests/prefer_lazy_listener_import.spec.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const runner_1 = require("@japa/runner");
 const ts_eslint_1 = require("@typescript-eslint/utils/ts-eslint");
-const prefer_lazy_listener_import_1 = require("../src/rules/prefer_lazy_listener_import");
+const prefer_lazy_listener_import_1 = __importDefault(require("../src/rules/prefer_lazy_listener_import"));
 const valids = [
     `
   import emitter from '@adonisjs/core/services/emitter'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/eslint-plugin",
   "description": "ESLint plugin to enforce AdonisJS app specific linting rules",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "main": "dist/src/index.js",
   "files": [
     "dist"
@@ -13,13 +13,13 @@
     "@japa/assert": "^1.4.1",
     "@japa/runner": "^2.5.1",
     "@japa/spec-reporter": "^1.3.3",
-    "@types/node": "^20.4.1",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@types/node": "^20.9.4",
+    "@typescript-eslint/parser": "^6.12.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "5.2.2"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^6.0.0"
+    "@typescript-eslint/utils": "^6.12.0"
   },
   "author": "Julien Ripouteau <julien@ripouteau.com>",
   "license": "MIT",