eslint-plugin-modularity 2.0.0

package/src/rules/no-external-api-calls-in-utils.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2025 Ofri Peretz
+ * Licensed under the MIT License. Use of this source code is governed by the
+ * MIT license that can be found in the LICENSE file.
+ */
+/**
+ * ESLint Rule: no-external-api-calls-in-utils
+ * Detects network calls in utility functions
+ *
+ * @see https://rules.sonarsource.com/javascript/RSPEC-1075/
+ */
+import type { TSESLint } from '@interlace/eslint-devkit';
+type MessageIds = 'externalApiCallInUtils' | 'useDependencyInjection' | 'extractToService' | 'passApiClient';
+export interface Options {
+    ignoreInTests?: boolean;
+    networkMethods?: string[];
+    utilityPatterns?: string[];
+}
+type RuleOptions = [Options?];
+export declare const noExternalApiCallsInUtils: TSESLint.RuleModule<MessageIds, RuleOptions, unknown, TSESLint.RuleListener> & {
+    name: string;
+};
+export {};

package/src/rules/no-external-api-calls-in-utils.js

@@ -0,0 +1,151 @@
+"use strict";
+/**
+ * Copyright (c) 2025 Ofri Peretz
+ * Licensed under the MIT License. Use of this source code is governed by the
+ * MIT license that can be found in the LICENSE file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noExternalApiCallsInUtils = void 0;
+const eslint_devkit_1 = require("@interlace/eslint-devkit");
+const eslint_devkit_2 = require("@interlace/eslint-devkit");
+/**
+ * Check if file is a utility file
+ */
+function isUtilityFile(filename, patterns) {
+    return patterns.some(pattern => {
+        const regex = new RegExp(pattern.replace(/\*\*/g, '.*').replace(/\*/g, '[^/]*'));
+        return regex.test(filename);
+    });
+}
+/**
+ * Check if call is a network call
+ */
+function isNetworkCall(node, networkMethods) {
+    if (node.callee.type === 'Identifier') {
+        return networkMethods.includes(node.callee.name);
+    }
+    if (node.callee.type === 'MemberExpression' &&
+        node.callee.property.type === 'Identifier') {
+        const methodName = node.callee.property.name;
+        const objectName = node.callee.object.type === 'Identifier'
+            ? node.callee.object.name
+            : '';
+        return networkMethods.includes(methodName) ||
+            networkMethods.includes(`${objectName}.${methodName}`);
+    }
+    return false;
+}
+exports.noExternalApiCallsInUtils = (0, eslint_devkit_2.createRule)({
+    name: 'no-external-api-calls-in-utils',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Detects network calls in utility functions',
+        },
+        hasSuggestions: true,
+        messages: {
+            externalApiCallInUtils: (0, eslint_devkit_1.formatLLMMessage)({
+                icon: eslint_devkit_1.MessageIcons.ARCHITECTURE,
+                issueName: 'External API call in utils',
+                description: 'Network call in utility function - breaks testability',
+                severity: 'HIGH',
+                fix: 'Use dependency injection for network calls',
+                documentationLink: 'https://rules.sonarsource.com/javascript/RSPEC-1075/',
+            }),
+            useDependencyInjection: (0, eslint_devkit_1.formatLLMMessage)({
+                icon: eslint_devkit_1.MessageIcons.INFO,
+                issueName: 'Use Dependency Injection',
+                description: 'Inject API client',
+                severity: 'LOW',
+                fix: 'function util(apiClient) { return apiClient.get(...) }',
+                documentationLink: 'https://en.wikipedia.org/wiki/Dependency_injection',
+            }),
+            extractToService: (0, eslint_devkit_1.formatLLMMessage)({
+                icon: eslint_devkit_1.MessageIcons.INFO,
+                issueName: 'Extract to Service',
+                description: 'Extract to service layer',
+                severity: 'LOW',
+                fix: 'Create services/apiService.ts',
+                documentationLink: 'https://martinfowler.com/eaaCatalog/serviceLayer.html',
+            }),
+            passApiClient: (0, eslint_devkit_1.formatLLMMessage)({
+                icon: eslint_devkit_1.MessageIcons.INFO,
+                issueName: 'Pass API Client',
+                description: 'Pass API client as parameter',
+                severity: 'LOW',
+                fix: 'function util(apiClient, data) { ... }',
+                documentationLink: 'https://en.wikipedia.org/wiki/Dependency_injection',
+            }),
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    ignoreInTests: {
+                        type: 'boolean',
+                        default: true,
+                    },
+                    networkMethods: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        default: ['fetch', 'axios', 'request', 'http.get', 'https.get', 'get', 'post', 'put', 'delete', 'patch'],
+                    },
+                    utilityPatterns: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        default: ['**/utils/**', '**/helpers/**', '**/lib/**'],
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    defaultOptions: [
+        {
+            ignoreInTests: true,
+            networkMethods: ['fetch', 'axios', 'request', 'http.get', 'https.get', 'get', 'post', 'put', 'delete', 'patch'],
+            utilityPatterns: ['**/utils/**', '**/helpers/**', '**/lib/**'],
+        },
+    ],
+    create(context, [options = {}]) {
+        const { ignoreInTests = true, networkMethods = ['fetch', 'axios', 'request', 'http.get', 'https.get', 'get', 'post', 'put', 'delete', 'patch'], utilityPatterns = ['**/utils/**', '**/helpers/**', '**/lib/**'], } = options || {};
+        const filename = context.getFilename();
+        const isTestFile = ignoreInTests && /\.(test|spec)\.(ts|tsx|js|jsx)$/.test(filename);
+        if (isTestFile) {
+            return {};
+        }
+        const isUtility = isUtilityFile(filename, utilityPatterns);
+        if (!isUtility) {
+            return {};
+        }
+        /**
+         * Check for network calls
+         */
+        function checkCallExpression(node) {
+            if (isNetworkCall(node, networkMethods)) {
+                context.report({
+                    node,
+                    messageId: 'externalApiCallInUtils',
+                    suggest: [
+                        {
+                            messageId: 'useDependencyInjection',
+                            fix: () => null,
+                        },
+                        {
+                            messageId: 'extractToService',
+                            fix: () => null,
+                        },
+                        {
+                            messageId: 'passApiClient',
+                            fix: () => null,
+                        },
+                    ],
+                });
+            }
+        }
+        return {
+            CallExpression: checkCallExpression,
+        };
+    },
+});
+//# sourceMappingURL=no-external-api-calls-in-utils.js.map

