@checkdigit/eslint-plugin 6.6.0-PR.75-edd9 → 6.6.0-PR.75-b19c

package/dist-types/require-type-out-of-type-only-imports.d.ts

@@ -0,0 +1,4 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const ruleId = "require-type-out-of-type-only-imports";
+declare const rule: ESLintUtils.RuleModule<"moveTypeOutside", never[], ESLintUtils.RuleListener>;
+export default rule;

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-edd9","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","require":"./dist-cjs/index.cjs","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-cjs","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-cjs/**/*.test.cjs","!dist-cjs/**/*.spec.cjs","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-cjs":"rimraf dist-cjs && npx builder --type=commonjs --sourceMap --entryPoint=index.ts --outDir=dist-cjs --outFile=index.cjs --external=espree && echo \"module.exports = module.exports.default;\" >> dist-cjs/index.cjs","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 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prepublishOnly":"npm run build:dist-types && npm run build:dist-cjs && 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":"7.18.0","@typescript-eslint/utils":"7.18.0","ts-api-utils":"^1.3.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.0","@checkdigit/typescript-config":"6.0.0","@types/eslint":"8.56.10","@typescript-eslint/eslint-plugin":"7.18.0","@typescript-eslint/parser":"7.18.0","@typescript-eslint/rule-tester":"7.18.0","eslint-config-prettier":"^9.1.0","eslint-plugin-eslint-plugin":"^6.2.0","eslint-plugin-import":"^2.29.1","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-no-secrets":"^1.0.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"0.24.0","http-status-codes":"^2.3.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}
+{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-b19c","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","require":"./dist-cjs/index.cjs","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-cjs","dist-mjs","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-cjs/**/*.test.cjs","!dist-cjs/**/*.spec.cjs","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-cjs":"rimraf dist-cjs && npx builder --type=commonjs --sourceMap --entryPoint=index.ts --outDir=dist-cjs --outFile=index.cjs --external=espree && echo \"module.exports = module.exports.default;\" >> dist-cjs/index.cjs","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 --ignore-path .gitignore .","lint:fix":"eslint --ignore-path .gitignore . --fix","prepublishOnly":"npm run build:dist-types && npm run build:dist-cjs && 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":"7.18.0","@typescript-eslint/utils":"7.18.0","ts-api-utils":"^1.3.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.0","@checkdigit/typescript-config":"6.0.0","@types/eslint":"8.56.10","@typescript-eslint/eslint-plugin":"7.18.0","@typescript-eslint/parser":"7.18.0","@typescript-eslint/rule-tester":"7.18.0","eslint-config-prettier":"^9.1.0","eslint-plugin-eslint-plugin":"^6.2.0","eslint-plugin-import":"^2.29.1","eslint-plugin-no-only-tests":"^3.1.0","eslint-plugin-no-secrets":"^1.0.2","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"0.24.0","http-status-codes":"^2.3.0"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}

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

@@ -1,4 +1,4 @@
-// fixture/add-url-domain.ts
+// agent/add-url-domain.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/fetch-response-body-json.ts

@@ -1,4 +1,4 @@
-// fixture/fetch-response-body-json.ts
+// agent/fetch-response-body-json.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/fetch-response-header-getter.ts

@@ -1,4 +1,4 @@
-// fixture/fetch-response-header-getter-ts.ts
+// agent/fetch-response-header-getter-ts.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/fetch-then.ts

@@ -1,4 +1,4 @@
-// fixture/fetch-then.ts
+// agent/fetch-then.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/fetch.ts

@@ -1,4 +1,4 @@
-// fixture/fetch.ts
+// agent/fetch.ts
 
 import { getParent, isBlockStatement } from '../library/tree';
 import type { Node } from 'estree';

package/src/agent/no-fixture.ts

@@ -1,4 +1,4 @@
-// fixture/no-fixture.ts
+// agent/no-fixture.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/no-full-response.ts

@@ -1,4 +1,4 @@
-// fixture/no-full-response.ts
+// agent/no-full-response.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/no-mapped-response.ts

@@ -1,4 +1,4 @@
-// fixture/no-mapped-response-type.ts
+// agent/no-mapped-response-type.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/no-service-wrapper.ts

@@ -1,4 +1,4 @@
-// fixture/no-service-wrapper.ts
+// agent/no-service-wrapper.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/no-status-code.ts

@@ -1,4 +1,4 @@
-// fixture/no-status-code.ts
+// agent/no-status-code.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/response-reference.ts

@@ -1,4 +1,4 @@
-// fixture/response-reference.ts
+// agent/response-reference.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/agent/url.ts

@@ -1,4 +1,4 @@
-// fixture/url.ts
+// agent/url.ts
 
 export const PLAIN_URL_REGEXP = /^[`']\/\w+(?<serviceNamePart>-\w+)*\/v\d+\/(?<any>.|\r|\n)+[`']$/u;
 export const TOKENIZED_URL_REGEXP = /^`\$\{(?<serviceNamePart>[A-Z]+_)*BASE_PATH\}\/(?<any>.|\r|\n)+`$/u;

package/src/index.ts

@@ -13,15 +13,22 @@ import fetchResponseHeaderGetter, {
 } from './agent/fetch-response-header-getter';
 import fetchThen, { ruleId as fetchThenRuleId } from './agent/fetch-then';
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
+import noDuplicatedImports, { ruleId as noDuplicatedImportsRuleId } from './no-duplicated-imports';
 import noFixture, { ruleId as noFixtureRuleId } from './agent/no-fixture';
 import noFullResponse, { ruleId as noFullResponseRuleId } from './agent/no-full-response';
 import noMappedResponse, { ruleId as noMappedResponseRuleId } from './agent/no-mapped-response';
 import noPromiseInstanceMethod, { ruleId as noPromiseInstanceMethodRuleId } from './no-promise-instance-method';
 import noServiceWrapper, { ruleId as noServiceWrapperRuleId } from './agent/no-service-wrapper';
 import noStatusCode, { ruleId as noStatusCodeRuleId } from './agent/no-status-code';
+import requireFixedServicesImport, {
+  ruleId as requireFixedServicesImportRuleId,
+} from './require-fixed-services-import';
 import requireResolveFullResponse, {
   ruleId as requireResolveFullResponseRuleId,
 } from './require-resolve-full-response';
+import requireTypeOutOfTypeOnlyImports, {
+  ruleId as requireTypeOutOfTypeOnlyImportsRuleId,
+} from './require-type-out-of-type-only-imports';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
 import noTestImport from './no-test-import';
@@ -55,6 +62,9 @@ export default {
     [noFullResponseRuleId]: noFullResponse,
     [noMappedResponseRuleId]: noMappedResponse,
     [requireResolveFullResponseRuleId]: requireResolveFullResponse,
+    [noDuplicatedImportsRuleId]: noDuplicatedImports,
+    [requireFixedServicesImportRuleId]: requireFixedServicesImport,
+    [requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
   },
   configs: {
     all: {
@@ -72,13 +82,9 @@ export default {
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
         [`@checkdigit/${noFullResponseRuleId}`]: 'error',
         [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
-        [`@checkdigit/${addUrlDomainRuleId}`]: 'off',
-        [`@checkdigit/${noFixtureRuleId}`]: 'off',
-        [`@checkdigit/${noServiceWrapperRuleId}`]: 'off',
-        [`@checkdigit/${noStatusCodeRuleId}`]: 'off',
-        [`@checkdigit/${fetchResponseBodyJsonRuleId}`]: 'off',
-        [`@checkdigit/${fetchResponseHeaderGetterRuleId}`]: 'off',
-        [`@checkdigit/${fetchThenRuleId}`]: 'off',
+        [`@checkdigit/${noDuplicatedImportsRuleId}`]: 'error',
+        [`@checkdigit/${requireFixedServicesImportRuleId}`]: 'error',
+        [`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: 'error',
       },
     },
     recommended: {
@@ -103,8 +109,6 @@ export default {
         },
       ],
       rules: {
-        [`@checkdigit/${noFullResponseRuleId}`]: 'error',
-        [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
         [`@checkdigit/${noMappedResponseRuleId}`]: 'error',
         [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
         [`@checkdigit/${noFixtureRuleId}`]: 'error',
@@ -118,8 +122,6 @@ export default {
     'agent-phase-2-production': {
       ignorePatterns: ['*.spec.ts', '*.test.ts'],
       rules: {
-        [`@checkdigit/${noFullResponseRuleId}`]: 'error',
-        [`@checkdigit/${requireResolveFullResponseRuleId}`]: 'error',
         [`@checkdigit/${noMappedResponseRuleId}`]: 'error',
         [`@checkdigit/${addUrlDomainRuleId}`]: 'error',
         [`@checkdigit/${noFixtureRuleId}`]: 'off',

package/src/library/format.ts

@@ -1,4 +1,4 @@
-// format.ts
+// library/format.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/library/tree.ts

@@ -1,4 +1,4 @@
-// tree.ts
+// library/tree.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/library/ts-tree.ts

@@ -1,4 +1,4 @@
-// tree.ts
+// library/ts-tree.ts
 
 /*
  * Copyright (c) 2021-2024 Check Digit, LLC

package/src/library/variable.ts

@@ -1,4 +1,4 @@
-// fixture/variable.ts
+// library/variable.ts
 
 export function isValidPropertyName(name: unknown) {
   return typeof name === 'string' && /^[a-zA-Z_$][a-zA-Z_$0-9]*$/u.test(name);

package/src/no-duplicated-imports.ts

@@ -0,0 +1,116 @@
+// no-duplicated-imports.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import { strict as assert } from 'node:assert';
+import getDocumentationUrl from './get-documentation-url';
+
+export const ruleId = 'no-duplicated-imports';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Merge duplicated import statements with the same "from".',
+    },
+    messages: {
+      mergeDuplicatedImports: 'Merge duplicated import statements with the same "from".',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+    const importDeclarations = new Map<string, TSESTree.ImportDeclaration[]>();
+
+    return {
+      ImportDeclaration(node) {
+        const moduleName = node.source.value;
+        let declarations = importDeclarations.get(moduleName);
+        if (declarations === undefined) {
+          declarations = [];
+          importDeclarations.set(moduleName, declarations);
+        }
+        declarations.push(node);
+      },
+      'Program:exit'() {
+        for (const [moduleName, declarations] of importDeclarations.entries()) {
+          if (declarations.length <= 1) {
+            continue;
+          }
+
+          const firstDeclaration = declarations[0];
+          assert.ok(firstDeclaration);
+
+          const isAllTypeOnly = declarations.every(
+            (declaration) =>
+              declaration.importKind === 'type' ||
+              declaration.specifiers.every(
+                (specifier) =>
+                  specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type',
+              ),
+          );
+
+          context.report({
+            messageId: 'mergeDuplicatedImports',
+            node: firstDeclaration,
+            fix(fixer) {
+              const fixes = [];
+
+              const defaultSpecifier = declarations
+                .flatMap((declaration) =>
+                  declaration.specifiers.map((specifier) =>
+                    specifier.type === TSESTree.AST_NODE_TYPES.ImportDefaultSpecifier ? specifier : undefined,
+                  ),
+                )
+                .filter(Boolean);
+              const defaultSpecifierText = defaultSpecifier[0] ? sourceCode.getText(defaultSpecifier[0]) : undefined;
+
+              const mergedSpecifiers = declarations.flatMap((declaration) => {
+                const isCurrentDeclarationTypeOnly =
+                  declaration.importKind === 'type' ||
+                  declaration.specifiers.every(
+                    (specifier) =>
+                      specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type',
+                  );
+                return declaration.specifiers
+                  .filter((specifier) => specifier.type !== TSESTree.AST_NODE_TYPES.ImportDefaultSpecifier)
+                  .map((specifier) =>
+                    // eslint-disable-next-line no-nested-ternary
+                    isAllTypeOnly
+                      ? sourceCode.getText(specifier).replace('type ', '')
+                      : isCurrentDeclarationTypeOnly
+                        ? `type ${sourceCode.getText(specifier)}`
+                        : sourceCode.getText(specifier),
+                  );
+              });
+              const mergedSpecifiersText = `${isAllTypeOnly ? 'type ' : ''}{ ${mergedSpecifiers.join(', ')} }`;
+
+              // Replace the first import with the merged import
+              const mergedImport = `import ${[defaultSpecifierText, mergedSpecifiersText].filter(Boolean).join(', ')} from '${moduleName}';`;
+              fixes.push(fixer.replaceText(firstDeclaration, mergedImport));
+
+              // Remove the remaining imports
+              declarations.slice(1).forEach((declaration) => {
+                fixes.push(fixer.removeRange([declaration.range[0], declaration.range[1] + 1]));
+              });
+
+              return fixes;
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

package/src/require-fixed-services-import.ts

@@ -0,0 +1,52 @@
+// require-fixed-services-import.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { ESLintUtils } from '@typescript-eslint/utils';
+import getDocumentationUrl from './get-documentation-url';
+
+export const ruleId = 'require-fixed-services-import';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+const SERVICE_TYPINGS_IMPORT_PATH_PREFIX = /(?<path>\.\.\/)+services\/.*/u;
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Require fixed "from" with service typing imports from "src/services".',
+    },
+    messages: {
+      updateServicesImportFrom: 'Update service typing imports to be from the fixed "src/services" path.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        const moduleName = node.source.value;
+        if (SERVICE_TYPINGS_IMPORT_PATH_PREFIX.test(moduleName)) {
+          context.report({
+            messageId: 'updateServicesImportFrom',
+            node: node.source,
+            *fix(fixer) {
+              yield fixer.replaceText(
+                node.source,
+                `'${moduleName.slice(0, moduleName.indexOf('../services') + '../services'.length)}'`,
+              );
+            },
+          });
+        }
+      },
+    };
+  },
+});
+
+export default rule;

package/src/require-type-out-of-type-only-imports.ts

@@ -0,0 +1,63 @@
+// require-type-out-of-type-only-imports.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import getDocumentationUrl from './get-documentation-url';
+
+export const ruleId = 'require-type-out-of-type-only-imports';
+
+const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
+
+const rule = createRule({
+  name: ruleId,
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Require "type" to be out side of type-only imports.',
+    },
+    messages: {
+      moveTypeOutside: 'Update the type-only imports to use "tpe" outside of the curly braces.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  defaultOptions: [],
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    return {
+      ImportDeclaration(declaration) {
+        if (
+          declaration.importKind === 'type' ||
+          !declaration.specifiers.every(
+            (specifier) =>
+              specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type',
+          )
+        ) {
+          return;
+        }
+
+        context.report({
+          messageId: 'moveTypeOutside',
+          node: declaration,
+          *fix(fixer) {
+            const moduleName = declaration.source.value;
+            const mergedSpecifiers = declaration.specifiers
+              .filter((specifier) => specifier.type !== TSESTree.AST_NODE_TYPES.ImportDefaultSpecifier)
+              .map((specifier) => sourceCode.getText(specifier).replace('type ', ''));
+            const updatedImportDeclaration = `import type { ${mergedSpecifiers.join(', ')} } from '${moduleName}';`;
+
+            yield fixer.replaceText(declaration, updatedImportDeclaration);
+          },
+        });
+      },
+    };
+  },
+});
+
+export default rule;