@checkdigit/eslint-plugin 7.4.1 → 7.5.0-PR.75-0252

package/dist-types/agent/no-unused-service-variable.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const ruleId = "no-unused-service-variable";
+declare const rule: ESLintUtils.RuleModule<'unknownError' | 'removeUnusedServiceVariables'>;
+export default rule;

package/dist-types/agent/response-reference.d.ts

@@ -0,0 +1,16 @@
+import type { MemberExpression, ObjectPattern, VariableDeclaration } from 'estree';
+import { type Scope } from 'eslint';
+/**
+ * analyze response related variables and their references
+ * the implementation is for fixture API, but it can be used for fetch API as well since the tree structure is similar
+ * @param variableDeclaration - variable declaration node
+ */
+export declare function analyzeResponseReferences(variableDeclaration: VariableDeclaration | undefined, scopeManager: Scope.ScopeManager): {
+    variable?: Scope.Variable;
+    bodyReferences: MemberExpression[];
+    headersReferences: MemberExpression[];
+    statusReferences: MemberExpression[];
+    destructuringBodyVariable?: Scope.Variable | ObjectPattern;
+    destructuringHeadersVariable?: Scope.Variable | ObjectPattern;
+    destructuringHeadersReferences?: MemberExpression[] | undefined;
+};

package/dist-types/agent/url.d.ts

@@ -0,0 +1,4 @@
+export declare function isServiceApiCallUrl(url: string): boolean;
+export declare function replaceEndpointUrlPrefixWithBasePath(url: string): string;
+export declare function replaceEndpointUrlPrefixWithDomain(url: string): string;
+export declare function addBasePathUrlDomain(url: string): string;

package/dist-types/index.d.ts

@@ -1,3 +1,5 @@
 import type { TSESLint } from '@typescript-eslint/utils';
-declare const pluginToExport: TSESLint.FlatConfig.Plugin;
-export default pluginToExport;
+declare const defaultToExport: Exclude<TSESLint.FlatConfig.Plugin, 'config'> & {
+    configs: Record<string, TSESLint.FlatConfig.Config | TSESLint.FlatConfig.Config[]>;
+};
+export default defaultToExport;

package/dist-types/no-legacy-service-typing.d.ts

@@ -0,0 +1,5 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const ruleId = "no-legacy-service-typing";
+declare const DISALLOWED_SERVICE_TYPINGS: string[] | undefined;
+declare const rule: ESLintUtils.RuleModule<'noLegacyServiceTyping', [typeof DISALLOWED_SERVICE_TYPINGS]>;
+export default rule;

package/package.json