package/src/rules/no-external-api-calls-in-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-external-api-calls-in-utils.js","sourceRoot":"","sources":["../../../../../packages/eslint-plugin-modularity/src/rules/no-external-api-calls-in-utils.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AASH,4DAA0E;AAC1E,4DAAsD;AAgBtD;;GAEG;AACH,SAAS,aAAa,CAAC,QAAgB,EAAE,QAAkB;IACzD,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC7B,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QACjF,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,IAA6B,EAAE,cAAwB;IAC5E,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACtC,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB;QACvC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;YACzD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;YACzB,CAAC,CAAC,EAAE,CAAC;QAEP,OAAO,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC;YACnC,cAAc,CAAC,QAAQ,CAAC,GAAG,UAAU,IAAI,UAAU,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAEY,QAAA,yBAAyB,GAAG,IAAA,0BAAU,EAA0B;IAC3E,IAAI,EAAE,gCAAgC;IACtC,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,4CAA4C;SAC1D;QACD,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE;YACR,sBAAsB,EAAE,IAAA,gCAAgB,EAAC;gBACvC,IAAI,EAAE,4BAAY,CAAC,YAAY;gBAC/B,SAAS,EAAE,4BAA4B;gBACvC,WAAW,EAAE,uDAAuD;gBACpE,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,4CAA4C;gBACjD,iBAAiB,EAAE,sDAAsD;aAC1E,CAAC;YACF,sBAAsB,EAAE,IAAA,gCAAgB,EAAC;gBACvC,IAAI,EAAE,4BAAY,CAAC,IAAI;gBACvB,SAAS,EAAE,0BAA0B;gBACrC,WAAW,EAAE,mBAAmB;gBAChC,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,wDAAwD;gBAC7D,iBAAiB,EAAE,oDAAoD;aACxE,CAAC;YACF,gBAAgB,EAAE,IAAA,gCAAgB,EAAC;gBACjC,IAAI,EAAE,4BAAY,CAAC,IAAI;gBACvB,SAAS,EAAE,oBAAoB;gBAC/B,WAAW,EAAE,0BAA0B;gBACvC,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,+BAA+B;gBACpC,iBAAiB,EAAE,uDAAuD;aAC3E,CAAC;YACF,aAAa,EAAE,IAAA,gCAAgB,EAAC;gBAC9B,IAAI,EAAE,4BAAY,CAAC,IAAI;gBACvB,SAAS,EAAE,iBAAiB;gBAC5B,WAAW,EAAE,8BAA8B;gBAC3C,QAAQ,EAAE,KAAK;gBACf,GAAG,EAAE,wCAAwC;gBAC7C,iBAAiB,EAAE,oDAAoD;aACxE,CAAC;SACH;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,aAAa,EAAE;wBACb,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,IAAI;qBACd;oBACD,cAAc,EAAE;wBACd,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC;qBACzG;oBACD,eAAe,EAAE;wBACf,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,OAAO,EAAE,CAAC,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC;qBACvD;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE;QACd;YACE,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC;YAC/G,eAAe,EAAE,CAAC,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC;SAC/D;KACF;IACD,MAAM,CAAC,OAAsD,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC;QAC3E,MAAM,EACJ,aAAa,GAAG,IAAI,EACpB,cAAc,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAChH,eAAe,GAAG,CAAC,aAAa,EAAE,eAAe,EAAE,WAAW,CAAC,GAChE,GAAY,OAAO,IAAI,EAAE,CAAC;QAE3B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,aAAa,IAAI,iCAAiC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAErF,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QAE3D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED;;WAEG;QACH,SAAS,mBAAmB,CAAC,IAA6B;YACxD,IAAI,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;gBACxC,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAE,wBAAwB;oBACnC,OAAO,EAAE;wBACP;4BACE,SAAS,EAAE,wBAAwB;4BACnC,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;yBAChB;wBACD;4BACE,SAAS,EAAE,kBAAkB;4BAC7B,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;yBAChB;wBACD;4BACE,SAAS,EAAE,eAAe;4BAC1B,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;yBAChB;qBACF;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO;YACL,cAAc,EAAE,mBAAmB;SACpC,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}