@checkdigit/eslint-plugin 7.6.0-PR.75-7ee9 → 7.6.0-PR.75-a611

package/package.json

@@ -1 +1 @@
-{"name":"@checkdigit/eslint-plugin","version":"7.6.0-PR.75-7ee9","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"}}
+{"name":"@checkdigit/eslint-plugin","version":"7.6.0-PR.75-a611","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/fetch-response-body-json.ts

@@ -38,7 +38,7 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'replaceBodyWithJson' | 'ref
     },
     messages: {
       refactorNeeded:
-        'Please extract the fetch call and check its reponse status code before accessing its response body.',
+        'Please extract the fetch call and check its response status code before accessing its response body.',
       replaceBodyWithJson: 'Replace "response.body" with "await response.json()".',
       unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },

package/src/agent/fetch-then.ts

@@ -8,15 +8,15 @@
 
 import { strict as assert } from 'node:assert';
 
-import { ScopeManager, Variable } from '@typescript-eslint/scope-manager';
+// import { ScopeManager, Variable } from '@typescript-eslint/scope-manager';
 import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
 import type { SourceCode } from '@typescript-eslint/utils/ts-eslint';
 
-import { getEnclosingFunction, getEnclosingStatement, getParent, isUsedInArrayOrAsArgument } from '../library/ts-tree';
+import { getEnclosingFunction, getParent, isUsedInArrayOrAsArgument } from '../library/ts-tree';
 import getDocumentationUrl from '../get-documentation-url';
 import { getIndentation } from '../library/format';
 import { isValidPropertyName } from '../library/variable';
-import { hasAssertions, isInvalidResponseHeadersAccess } from './fetch';
+import { hasAssertions } from './fetch';
 import { replaceEndpointUrlPrefixWithBasePath } from './url';
 
 export const ruleId = 'fetch-then';
@@ -143,52 +143,52 @@ function createResponseAssertions(
   };
 }
 