@@ -1,96 +1 @@
-{
-  "name": "@checkdigit/eslint-plugin",
-  "version": "7.4.1",
-  "description": "Check Digit eslint plugins",
-  "keywords": [
-    "eslint",
-    "eslintplugin"
-  ],
-  "homepage": "https://github.com/checkdigit/eslint-plugin#readme",
-  "bugs": {
-    "url": "https://github.com/checkdigit/eslint-plugin/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/checkdigit/eslint-plugin"
-  },
-  "license": "MIT",
-  "author": "Check Digit, LLC",
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist-types/index.d.ts",
-      "import": "./dist-mjs/index.mjs",
-      "default": "./dist-mjs/index.mjs"
-    }
-  },
-  "files": [
-    "src",
-    "dist-types",
-    "dist-mjs",
-    "!src/**/test/**",
-    "!src/**/*.test.ts",
-    "!src/**/*.spec.ts",
-    "!dist-types/**/test/**",
-    "!dist-types/**/*.test.d.ts",
-    "!dist-types/**/*.spec.d.ts",
-    "!dist-mjs/**/test/**",
-    "!dist-mjs/**/*.test.mjs",
-    "!dist-mjs/**/*.spec.mjs",
-    "SECURITY.md"
-  ],
-  "scripts": {
-    "build:dist-mjs": "rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs",
-    "build:dist-types": "rimraf dist-types && npx builder --type=types --outDir=dist-types",
-    "ci:compile": "tsc --noEmit",
-    "ci:coverage": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true",
-    "ci:lint": "npm run lint",
-    "ci:style": "npm run prettier",
-    "ci:test": "NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false",
-    "lint": "eslint --max-warnings 0 .",
-    "lint:fix": "eslint --max-warnings 0 --fix .",
-    "prepare": "",
-    "prepublishOnly": "npm run build:dist-types && npm run build:dist-mjs",
-    "prettier": "prettier --ignore-path .gitignore --list-different .",
-    "prettier:fix": "prettier --ignore-path .gitignore --write .",
-    "test": "npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"
-  },
-  "prettier": "@checkdigit/prettier-config",
-  "jest": {
-    "preset": "@checkdigit/jest-config"
-  },
-  "dependencies": {
-    "@typescript-eslint/type-utils": "^8.15.0",
-    "@typescript-eslint/utils": "^8.15.0",
-    "ts-api-utils": "^1.4.0"
-  },
-  "devDependencies": {
-    "@checkdigit/jest-config": "^6.0.2",
-    "@checkdigit/prettier-config": "^5.5.1",
-    "@checkdigit/typescript-config": "^8.0.0",
-    "@eslint/js": "^9.15.0",
-    "@types/eslint": "^9.6.1",
-    "@types/eslint-config-prettier": "^6.11.3",
-    "@typescript-eslint/parser": "^8.15.0",
-    "@typescript-eslint/rule-tester": "^8.15.0",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.3",
-    "eslint-plugin-eslint-plugin": "^6.3.2",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-no-secrets": "^1.1.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-sonarjs": "1.0.4",
-    "http-status-codes": "^2.3.0",
-    "rimraf": "^6.0.1",
-    "typescript-eslint": "^8.15.0"
-  },
-  "peerDependencies": {
-    "eslint": ">=9 <10"
-  },
-  "engines": {
-    "node": ">=20.17"
-  }
-}
+{"name":"@checkdigit/eslint-plugin","version":"7.5.0-PR.75-0252","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 .","lint:fix":"eslint --max-warnings 0 --fix .","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"dependencies":{"@typescript-eslint/type-utils":"8.15.0","@typescript-eslint/utils":"8.15.0","debug":"^4.3.7","ts-api-utils":"^1.4.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.1","@checkdigit/typescript-config":"^8.0.0","@eslint/js":"^9.15.0","@types/debug":"^4.1.12","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.15.0","@typescript-eslint/rule-tester":"^8.15.0","eslint":"9.15.0","eslint-config-prettier":"^9.1.0","eslint-import-resolver-typescript":"^3.6.3","eslint-plugin-eslint-plugin":"^6.3.2","eslint-plugin-import":"^2.31.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^1.1.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","http-status-codes":"^2.3.0","rimraf":"^6.0.1","typescript-eslint":"^8.15.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=20.17"}}

package/src/agent/add-assert-import.ts

@@ -0,0 +1,74 @@
+// agent/add-url-domain.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { strict as assert } from 'node:assert';
+
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
+
+import getDocumentationUrl from '../get-documentation-url';
+
+export const ruleId = 'add-assert-import';
+
+const ASSERT_IMPORT_STATEMENT = "import { strict as assert } from 'node:assert';";
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule: ESLintUtils.RuleModule<'addAssertImport'> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Add import of assert module of node.',
+    },
+    messages: {
+      addAssertImport: 'Add import of assert module of node.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    let isAssertImported = false;
+    let isAssertUsed = false;
+
+    return {
+      ImportDeclaration: (node) => {
+        if (node.source.value === 'assert' || node.source.value === 'node:assert') {
+          isAssertImported = true;
+        }
+      },
+      CallExpression: (callExpression) => {
+        // detect if assert is used
+        if (
+          (callExpression.callee.type === AST_NODE_TYPES.Identifier && callExpression.callee.name === 'assert') ||
+          (callExpression.callee.type === AST_NODE_TYPES.MemberExpression &&
+            callExpression.callee.object.type === AST_NODE_TYPES.Identifier &&
+            callExpression.callee.object.name === 'assert')
+        ) {
+          isAssertUsed = true;
+        }
+      },
+      'Program:exit': (program) => {
+        // add assert import if necessary
+        if (isAssertUsed && !isAssertImported) {
+          const firstStatement = program.body[0];
+          assert(firstStatement);
+          context.report({
+            node: program,
+            messageId: 'addAssertImport',
+            fix(fixer) {
+              return fixer.insertTextBefore(firstStatement, `${ASSERT_IMPORT_STATEMENT}\n`);
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

package/src/agent/add-base-path-const.ts

@@ -0,0 +1,81 @@
+// agent/add-url-domain.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { strict as assert } from 'node:assert';
+
+import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+
+import getDocumentationUrl from '../get-documentation-url';
+import { getProjectRootFolder, getSwaggerPathByIndexFile, isApiIndexFile, loadPackageJson, loadSwagger } from './file';
+
+export const ruleId = 'add-base-path-const';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule: ESLintUtils.RuleModule<'addBasePathConst'> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Add BASE_PATH const variable.',
+    },
+    messages: {
+      addBasePathConst: 'Add BASE_PATH const variable.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      Program: (program: TSESTree.Program) => {
+        if (!isApiIndexFile(context.filename)) {
+          return;
+        }
+
+        const scope = sourceCode.getScope(program).childScopes[0];
+        assert(scope);
+
+        const foundBasePathConst = scope.variables.find((variable) => variable.name === 'BASE_PATH');
+        if (foundBasePathConst) {
+          return;
+        }
+
+        const swaggerPath = getSwaggerPathByIndexFile(context.filename);
+        const swaggerFileContents = loadSwagger(swaggerPath);
+        const baseUrlLine = swaggerFileContents
+          .split('\n')
+          .find((line) => /^\s*-\s*url:\s*\/.*$/u.test(line) || /^basePath:.*/u.test(line));
+        const baseUrl = baseUrlLine?.split(':')[1]?.trim();
+        assert(baseUrl !== undefined);
+
+        const packageRoot = getProjectRootFolder(context.filename);
+        const packageJson = JSON.parse(loadPackageJson(packageRoot)) as { name: string };
+        const serviceName = packageJson.name.split('/')[1];
+        assert(serviceName !== undefined);
+
+        const domain = `https://${serviceName}.checkdigit${baseUrl}`;
+
+        const lastImportStatement = program.body.findLast((node) => node.type === AST_NODE_TYPES.ImportDeclaration);
+        assert(lastImportStatement);
+
+        context.report({
+          messageId: 'addBasePathConst',
+          node: program,
+          fix(fixer) {
+            return fixer.insertTextAfter(lastImportStatement, `\nexport const BASE_PATH = '${domain}';\n`);
+          },
+        });
+      },
+    };
+  },
+});
+
+export default rule;

package/src/agent/add-base-path-import.ts

@@ -0,0 +1,69 @@
+// agent/add-url-domain.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { strict as assert } from 'node:assert';
+
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
+
+import getDocumentationUrl from '../get-documentation-url';
+import { getApiIndexPathByFilename } from './file';
+
+export const ruleId = 'add-base-path-import';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule: ESLintUtils.RuleModule<'addBasePathImport'> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Add import of BASE_PATH if it is used but not imported.',
+    },
+    messages: {
+      addBasePathImport: 'Add import of BASE_PATH.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      Program: (program) => {
+        const isBasePathUsed = sourceCode.text.includes(`$\{BASE_PATH}`);
+        if (isBasePathUsed) {
+          const topScope = sourceCode.getScope(program).childScopes[0];
+          assert(topScope);
+          if (topScope.variables.some((variable) => variable.name === 'BASE_PATH')) {
+            return;
+          }
+
+          const apiIndexPath = getApiIndexPathByFilename(context.filename);
+          if (apiIndexPath !== undefined) {
+            const lastImportStatement = program.body.findLast(
+              (statement) => statement.type === AST_NODE_TYPES.ImportDeclaration,
+            );
+            assert(lastImportStatement);
+
+            const basePathImportStatement = `\nimport { BASE_PATH } from '${apiIndexPath}';\n`;
+            context.report({
+              node: program,
+              messageId: 'addBasePathImport',
+              fix(fixer) {
+                return fixer.insertTextAfter(lastImportStatement, basePathImportStatement);
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+});
+
+export default rule;

package/src/agent/add-url-domain.ts

@@ -0,0 +1,76 @@
+// agent/add-url-domain.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+
+import getDocumentationUrl from '../get-documentation-url';
+import { addBasePathUrlDomain } from './url';
+
+export const ruleId = 'add-url-domain';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule: ESLintUtils.RuleModule<'addDomain' | 'unknownError'> = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Add HTTP domain to the BASE_PATH like url constant variable.',
+    },
+    messages: {
+      addDomain: 'Add HTTP domain to the BASE_PATH like url constant variable.',
+      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      'VariableDeclarator[id.name=/^([A-Z]+_)*BASE_PATH$/]': (basePathDeclarator: TSESTree.VariableDeclarator) => {
+        try {
+          if (
+            basePathDeclarator.init === null ||
+            (basePathDeclarator.init.type !== AST_NODE_TYPES.Literal &&
+              basePathDeclarator.init.type !== AST_NODE_TYPES.TemplateLiteral)
+          ) {
+            return;
+          }
+
+          const urlText = sourceCode.getText(basePathDeclarator.init);
+          const replacement = addBasePathUrlDomain(urlText);
+
+          if (replacement !== urlText) {
+            context.report({
+              messageId: 'addDomain',
+              node: basePathDeclarator.init,
+              fix(fixer) {
+                return fixer.replaceText(basePathDeclarator.init as TSESTree.Node, replacement);
+              },
+            });
+          }
+        } catch (error) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          context.report({
+            node: basePathDeclarator,
+            messageId: 'unknownError',
+            data: {
+              fileName: context.filename,
+              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;