@checkdigit/eslint-plugin 6.6.0-PR.75-0fc6 → 6.6.0-PR.77-885a

package/dist-mjs/require-type-out-of-type-only-imports.mjs

@@ -1,48 +0,0 @@
-// src/require-type-out-of-type-only-imports.ts
-import { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
-import getDocumentationUrl from "./get-documentation-url.mjs";
-var ruleId = "require-type-out-of-type-only-imports";
-var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-var 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);
-          }
-        });
-      }
-    };
-  }
-});
-var require_type_out_of_type_only_imports_default = rule;
-export {
-  require_type_out_of_type_only_imports_default as default,
-  ruleId
-};
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL3JlcXVpcmUtdHlwZS1vdXQtb2YtdHlwZS1vbmx5LWltcG9ydHMudHMiXSwKICAibWFwcGluZ3MiOiAiO0FBUUEsU0FBUyxhQUFhLGdCQUFnQjtBQUN0QyxPQUFPLHlCQUF5QjtBQUV6QixJQUFNLFNBQVM7QUFFdEIsSUFBTSxhQUFhLFlBQVksWUFBWSxDQUFDLFNBQVMsb0JBQW9CLElBQUksQ0FBQztBQUU5RSxJQUFNLE9BQU8sV0FBVztBQUFBLEVBQ3RCLE1BQU07QUFBQSxFQUNOLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxJQUNOLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxJQUNmO0FBQUEsSUFDQSxVQUFVO0FBQUEsTUFDUixpQkFBaUI7QUFBQSxJQUNuQjtBQUFBLElBQ0EsU0FBUztBQUFBLElBQ1QsUUFBUSxDQUFDO0FBQUEsRUFDWDtBQUFBLEVBQ0EsZ0JBQWdCLENBQUM7QUFBQSxFQUNqQixPQUFPLFNBQVM7QUFDZCxVQUFNLGFBQWEsUUFBUTtBQUUzQixXQUFPO0FBQUEsTUFDTCxrQkFBa0IsYUFBYTtBQUM3QixZQUNFLFlBQVksZUFBZSxVQUMzQixDQUFDLFlBQVksV0FBVztBQUFBLFVBQ3RCLENBQUMsY0FDQyxVQUFVLFNBQVMsU0FBUyxlQUFlLG1CQUFtQixVQUFVLGVBQWU7QUFBQSxRQUMzRixHQUNBO0FBQ0E7QUFBQSxRQUNGO0FBRUEsZ0JBQVEsT0FBTztBQUFBLFVBQ2IsV0FBVztBQUFBLFVBQ1gsTUFBTTtBQUFBLFVBQ04sQ0FBQyxJQUFJLE9BQU87QUFDVixrQkFBTSxhQUFhLFlBQVksT0FBTztBQUN0QyxrQkFBTSxtQkFBbUIsWUFBWSxXQUNsQyxPQUFPLENBQUMsY0FBYyxVQUFVLFNBQVMsU0FBUyxlQUFlLHNCQUFzQixFQUN2RixJQUFJLENBQUMsY0FBYyxXQUFXLFFBQVEsU0FBUyxFQUFFLFFBQVEsU0FBUyxFQUFFLENBQUM7QUFDeEUsa0JBQU0sMkJBQTJCLGlCQUFpQixpQkFBaUIsS0FBSyxJQUFJLENBQUMsWUFBWSxVQUFVO0FBRW5HLGtCQUFNLE1BQU0sWUFBWSxhQUFhLHdCQUF3QjtBQUFBLFVBQy9EO0FBQUEsUUFDRixDQUFDO0FBQUEsTUFDSDtBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBQ0YsQ0FBQztBQUVELElBQU8sZ0RBQVE7IiwKICAibmFtZXMiOiBbXQp9Cg==

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

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "add-url-domain";
-declare const rule: ESLintUtils.RuleModule<"addDomain" | "unknownError", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/fetch-response-body-json.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "fetch-response-body-json";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "replaceBodyWithJson", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/fetch-response-header-getter.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "fetch-response-header-getter-ts";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "useGetter", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/fetch-then.d.ts

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

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

