@checkdigit/eslint-plugin 7.3.0-PR.75-f04b → 7.3.0-PR.89-2e8d

package/src/agent/response-reference.ts

@@ -1,129 +0,0 @@
-// agent/response-reference.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 type { MemberExpression, ObjectPattern, VariableDeclaration } from 'estree';
-import { type Scope } from 'eslint';
-import debug from 'debug';
-
-import { getParent } from '../library/tree';
-
-const log = debug('eslint-plugin:response-reference');
-
-/**
- * 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 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;
-} {
-  const results: {
-    variable?: Scope.Variable;
-    bodyReferences: MemberExpression[];
-    headersReferences: MemberExpression[];
-    statusReferences: MemberExpression[];
-    destructuringBodyVariable?: Scope.Variable | ObjectPattern;
-    destructuringHeadersVariable?: Scope.Variable | ObjectPattern;
-    destructuringHeadersReferences?: MemberExpression[] | undefined;
-  } = {
-    bodyReferences: [],
-    headersReferences: [],
-    statusReferences: [],
-  };
-  if (!variableDeclaration) {
-    return results;
-  }
-
-  const responseVariables = scopeManager.getDeclaredVariables(variableDeclaration);
-  for (const responseVariable of responseVariables) {
-    const identifier = responseVariable.identifiers[0];
-    assert.ok(identifier);
-    const identifierParent = getParent(identifier);
-    assert.ok(identifierParent);
-    if (identifierParent.type === 'VariableDeclarator') {
-      // e.g. const response = ...
-      results.variable = responseVariable;
-      const responseReferences = responseVariable.references.map((responseReference) =>
-        getParent(responseReference.identifier),
-      );
-      // e.g. response.body
-      results.bodyReferences = responseReferences.filter(
-        (node): node is MemberExpression =>
-          node?.type === 'MemberExpression' && node.property.type === 'Identifier' && node.property.name === 'body',
-      );
-      // e.g. response.headers / response.header / response.get()
-      results.headersReferences = responseReferences.filter(
-        (node): node is MemberExpression =>
-          node?.type === 'MemberExpression' &&
-          node.property.type === 'Identifier' &&
-          (node.property.name === 'header' || node.property.name === 'headers' || node.property.name === 'get'),
-      );
-      // e.g. response.status / response.statusCode
-      results.statusReferences = responseReferences.filter(
-        (node): node is MemberExpression =>
-          node?.type === 'MemberExpression' &&
-          node.property.type === 'Identifier' &&
-          (node.property.name === 'status' || node.property.name === 'statusCode'),
-      );
-    } else if (
-      // body reference through destruction/renaming, e.g. "const { body } = ..."
-      identifierParent.type === 'Property' &&
-      identifierParent.key.type === 'Identifier' &&
-      identifierParent.key.name === 'body'
-    ) {
-      results.destructuringBodyVariable = responseVariable;
-    } else if (
-      // header reference through destruction/renaming, e.g. "const { headers } = ..."
-      identifierParent.type === 'Property' &&
-      identifierParent.key.type === 'Identifier' &&
-      identifierParent.key.name === 'headers'
-    ) {
-      results.destructuringHeadersVariable = responseVariable;
-      results.destructuringHeadersReferences = responseVariable.references
-        .map((reference) => reference.identifier)
-        .map(getParent)
-        .filter(
-          (parent): parent is MemberExpression =>
-            parent?.type === 'MemberExpression' &&
-            parent.property.type === 'Identifier' &&
-            parent.property.name !== 'get' &&
-            getParent(parent)?.type !== 'CallExpression',
-        );
-    } else if (identifierParent.type === 'Property') {
-      const parent = getParent(identifierParent);
-      if (parent?.type === 'ObjectPattern') {
-        // body reference through nested destruction, e.g. "const { body: {bodyPropertyName: renamedBodyPropertyName}, headers: {headerPropertyName: renamedHeaderPropertyName} } = ..."
-        const parent2 = getParent(parent);
-        if (parent2?.type === 'Property' && parent2.key.type === 'Identifier' && parent2.key.name === 'body') {
-          results.destructuringBodyVariable = parent;
-        }
-        if (
-          parent2?.type === 'Property' &&
-          parent2.key.type === 'Identifier' &&
-          (parent2.key.name === 'header' || parent2.key.name === 'headers')
-        ) {
-          results.destructuringHeadersVariable = parent;
-        }
-      }
-    } else {
-      log('+++++++ can not handle identifierParent', identifierParent);
-      throw new Error(`Unknown response variable reference: ${responseVariable.name}`);
-    }
-  }
-  return results;
-}

package/src/agent/url.ts

@@ -1,32 +0,0 @@
-// agent/url.ts
-
-// eslint-disable-next-line @typescript-eslint/no-inferrable-types
-const PLAIN_URL_REGEXP: RegExp = /^[`']\/\w+(?<serviceNamePart>-\w+)*\/v\d+\/(?<any>.|\r|\n)+[`']$/u;
-// eslint-disable-next-line @typescript-eslint/no-inferrable-types
-const TOKENIZED_URL_REGEXP: RegExp = /^`\$\{(?<serviceNamePart>[A-Z]+_)*BASE_PATH\}\/(?<any>.|\r|\n)+`$/u;
-
-export function isServiceApiCallUrl(url: string): boolean {
-  return PLAIN_URL_REGEXP.test(url) || TOKENIZED_URL_REGEXP.test(url);
-}
-
-export function replaceEndpointUrlPrefixWithBasePath(url: string): string {
-  return url.replace(
-    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+\/)(?<endpoint>(?<any>.|\r|\n)+)(?<quotEnd>[`'])$/u,
-    // eslint-disable-next-line no-template-curly-in-string
-    '`${BASE_PATH}/$5`',
-  );
-}
-
-export function replaceEndpointUrlPrefixWithDomain(url: string): string {
-  return url.replace(
-    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+\/(?<any>.|\r|\n)+(?<quotEnd>[`'])$)/u,
-    '$1https://$2.checkdigit/$2$4',
-  );
-}
-
-export function addBasePathUrlDomain(url: string): string {
-  return url.replace(
-    /^(?<quotStart>[`'])\/(?<servicename>\w+(?<parts>-\w+)*)(?<path>\/v\d+(?<quotEnd>[`'])$)/u,
-    '$1https://$2.checkdigit/$2$4',
-  );
-}

package/src/no-legacy-service-typing.ts

@@ -1,49 +0,0 @@
-// no-legacy-service-typing.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 = 'no-legacy-service-typing';
-
-const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
-
-const DISALLOWED_SERVICE_TYPINGS: string[] | undefined = ['FullResponse', 'Endpoint'];
-
-const rule: ESLintUtils.RuleModule<'noLegacyServiceTyping', [typeof DISALLOWED_SERVICE_TYPINGS]> = createRule({
-  name: ruleId,
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Legacy service typings should not be used.',
-    },
-    messages: {
-      noLegacyServiceTyping: 'Please remove the usage of legacy service typings.',
-    },
-    schema: [{ type: 'array', items: { type: 'string' } }],
-  },
-  defaultOptions: [DISALLOWED_SERVICE_TYPINGS],
-  create(context) {
-    return {
-      TSTypeReference: (typeReference: TSESTree.TSTypeReference) => {
-        if (
-          typeReference.typeName.type === AST_NODE_TYPES.Identifier &&
-          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-          (context.options[0] ?? DISALLOWED_SERVICE_TYPINGS).includes(typeReference.typeName.name)
-        ) {
-          context.report({
-            messageId: 'noLegacyServiceTyping',
-            node: typeReference,
-          });
-        }
-      },
-    };
-  },
-});
-
-export default rule;