-function getResponseHeadersAccesses(responseVariables: Variable[], scopeManager: ScopeManager, sourceCode: SourceCode) {
-  const responseHeadersAccesses: TSESTree.MemberExpression[] = [];
-  for (const responseVariable of responseVariables) {
-    for (const responseReference of responseVariable.references) {
-      const responseAccess = getParent(responseReference.identifier);
-      if (!responseAccess || responseAccess.type !== AST_NODE_TYPES.MemberExpression) {
-        continue;
-      }
+// function getResponseHeadersAccesses(responseVariables: Variable[], scopeManager: ScopeManager, sourceCode: SourceCode) {
+//   const responseHeadersAccesses: TSESTree.MemberExpression[] = [];
+//   for (const responseVariable of responseVariables) {
+//     for (const responseReference of responseVariable.references) {
+//       const responseAccess = getParent(responseReference.identifier);
+//       if (!responseAccess || responseAccess.type !== AST_NODE_TYPES.MemberExpression) {
+//         continue;
+//       }
 
-      const responseAccessParent = getParent(responseAccess);
-      if (!responseAccessParent) {
-        continue;
-      }
+//       const responseAccessParent = getParent(responseAccess);
+//       if (!responseAccessParent) {
+//         continue;
+//       }
 
-      if (
-        responseAccessParent.type === AST_NODE_TYPES.CallExpression &&
-        responseAccessParent.arguments[0]?.type === AST_NODE_TYPES.ArrowFunctionExpression
-      ) {
-        // map-like operation against responses, e.g. responses.map((response) => response.headers.etag)
-        responseHeadersAccesses.push(
-          ...getResponseHeadersAccesses(
-            scopeManager.getDeclaredVariables(responseAccessParent.arguments[0]),
-            scopeManager,
-            sourceCode,
-          ),
-        );
-        continue;
-      }
+//       if (
+//         responseAccessParent.type === AST_NODE_TYPES.CallExpression &&
+//         responseAccessParent.arguments[0]?.type === AST_NODE_TYPES.ArrowFunctionExpression
+//       ) {
+//         // map-like operation against responses, e.g. responses.map((response) => response.headers.etag)
+//         responseHeadersAccesses.push(
+//           ...getResponseHeadersAccesses(
+//             scopeManager.getDeclaredVariables(responseAccessParent.arguments[0]),
+//             scopeManager,
+//             sourceCode,
+//           ),
+//         );
+//         continue;
+//       }
 
-      if (
-        responseAccess.computed &&
-        responseAccess.property.type === AST_NODE_TYPES.Literal &&
-        responseAccessParent.type === AST_NODE_TYPES.MemberExpression
-      ) {
-        // header access through indexed responses array, e.g. responses[0].headers, responses[1].get(...), etc.
-        responseHeadersAccesses.push(responseAccessParent);
-      } else {
-        responseHeadersAccesses.push(responseAccess);
-      }
-    }
-  }
-  return responseHeadersAccesses;
-}
+//       if (
+//         responseAccess.computed &&
+//         responseAccess.property.type === AST_NODE_TYPES.Literal &&
+//         responseAccessParent.type === AST_NODE_TYPES.MemberExpression
+//       ) {
+//         // header access through indexed responses array, e.g. responses[0].headers, responses[1].get(...), etc.
+//         responseHeadersAccesses.push(responseAccessParent);
+//       } else {
+//         responseHeadersAccesses.push(responseAccess);
+//       }
+//     }
+//   }
+//   return responseHeadersAccesses;
+// }
 
 const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-const rule: ESLintUtils.RuleModule<'unknownError' | 'preferNativeFetch' | 'shouldUseHeaderGetter'> = createRule({
+const rule: ESLintUtils.RuleModule<'unknownError' | 'preferNativeFetch'> = createRule({
   name: ruleId,
   meta: {
     type: 'suggestion',
@@ -198,7 +198,7 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'preferNativeFetch' | 'shoul
     },
     messages: {
       preferNativeFetch: 'Prefer native fetch API over customized fixture API.',
-      shouldUseHeaderGetter: 'Getter should be used to access response headers.',
+      // shouldUseHeaderGetter: 'Getter should be used to access response headers.',
       unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',
@@ -213,7 +213,6 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'preferNativeFetch' | 'shoul
     return {
       'CallExpression[callee.object.object.name="fixture"][callee.object.property.name="api"]': (
         fixtureCall: TSESTree.CallExpression,
-        // eslint-disable-next-line sonarjs/cognitive-complexity
       ) => {
         try {
           if (!hasAssertions(fixtureCall)) {
@@ -294,51 +293,51 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'preferNativeFetch' | 'shoul
             },
           });
 
-          const responsesVariable = getEnclosingStatement(fixtureCallInformation.fixtureNode);
-          if (!responsesVariable) {
-            return;
-          }
+          // const responsesVariable = getEnclosingStatement(fixtureCallInformation.fixtureNode);
+          // if (!responsesVariable) {
+          //   return;
+          // }
 
-          const responseVariableReferences = scopeManager.getDeclaredVariables(responsesVariable);
-          const responseHeadersAccesses = getResponseHeadersAccesses(
-            responseVariableReferences,
-            scopeManager,
-            sourceCode,
-          );
-          for (const responseHeadersAccess of responseHeadersAccesses) {
-            if (isInvalidResponseHeadersAccess(responseHeadersAccess)) {
-              const headerAccess = getParent(responseHeadersAccess);
-              if (headerAccess?.type === AST_NODE_TYPES.MemberExpression) {
-                const headerNameNode = headerAccess.property;
-                const headerName = headerAccess.computed
-                  ? sourceCode.getText(headerNameNode)
-                  : `'${sourceCode.getText(headerNameNode)}'`;
-                const headerAccessReplacementText = `${sourceCode.getText(headerAccess.object)}.get(${headerName})`;
+          // const responseVariableReferences = scopeManager.getDeclaredVariables(responsesVariable);
+          // const responseHeadersAccesses = getResponseHeadersAccesses(
+          //   responseVariableReferences,
+          //   scopeManager,
+          //   sourceCode,
+          // );
+          // for (const responseHeadersAccess of responseHeadersAccesses) {
+          //   if (isInvalidResponseHeadersAccess(responseHeadersAccess)) {
+          //     const headerAccess = getParent(responseHeadersAccess);
+          //     if (headerAccess?.type === AST_NODE_TYPES.MemberExpression) {
+          //       const headerNameNode = headerAccess.property;
+          //       const headerName = headerAccess.computed
+          //         ? sourceCode.getText(headerNameNode)
+          //         : `'${sourceCode.getText(headerNameNode)}'`;
+          //       const headerAccessReplacementText = `${sourceCode.getText(headerAccess.object)}.get(${headerName})`;
 
-                context.report({
-                  node: headerAccess,
-                  messageId: 'shouldUseHeaderGetter',
-                  fix(fixer) {
-                    return fixer.replaceText(headerAccess, headerAccessReplacementText);
-                  },
-                });
-              } else if (
-                headerAccess?.type === AST_NODE_TYPES.CallExpression &&
-                responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier &&
-                responseHeadersAccess.property.name === 'get'
-              ) {
-                const headerAccessReplacementText = `${sourceCode.getText(responseHeadersAccess.object)}.headers.get(${sourceCode.getText(headerAccess.arguments[0])})`;
+          //       context.report({
+          //         node: headerAccess,
+          //         messageId: 'shouldUseHeaderGetter',
+          //         fix(fixer) {
+          //           return fixer.replaceText(headerAccess, headerAccessReplacementText);
+          //         },
+          //       });
+          //     } else if (
+          //       headerAccess?.type === AST_NODE_TYPES.CallExpression &&
+          //       responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier &&
+          //       responseHeadersAccess.property.name === 'get'
+          //     ) {
+          //       const headerAccessReplacementText = `${sourceCode.getText(responseHeadersAccess.object)}.headers.get(${sourceCode.getText(headerAccess.arguments[0])})`;
 
-                context.report({
-                  node: headerAccess,
-                  messageId: 'shouldUseHeaderGetter',
-                  fix(fixer) {
-                    return fixer.replaceText(headerAccess, headerAccessReplacementText);
-                  },
-                });
-              }
-            }
-          }
+          //       context.report({
+          //         node: headerAccess,
+          //         messageId: 'shouldUseHeaderGetter',
+          //         fix(fixer) {
+          //           return fixer.replaceText(headerAccess, headerAccessReplacementText);
+          //         },
+          //       });
+          //     }
+          //   }
+          // }
         } catch (error) {
           // eslint-disable-next-line no-console
           console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);

package/src/agent/fetch.ts

@@ -63,7 +63,9 @@ export function hasAssertions(fixtureCall: TSESTree.Node): boolean {
 
 export function isFetchResponse(type: ts.Type): boolean {
   return (
-    type.getProperties().some((symbol) => symbol.name === 'body') &&
-    type.getProperties().some((symbol) => symbol.name === 'json')
+    type.getProperties().some((symbol) => symbol.name === 'json') &&
+    type.getProperties().some((symbol) => symbol.name === 'status') &&
+    type.getProperties().some((symbol) => symbol.name === 'headers') &&
+    type.getProperties().some((symbol) => symbol.name === 'body')
   );
 }