@@ -1,4 +0,0 @@
-import type { Node } from 'estree';
-export declare function getResponseBodyRetrievalText(responseVariableName: string): string;
-export declare function isInvalidResponseHeadersAccess(responseHeadersAccess: Node): boolean;
-export declare function hasAssertions(fixtureCall: Node): boolean;

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

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

package/dist-types/agent/no-full-response.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "no-full-response";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "removeFullResponse", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/no-mapped-response.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "no-mapped-response";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "replaceFullResponseWithFetchResponse", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/no-service-wrapper.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "no-service-wrapper";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "preferNativeFetch" | "invalidOptions", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/no-status-code.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "no-status-code";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "replaceStatusCode", never[], ESLintUtils.RuleListener>;
-export default rule;

package/dist-types/agent/no-unused-function-argument.d.ts

@@ -1,4 +0,0 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
-export declare const ruleId = "no-unused-function-argument";
-declare const rule: ESLintUtils.RuleModule<"unknownError" | "removeUnusedFunctionArguments", never[], ESLintUtils.RuleListener>;
-export default rule;

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

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

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

@@ -1,16 +0,0 @@
-import type { MemberExpression, 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;
-    destructuringHeadersVariable?: Scope.Variable;
-    destructuringHeadersReferences?: MemberExpression[] | undefined;
-};

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

@@ -1,5 +0,0 @@
-export declare const PLAIN_URL_REGEXP: RegExp;
-export declare const TOKENIZED_URL_REGEXP: RegExp;
-export declare function replaceEndpointUrlPrefixWithBasePath(url: string): string;
-export declare function replaceEndpointUrlPrefixWithDomain(url: string): string;
-export declare function addBasePathUrlDomain(url: string): string;

package/dist-types/no-duplicated-imports.d.ts

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

package/dist-types/require-fixed-services-import.d.ts

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

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

@@ -1,4 +0,0 @@
-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/src/agent/add-url-domain.ts

@@ -1,75 +0,0 @@
-// 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 { addBasePathUrlDomain } from './url';
-import getDocumentationUrl from '../get-documentation-url';
-
-export const ruleId = 'add-url-domain';
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const rule = 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;

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

@@ -1,76 +0,0 @@
-// agent/fetch-response-body-json.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';
-
-export const ruleId = 'fetch-response-body-json';
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const rule = createRule({
-  name: ruleId,
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Replace "response.body" with "await response.json()".',
-    },
-    messages: {
-      replaceBodyWithJson: 'Replace "response.body" with "await response.json()".',
-      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
-    },
-    fixable: 'code',
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-    const typeChecker = parserServices.program.getTypeChecker();
-    const sourceCode = context.sourceCode;
-
-    return {
-      'MemberExpression[property.name="body"]': (responseBody: TSESTree.MemberExpression) => {
-        try {
-          const responseNode = parserServices.esTreeNodeToTSNodeMap.get(responseBody.object);
-          const responseType = typeChecker.getTypeAtLocation(responseNode);
-
-          const shouldReplace =
-            responseType.getProperties().some((symbol) => symbol.name === 'body') &&
-            responseType.getProperties().some((symbol) => symbol.name === 'json');
-
-          if (shouldReplace) {
-            const responseText = sourceCode.getText(responseBody.object);
-            const needAwait = responseBody.parent.type !== AST_NODE_TYPES.ReturnStatement;
-            const replacementText = needAwait ? `(await ${responseText}.json())` : `${responseText}.json()`;
-
-            context.report({
-              messageId: 'replaceBodyWithJson',
-              node: responseBody,
-              fix(fixer) {
-                return fixer.replaceText(responseBody, replacementText);
-              },
-            });
-          }
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
-          context.report({
-            node: responseBody,
-            messageId: 'unknownError',
-            data: {
-              fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
-            },
-          });
-        }
-      },
-    };
-  },
-});
-
-export default rule;

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

