@checkdigit/eslint-plugin 6.6.0-PR.75-b2d2 → 6.6.0-PR.75-1cd1

package/dist-types/no-fixture.d.ts

@@ -1,4 +1,4 @@
-import type { Rule } from 'eslint';
+import { type Rule } from 'eslint';
 export declare const ruleId = "no-fixture";
 declare const rule: Rule.RuleModule;
 export default rule;

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-b2d2","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 && echo \"module.exports = module.exports.default;\" >> dist-cjs/index.cjs && node 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"},"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.16.1","@typescript-eslint/parser":"^7.16.1","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"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}
+{"name":"@checkdigit/eslint-plugin","version":"6.6.0-PR.75-1cd1","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 && 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"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^5.5.0","@checkdigit/typescript-config":"7.1.3-PR.64-9fc8","@types/eslint":"^8.56.10","@typescript-eslint/eslint-plugin":"^7.16.1","@typescript-eslint/parser":"^7.16.1","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"},"peerDependencies":{"eslint":">=8 <9"},"engines":{"node":">=20.14"}}

package/src/ast/format.ts

@@ -13,7 +13,7 @@ import { strict as assert } from 'node:assert';
 export function getIndentation(node: Node, sourceCode: SourceCode) {
   assert.ok(node.loc);
   const line = sourceCode.lines[node.loc.start.line - 1];
-  assert.ok(line);
+  assert.ok(line !== undefined);
   const indentMatch = line.match(/^\s*/u);
   return indentMatch ? indentMatch[0] : '';
 }

package/src/ast/tree.ts

@@ -18,14 +18,35 @@ export function getParent(node: Node): Node | undefined | null {
   return (node as unknown as NodeParentExtension).parent;
 }
 
-export function getAncestor(node: Node, matcher: string | ((testNode: Node) => boolean), typeToExit?: string) {
+export function getAncestor(
+  node: Node,
+  matcher: string | ((testNode: Node) => boolean),
+  exitMatcher?: string | ((testNode: Node) => boolean),
+): Node | undefined {
   const parent = getParent(node);
-  if (!parent || (typeToExit !== undefined && parent.type === typeToExit)) {
+  if (!parent) {
     return undefined;
   } else if (typeof matcher === 'string' && parent.type === matcher) {
     return parent;
   } else if (typeof matcher === 'function' && matcher(parent)) {
     return parent;
+  } else if (typeof exitMatcher === 'string' && parent.type === exitMatcher) {
+    return undefined;
+  } else if (typeof exitMatcher === 'function' && exitMatcher(parent)) {
+    return undefined;
   }
-  return getAncestor(parent, matcher, typeToExit);
+  return getAncestor(parent, matcher, exitMatcher);
+}
+
+export function getEnclosingStatement(node: Node) {
+  return getAncestor(
+    node,
+    (parentNode) => parentNode.type.endsWith('Statement') || parentNode.type.endsWith('Declaration'),
+  );
+}
+
+export function getEnclosingScopeNode(node: Node) {
+  return getAncestor(node, (parentNode) =>
+    ['FunctionExpression', 'FunctionDeclaration', 'ArrowFunctionExpression'].includes(parentNode.type),
+  );
 }

package/src/index.ts

@@ -8,6 +8,7 @@
 
 import invalidJsonStringify, { ruleId as invalidJsonStringifyRuleId } from './invalid-json-stringify';
 import noFixture, { ruleId as noFixtureRuleId } from './no-fixture';
+import noFixtureHeaders, { ruleId as noFixtureHeadersRuleId } from './no-fixture-headers';
 import noPromiseInstanceMethod, { ruleId as noPromiseInstanceMethodRuleId } from './no-promise-instance-method';
 import filePathComment from './file-path-comment';
 import noCardNumbers from './no-card-numbers';
@@ -33,6 +34,7 @@ export default {
     [invalidJsonStringifyRuleId]: invalidJsonStringify,
     [noPromiseInstanceMethodRuleId]: noPromiseInstanceMethod,
     [noFixtureRuleId]: noFixture,
+    [noFixtureHeadersRuleId]: noFixtureHeaders,
   },
   configs: {
     all: {
@@ -49,6 +51,7 @@ export default {
         [`@checkdigit/${invalidJsonStringifyRuleId}`]: 'error',
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
         [`@checkdigit/${noFixtureRuleId}`]: 'error',
+        [`@checkdigit/${noFixtureHeadersRuleId}`]: 'error',
       },
     },
     recommended: {
@@ -64,7 +67,6 @@ export default {
         '@checkdigit/no-test-import': 'error',
         [`@checkdigit/${invalidJsonStringifyRuleId}`]: 'error',
         [`@checkdigit/${noPromiseInstanceMethodRuleId}`]: 'error',
-        [`@checkdigit/${noFixtureRuleId}`]: 'error',
       },
     },
   },

package/src/no-fixture-headers.ts

@@ -0,0 +1,134 @@
+// no-fixture.ts
+
+/*
+ * Copyright (c) 2021-2024 Check Digit, LLC
+ *
+ * This code is licensed under the MIT license (see LICENSE.txt for details).
+ */
+
+import type { Identifier, MemberExpression, VariableDeclarator } from 'estree';
+import { getEnclosingScopeNode, getParent } from './ast/tree';
+import { type Rule } from 'eslint';
+import { strict as assert } from 'node:assert';
+import getDocumentationUrl from './get-documentation-url';
+
+export const ruleId = 'no-fixture-headers';
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Prefer native fetch API over customized fixture API.',
+      url: getDocumentationUrl(ruleId),
+    },
+    messages: {
+      preferNativeFetch: 'Prefer native fetch API over customized fixture API.',
+      unknownError:
+        'Unknown error occurred in file "{{fileName}}": {{ error }}. Please manually convert the fixture API call to fetch API call.',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+  // eslint-disable-next-line max-lines-per-function
+  create(context) {
+    const sourceCode = context.sourceCode;
+    const scopeManager = sourceCode.scopeManager;
+
+    return {
+      // eslint-disable-next-line max-lines-per-function
+      'VariableDeclarator[init.argument.callee.name="fetch"]': (fetchCall: VariableDeclarator) => {
+        try {
+          const enclosingScopeNode = getEnclosingScopeNode(fetchCall);
+          assert.ok(fetchCall.id.type === 'Identifier');
+          const fetchVariableName = fetchCall.id.name; /*?*/
+          assert.ok(enclosingScopeNode !== undefined, 'enclosing scope node should exist');
+          const scope = scopeManager.acquire(enclosingScopeNode);
+          const responseVariable = scope?.variables.find((variable) => {
+            const identifier = variable.identifiers[0];
+            return identifier?.type === 'Identifier' && identifier.name === fetchVariableName;
+          });
+          if (responseVariable === undefined) {
+            return;
+          }
+
+          const headersReferences = responseVariable.references
+            .map((reference) => getParent(reference.identifier))
+            .filter(
+              (parent): parent is MemberExpression =>
+                parent?.type === 'MemberExpression' &&
+                parent.property.type === 'Identifier' &&
+                parent.property.name === 'headers',
+            );
+          const directHeadersReferences = headersReferences
+            .map(getParent)
+            .filter(
+              (parent): parent is MemberExpression =>
+                parent?.type === 'MemberExpression' &&
+                !(parent.property.type === 'Identifier' && parent.property.name === 'get'),
+            );
+          directHeadersReferences.map((reference) => sourceCode.getText(reference)); /*?*/
+
+          const reDeclaredHeadersVariableNames = headersReferences
+            .map((reference) => getParent(reference))
+            .filter((parent): parent is VariableDeclarator => parent?.type === 'VariableDeclarator')
+            .map((declarator) => (declarator.id as Identifier).name);
+
+          const indirectHeadersReferences = reDeclaredHeadersVariableNames
+            .map((variableName) => {
+              const headersVariable = scope?.variables.find((variable) => {
+                const identifier = variable.identifiers[0];
+                return identifier?.type === 'Identifier' && identifier.name === variableName;
+              });
+              return (
+                headersVariable?.references
+                  .map((reference) => getParent(reference.identifier))
+                  .filter(
+                    (parent): parent is MemberExpression =>
+                      parent?.type === 'MemberExpression' &&
+                      !(parent.property.type === 'Identifier' && parent.property.name === 'get'),
+                  ) ?? []
+              );
+            })
+            .flat();
+          indirectHeadersReferences.map((reference) => sourceCode.getText(reference)); /*?*/
+
+          const invalidHeadersReferences = [...directHeadersReferences, ...indirectHeadersReferences].map<
+            [MemberExpression, string]
+          >((reference) => {
+            sourceCode.getText(reference); /*?*/
+            const headerNameNode = reference.property; /*?*/
+            const headerName =
+              // eslint-disable-next-line no-nested-ternary, @typescript-eslint/restrict-template-expressions
+              reference.computed ? sourceCode.getText(headerNameNode) : `'${sourceCode.getText(headerNameNode)}'`; /*?*/
+            const replacementText = `${sourceCode.getText(reference.object)}.get(${headerName})`;
+            return [reference, replacementText];
+          });
+
+          context.report({
+            node: fetchCall,
+            messageId: 'preferNativeFetch',
+            *fix(fixer) {
+              // handle response headers references
+              for (const [node, replacementText] of invalidHeadersReferences) {
+                yield fixer.replaceText(node, replacementText);
+              }
+            },
+          });
+        } catch (error) {
+          // eslint-disable-next-line no-console
+          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          context.report({
+            node: fetchCall,
+            messageId: 'unknownError',
+            data: {
+              fileName: context.filename,
+              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+            },
+          });
+        }
+      },
+    };
+  },
+};
+
+export default rule;