@checkdigit/eslint-plugin 7.17.1 → 8.0.0-PR.141-7ea9

package/src/require-service-call-response-declaration.ts

@@ -6,16 +6,22 @@
  * This code is licensed under the MIT license (see LICENSE.txt for details).
  */
 
-import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
+import {
+  AST_NODE_TYPES,
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
 
-import getDocumentationUrl from './get-documentation-url';
-import { isServiceResponse } from './service';
+import getDocumentationUrl from './get-documentation-url.ts';
+import { isServiceResponse } from './service.ts';
 
 export const ruleId = 'require-service-call-response-declaration';
 
 const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
 
-const rule: ESLintUtils.RuleModule<'unknownError' | 'requireServiceCallResponseDeclaration'> = createRule({
+const rule: ESLintUtils.RuleModule<
+  'unknownError' | 'requireServiceCallResponseDeclaration'
+> = createRule({
   name: ruleId,
   meta: {
     type: 'suggestion',
@@ -26,7 +32,8 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'requireServiceCallResponseD
     messages: {
       requireServiceCallResponseDeclaration:
         'Awaited service call is required to declare variable for its return value which should be examined later on.',
-      unknownError: 'Unknown error occurred in file "{{fileName}}": {{ error }}.',
+      unknownError:
+        'Unknown error occurred in file "{{fileName}}": {{ error }}.',
     },
     fixable: 'code',
     schema: [],
@@ -39,7 +46,9 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'requireServiceCallResponseD
     return {
       AwaitExpression(serviceCall: TSESTree.AwaitExpression) {
         try {
-          const tsNode = parserServices.esTreeNodeToTSNodeMap.get(serviceCall.argument);
+          const tsNode = parserServices.esTreeNodeToTSNodeMap.get(
+            serviceCall.argument,
+          );
           const type = typeChecker.getTypeAtLocation(tsNode);
           const awaitedType = typeChecker.getAwaitedType(type);
           if (
@@ -54,13 +63,19 @@ const rule: ESLintUtils.RuleModule<'unknownError' | 'requireServiceCallResponseD
           }
         } catch (error) {
           // eslint-disable-next-line no-console
-          console.error(`Failed to apply ${ruleId} rule for file "${context.filename}":`, error);
+          console.error(
+            `Failed to apply ${ruleId} rule for file "${context.filename}":`,
+            error,
+          );
           context.report({
             node: serviceCall,
             messageId: 'unknownError',
             data: {
               fileName: context.filename,
-              error: error instanceof Error ? error.toString() : JSON.stringify(error),
+              error:
+                error instanceof Error
+                  ? error.toString()
+                  : JSON.stringify(error),
             },
           });
         }

package/src/require-strict-assert.ts

@@ -15,7 +15,8 @@ export default {
   meta: {
     type: 'problem',
     docs: {
-      description: 'Require importing strict version of node:assert and using non-strict assert functions.',
+      description:
+        'Require importing strict version of node:assert and using non-strict assert functions.',
       url: 'https://github.com/checkdigit/eslint-plugin',
     },
     fixable: 'code',
@@ -37,23 +38,33 @@ export default {
             const importDeclaration = node.parent;
             const defaultSpecifier = importDeclaration.specifiers.find(
               (specifier) =>
-                specifier.type === 'ImportDefaultSpecifier' || specifier.type === 'ImportNamespaceSpecifier',
+                specifier.type === 'ImportDefaultSpecifier' ||
+                specifier.type === 'ImportNamespaceSpecifier',
             );
 
             if (defaultSpecifier !== undefined) {
               const importDeclarationRange = importDeclaration.range ?? [0, 0];
-              let rangeToReplace = defaultSpecifier.range ?? importDeclarationRange;
+              let rangeToReplace =
+                defaultSpecifier.range ?? importDeclarationRange;
               let correctedText = `{ strict as ${defaultSpecifier.local.name} }`;
 
-              if (node.value === NODE_ASSERT_STRICT && defaultSpecifier.range && importDeclaration.source.range) {
-                rangeToReplace = [defaultSpecifier.range[0], importDeclaration.source.range[1]];
+              if (
+                node.value === NODE_ASSERT_STRICT &&
+                defaultSpecifier.range &&
+                importDeclaration.source.range
+              ) {
+                rangeToReplace = [
+                  defaultSpecifier.range[0],
+                  importDeclaration.source.range[1],
+                ];
                 correctedText = `{ strict as ${defaultSpecifier.local.name} } from '${NODE_ASSERT}'`;
               }
 
               context.report({
                 node: importDeclaration,
                 message: 'Invalid form of strict assertion mode',
-                fix: (fixer) => fixer.replaceTextRange(rangeToReplace, correctedText),
+                fix: (fixer) =>
+                  fixer.replaceTextRange(rangeToReplace, correctedText),
               });
             }
           }
@@ -67,7 +78,8 @@ export default {
           callee.object.name !== '' &&
           callee.property.type === 'Identifier' &&
           callee.property.name !== '' &&
-          (callee.property.name.includes('strict') || callee.property.name.includes('Strict'))
+          (callee.property.name.includes('strict') ||
+            callee.property.name.includes('Strict'))
         ) {
           const nodeValue = nodeValues[callee.object.name];
           if (nodeValue === NODE_ASSERT || nodeValue === NODE_ASSERT_STRICT) {
@@ -84,7 +96,8 @@ export default {
             }
             context.report({
               node,
-              message: 'strict method not required when in strict assertion mode.',
+              message:
+                'strict method not required when in strict assertion mode.',
               fix: (fixer) => fixer.replaceText(callee, nonStrictFunctionName),
             });
           }

package/src/require-ts-extension-imports-exports.ts

@@ -18,8 +18,15 @@ const REQUIRE_TS_EXTENSION_EXPORTS = 'REQUIRE-TS-EXTENSION-EXPORTS';
 
 const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
 
-const checkPath = (filename: string, filePath: string): { fixedPath: string | null; isFixNeeded: boolean } => {
-  if (filePath.startsWith('.') && !filePath.endsWith('.ts') && !filePath.endsWith('.json')) {
+const checkPath = (
+  filename: string,
+  filePath: string,
+): { fixedPath: string | null; isFixNeeded: boolean } => {
+  if (
+    filePath.startsWith('.') &&
+    !filePath.endsWith('.ts') &&
+    !filePath.endsWith('.json')
+  ) {
     const absolutePath = path.resolve(path.dirname(filename), filePath);
     const tsPath = `${absolutePath}.ts`;
     const existsPath = [absolutePath, tsPath].find(fs.existsSync);
@@ -38,13 +45,16 @@ const rule: TSESLint.RuleModule<string, unknown[]> = createRule({
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'Ensure .ts extension is at the end of all imports and exports',
+      description:
+        'Ensure .ts extension is at the end of all imports and exports',
     },
     fixable: 'code',
     schema: [],
     messages: {
-      [REQUIRE_TS_EXTENSION_IMPORTS]: 'Import paths should end with .ts extension',
-      [REQUIRE_TS_EXTENSION_EXPORTS]: 'Export paths should end with .ts extension',
+      [REQUIRE_TS_EXTENSION_IMPORTS]:
+        'Import paths should end with .ts extension',
+      [REQUIRE_TS_EXTENSION_EXPORTS]:
+        'Export paths should end with .ts extension',
     },
   },
   defaultOptions: [],
@@ -52,7 +62,10 @@ const rule: TSESLint.RuleModule<string, unknown[]> = createRule({
     const filename = context.filename;
 
     const handleDeclaration = (
-      node: TSESTree.ImportDeclaration | TSESTree.ExportNamedDeclaration | TSESTree.ExportAllDeclaration,
+      node:
+        | TSESTree.ImportDeclaration
+        | TSESTree.ExportNamedDeclaration
+        | TSESTree.ExportAllDeclaration,
     ) => {
       if (node.source !== null) {
         const importPath = node.source.value;

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

@@ -21,7 +21,8 @@ const rule: ESLintUtils.RuleModule<'moveTypeOutside'> = createRule({
       description: 'Require "type" to be out side of type-only imports.',
     },
     messages: {
-      moveTypeOutside: 'Update the type-only imports to put "type" specifier outside of the curly braces.',
+      moveTypeOutside:
+        'Update the type-only imports to put "type" specifier outside of the curly braces.',
     },
     fixable: 'code',
     schema: [],
@@ -37,7 +38,8 @@ const rule: ESLintUtils.RuleModule<'moveTypeOutside'> = createRule({
           declaration.specifiers.length === 0 ||
           !declaration.specifiers.every(
             (specifier) =>
-              specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && specifier.importKind === 'type',
+              specifier.type === TSESTree.AST_NODE_TYPES.ImportSpecifier &&
+              specifier.importKind === 'type',
           )
         ) {
           return;
@@ -49,8 +51,14 @@ const rule: ESLintUtils.RuleModule<'moveTypeOutside'> = createRule({
           *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 ', ''));
+              .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);