@@ -1,148 +0,0 @@
-// agent/fetch-response-header-getter-ts.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';
-
-export const ruleId = 'fetch-response-header-getter-ts';
-const HEADER_BUILTIN_FUNCTIONS = Object.keys(Headers.prototype);
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const rule = createRule({
-  name: ruleId,
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Use "get()" method to get header value from the headers object of the fetch response.',
-    },
-    messages: {
-      useGetter: 'Use "get()" method to get header value from the headers object of the fetch response.',
-      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
-    },
-    fixable: 'code',
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    const parserServices = ESLintUtils.getParserServices(context);
-    const typeChecker = parserServices.program.getTypeChecker();
-    const sourceCode = context.sourceCode;
-
-    return {
-      MemberExpression: (responseHeadersAccess: TSESTree.MemberExpression) => {
-        try {
-          if (
-            responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier &&
-            HEADER_BUILTIN_FUNCTIONS.includes(responseHeadersAccess.property.name)
-          ) {
-            // skip Headers's built-in function calls
-            return;
-          }
-
-          const responseHeadersTsNode = parserServices.esTreeNodeToTSNodeMap.get(responseHeadersAccess.object);
-          let responseHeadersType = typeChecker.getTypeAtLocation(responseHeadersTsNode);
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          responseHeadersType = responseHeadersType.isUnion() ? responseHeadersType.types[0]! : responseHeadersType;
-          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-          const responseHeadersTypeName = // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            (responseHeadersType.symbol ?? responseHeadersType.aliasSymbol)?.escapedName;
-          // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
-          if (responseHeadersTypeName !== 'Headers' && responseHeadersTypeName !== 'HeaderGetter') {
-            return;
-          }
-
-          let replacementText: string;
-          if (!responseHeadersAccess.computed) {
-            // e.g. headers.etag
-            replacementText = `${sourceCode.getText(responseHeadersAccess.object)}.get('${sourceCode.getText(responseHeadersAccess.property)}')`;
-          } else if (
-            responseHeadersAccess.property.type === AST_NODE_TYPES.Identifier ||
-            responseHeadersAccess.property.type === AST_NODE_TYPES.Literal ||
-            responseHeadersAccess.property.type === AST_NODE_TYPES.TemplateLiteral
-          ) {
-            replacementText = `${sourceCode.getText(responseHeadersAccess.object)}.get(${sourceCode.getText(responseHeadersAccess.property)})`;
-          } else {
-            throw new Error(`Unexpected property type: ${responseHeadersAccess.property.type}`);
-          }
-
-          context.report({
-            messageId: 'useGetter',
-            node: responseHeadersAccess.property,
-            fix(fixer) {
-              return fixer.replaceText(responseHeadersAccess, replacementText);
-            },
-          });
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
-          context.report({
-            node: responseHeadersAccess,
-            messageId: 'unknownError',
-            data: {
-              fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
-            },
-          });
-        }
-      },
-
-      // convert response.get() to response.headers.get()
-      'CallExpression[callee.property.name="get"]': (responseHeadersAccess: TSESTree.CallExpression) => {
-        try {
-          if (responseHeadersAccess.callee.type !== AST_NODE_TYPES.MemberExpression) {
-            return;
-          }
-
-          // skip request-like calls
-          if (
-            responseHeadersAccess.callee.object.type !== AST_NODE_TYPES.Identifier ||
-            responseHeadersAccess.callee.object.name === 'request'
-          ) {
-            return;
-          }
-          const responseNode = responseHeadersAccess.callee.object;
-          const responseHeadersTsNode = parserServices.esTreeNodeToTSNodeMap.get(responseNode);
-          const responseType = typeChecker.getTypeAtLocation(responseHeadersTsNode);
-          const typeName = typeChecker.typeToString(responseType);
-          if (typeName === 'InboundContext' || typeName.endsWith('RequestType')) {
-            return;
-          }
-
-          // make sure the response type has "headers" property
-          const hasHeadersProperty = responseType.getProperties().some((symbol) => symbol.name === 'headers');
-          if (!hasHeadersProperty) {
-            return;
-          }
-
-          const replacementText = `${sourceCode.getText(responseNode)}.headers`;
-          context.report({
-            messageId: 'useGetter',
-            node: responseHeadersAccess,
-            fix(fixer) {
-              return fixer.replaceText(responseNode, replacementText);
-            },
-          });
-        } catch (error) {
-          // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
-          context.report({
-            node: responseHeadersAccess,
-            messageId: 'unknownError',
-            data: {
-              fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
-            },
-          });
-        }
-      },
-    };
-  },
-});
-
-export default rule;