eslint-plugin-ts-data-forge 0.8.5 → 0.9.0

package/src/rules/prefer-arr-is-array.mts

@@ -3,12 +3,13 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import { skipTypeWrappers } from './ast-utils.mjs';
 import {
-  buildImportFixes,
+  buildNamedImportFix,
+  getImportDeclarations,
   getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -34,7 +35,10 @@ export const preferArrIsArray: TSESLint.RuleModule<MessageIds, Options> = {
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const mut_nodesToFix: TSESTree.CallExpression[] = [];
 
@@ -48,7 +52,8 @@ export const preferArrIsArray: TSESLint.RuleModule<MessageIds, Options> = {
       },
       'Program:exit': () => {
         // Check if Arr is already imported
-        const hasArrImport = getNamedImports(tsDataForgeImport).includes('Arr');
+        const hasArrImport =
+          getNamedImports(tsDataForgeImports).includes('Arr');
 
         // Note: We add import only for the first node to avoid conflicts when
         // multiple fixes try to insert at the same position. This means if the
@@ -70,7 +75,9 @@ export const preferArrIsArray: TSESLint.RuleModule<MessageIds, Options> = {
               // Add import only for the first node and only if not already imported
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(callee, 'Arr.isArray')];

package/src/rules/prefer-arr-is-array.test.mts

@@ -33,6 +33,20 @@ ruleTester.run('prefer-arr-is-array', preferArrIsArray, {
       `,
       errors: [{ messageId: 'useArrIsArray' }],
     },
+    {
+      name: 'Arr imported by a second ts-data-forge declaration is not imported again',
+      code: dedent`
+        import type { Optional } from 'ts-data-forge';
+        import { Arr } from 'ts-data-forge';
+        const result = Array.isArray(value);
+      `,
+      output: dedent`
+        import type { Optional } from 'ts-data-forge';
+        import { Arr } from 'ts-data-forge';
+        const result = Arr.isArray(value);
+      `,
+      errors: [{ messageId: 'useArrIsArray' }],
+    },
     {
       name: 'Replace Array.isArray with Arr.isArray when Arr is already imported',
       code: dedent`

package/src/rules/prefer-arr-is-bounded-length-array.mts

@@ -1,15 +1,16 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
+} from 'eslint-rule-forge';
 import {
   isArrayOrTupleExpression,
   isSameArrayText,
   parseLengthComparison,
-  toArgumentText,
 } from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -38,7 +39,10 @@ export const preferArrIsBoundedLengthArray: TSESLint.RuleModule<
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -95,7 +99,7 @@ export const preferArrIsBoundedLengthArray: TSESLint.RuleModule<
         });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
@@ -103,7 +107,7 @@ export const preferArrIsBoundedLengthArray: TSESLint.RuleModule<
           index,
           { node, arrayExpression, minExpression, maxExpression },
         ] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(arrayExpression, sourceCode);
+          const arrayText = getArgumentText(sourceCode, arrayExpression);
 
           const minText = sourceCode.getText(minExpression);
 
@@ -125,7 +129,9 @@ export const preferArrIsBoundedLengthArray: TSESLint.RuleModule<
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(node, replacement)];

package/src/rules/prefer-arr-is-bounded-length-array.test.mts

@@ -188,6 +188,25 @@ describe('prefer-arr-is-bounded-length-array through type wrappers', () => {
             { messageId: 'useIsBoundedLengthArray' },
           ],
         },
+        {
+          name: 'either comparison wrapped as a whole',
+          code: dedent`
+            import { Arr } from 'ts-data-forge';
+            declare const xs: readonly number[];
+            const a = (xs.length >= 1 satisfies boolean) && xs.length <= 3;
+            const b = xs.length >= 1 && (xs.length <= 3 as boolean);
+          `,
+          output: dedent`
+            import { Arr } from 'ts-data-forge';
+            declare const xs: readonly number[];
+            const a = Arr.isBoundedLengthArray(1, 3, xs);
+            const b = Arr.isBoundedLengthArray(1, 3, xs);
+          `,
+          errors: [
+            { messageId: 'useIsBoundedLengthArray' },
+            { messageId: 'useIsBoundedLengthArray' },
+          ],
+        },
       ],
     },
   );

package/src/rules/prefer-arr-is-fixed-length-array.mts

@@ -1,16 +1,17 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
 import {
   asLengthAccess,
   isArrayOrTupleExpression,
   isIntegerLiteralOrConstant,
-  skipTypeWrappers,
-  toArgumentText,
 } from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -39,7 +40,10 @@ export const preferArrIsFixedLengthArray: TSESLint.RuleModule<
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -94,7 +98,7 @@ export const preferArrIsFixedLengthArray: TSESLint.RuleModule<
         });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
@@ -102,7 +106,7 @@ export const preferArrIsFixedLengthArray: TSESLint.RuleModule<
           index,
           { node, arrayExpression, lengthExpression, isNegated },
         ] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(arrayExpression, sourceCode);
+          const arrayText = getArgumentText(sourceCode, arrayExpression);
 
           const lengthText = sourceCode.getText(lengthExpression);
 
@@ -123,7 +127,9 @@ export const preferArrIsFixedLengthArray: TSESLint.RuleModule<
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(node, replacement)];

package/src/rules/prefer-arr-is-max-length-array.mts

@@ -1,17 +1,18 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
 import {
   asLengthAccess,
   isArrayOrTupleExpression,
   isIntegerLiteralOrConstant,
   isPartOfBoundedLengthCheck,
-  skipTypeWrappers,
-  toArgumentText,
 } from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -40,7 +41,10 @@ export const preferArrIsMaxLengthArray: TSESLint.RuleModule<
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -99,7 +103,7 @@ export const preferArrIsMaxLengthArray: TSESLint.RuleModule<
         });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
@@ -107,7 +111,7 @@ export const preferArrIsMaxLengthArray: TSESLint.RuleModule<
           index,
           { node, arrayExpression, lengthExpression },
         ] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(arrayExpression, sourceCode);
+          const arrayText = getArgumentText(sourceCode, arrayExpression);
 
           const lengthText = sourceCode.getText(lengthExpression);
 
@@ -126,7 +130,9 @@ export const preferArrIsMaxLengthArray: TSESLint.RuleModule<
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(node, replacement)];

package/src/rules/prefer-arr-is-max-length-array.test.mts

@@ -205,6 +205,14 @@ describe('prefer-arr-is-max-length-array through type wrappers', () => {
           const ok = xs!.length >= 1 && xs.length <= 3;
         `,
       },
+      {
+        name: 'one half of a bounded pair, either half wrapped as a whole',
+        code: dedent`
+          declare const xs: readonly number[];
+          const a = (xs.length >= 1 satisfies boolean) && xs.length <= 3;
+          const b = xs.length >= 1 && (xs.length <= 3 as boolean);
+        `,
+      },
     ],
     invalid: [
       {

package/src/rules/prefer-arr-is-min-length-array.mts

@@ -1,17 +1,18 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
 import {
   asLengthAccess,
   isArrayOrTupleExpression,
   isIntegerLiteralOrConstant,
   isPartOfBoundedLengthCheck,
-  skipTypeWrappers,
-  toArgumentText,
 } from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -40,7 +41,10 @@ export const preferArrIsMinLengthArray: TSESLint.RuleModule<
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -99,7 +103,7 @@ export const preferArrIsMinLengthArray: TSESLint.RuleModule<
         });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
@@ -107,7 +111,7 @@ export const preferArrIsMinLengthArray: TSESLint.RuleModule<
           index,
           { node, arrayExpression, lengthExpression },
         ] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(arrayExpression, sourceCode);
+          const arrayText = getArgumentText(sourceCode, arrayExpression);
 
           const lengthText = sourceCode.getText(lengthExpression);
 
@@ -126,7 +130,9 @@ export const preferArrIsMinLengthArray: TSESLint.RuleModule<
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(node, replacement)];

package/src/rules/prefer-arr-is-min-length-array.test.mts

@@ -219,6 +219,14 @@ describe('prefer-arr-is-min-length-array through type wrappers', () => {
           const ok = xs.length >= 1 && (xs as readonly number[]).length <= 3;
         `,
       },
+      {
+        name: 'one half of a bounded pair, either half wrapped as a whole',
+        code: dedent`
+          declare const xs: readonly number[];
+          const a = (xs.length >= 1 satisfies boolean) && xs.length <= 3;
+          const b = xs.length >= 1 && (xs.length <= 3 as boolean);
+        `,
+      },
     ],
     invalid: [
       {

package/src/rules/prefer-arr-is-non-empty.mts

@@ -4,16 +4,14 @@ import {
   type TSESTree,
 } from '@typescript-eslint/utils';
 import {
-  asLengthAccess,
-  isArrayOrTupleExpression,
-  skipTypeWrappers,
-  toArgumentText,
-} from './ast-utils.mjs';
-import {
-  buildImportFixes,
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
   getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
+import { asLengthAccess, isArrayOrTupleExpression } from './ast-utils.mjs';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -39,7 +37,10 @@ export const preferArrIsNonEmpty: TSESLint.RuleModule<MessageIds, Options> = {
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -88,7 +89,7 @@ export const preferArrIsNonEmpty: TSESLint.RuleModule<MessageIds, Options> = {
         });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
@@ -96,7 +97,7 @@ export const preferArrIsNonEmpty: TSESLint.RuleModule<MessageIds, Options> = {
           index,
           { node, arrayExpression },
         ] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(arrayExpression, sourceCode);
+          const arrayText = getArgumentText(sourceCode, arrayExpression);
 
           const originalText = sourceCode.getText(node);
 
@@ -112,7 +113,9 @@ export const preferArrIsNonEmpty: TSESLint.RuleModule<MessageIds, Options> = {
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [...importFixes, fixer.replaceText(node, replacement)];

package/src/rules/prefer-arr-scan.mts

@@ -3,19 +3,18 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import { Arr } from 'ts-data-forge';
-import type { FixedLengthTuple } from 'ts-type-forge';
-import * as ts from 'typescript';
 import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
   skipTypeWrappers,
-  toArgumentText,
   typeWrapperLayers,
-} from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+} from 'eslint-rule-forge';
+import { Arr } from 'ts-data-forge';
+import type { FixedLengthTuple } from 'ts-type-forge';
+import * as ts from 'typescript';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -179,7 +178,10 @@ export const preferArrScan: TSESLint.RuleModule<MessageIds, Options> = {
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = sourceCode.parserServices;
 
@@ -343,10 +345,9 @@ export const preferArrScan: TSESLint.RuleModule<MessageIds, Options> = {
         mut_lastReads,
       );
 
-      const arrayText = toArgumentText(
-        // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+      const arrayText = getArgumentText(
+        sourceCode, // eslint-disable-next-line total-functions/no-unsafe-type-assertion
         (call.callee as TSESTree.MemberExpression).object,
-        sourceCode,
       );
 
       // A node's text never includes the parentheses the source put around it:
@@ -358,7 +359,7 @@ export const preferArrScan: TSESLint.RuleModule<MessageIds, Options> = {
           ? `(${elementText})`
           : elementText;
 
-      return `Arr.scan(${arrayText}, (${parameterText}) => ${bodyText}, ${toArgumentText(seed, sourceCode)})`;
+      return `Arr.scan(${arrayText}, (${parameterText}) => ${bodyText}, ${getArgumentText(sourceCode, seed)})`;
     };
 
     /**
@@ -493,7 +494,8 @@ export const preferArrScan: TSESLint.RuleModule<MessageIds, Options> = {
       // been seen by the time its `map` is judged, whichever order the traversal
       // reached them in.
       'Program:exit': () => {
-        const hasArrImport = getNamedImports(tsDataForgeImport).includes('Arr');
+        const hasArrImport =
+          getNamedImports(tsDataForgeImports).includes('Arr');
 
         // The import is inserted once per pass: two fixes writing the same
         // insertion point would otherwise produce it twice.
@@ -514,9 +516,12 @@ export const preferArrScan: TSESLint.RuleModule<MessageIds, Options> = {
                 ? undefined
                 : (fixer) => [
                     ...(call === mut_importNeededBy
-                      ? buildImportFixes(fixer, program, tsDataForgeImport, [
-                          'Arr',
-                        ])
+                      ? buildNamedImportFix(
+                          fixer,
+                          program,
+                          TS_DATA_FORGE_MODULE,
+                          ['Arr'],
+                        )
                       : []),
                     fixer.replaceText(call, replacement),
                   ],

package/src/rules/prefer-arr-sum.mts

@@ -3,18 +3,17 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import { Arr, pipe } from 'ts-data-forge';
-import type { TypeReference } from 'typescript';
 import {
+  buildNamedImportFix,
+  getArgumentText,
+  getImportDeclarations,
+  getNamedImports,
   skipTypeWrappers,
-  toArgumentText,
   typeWrapperLayers,
-} from './ast-utils.mjs';
-import {
-  buildImportFixes,
-  getNamedImports,
-  getTsDataForgeImport,
-} from './import-utils.mjs';
+} from 'eslint-rule-forge';
+import { Arr, pipe } from 'ts-data-forge';
+import type { TypeReference } from 'typescript';
+import { TS_DATA_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -41,7 +40,10 @@ export const preferArrSum: TSESLint.RuleModule<MessageIds, Options> = {
 
     const program = sourceCode.ast;
 
-    const tsDataForgeImport = getTsDataForgeImport(program);
+    const tsDataForgeImports = getImportDeclarations(
+      program,
+      TS_DATA_FORGE_MODULE,
+    );
 
     const services = context.sourceCode.parserServices;
 
@@ -264,14 +266,14 @@ export const preferArrSum: TSESLint.RuleModule<MessageIds, Options> = {
         }
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsDataForgeImport);
+        const namedImports = getNamedImports(tsDataForgeImports);
 
         const hasArrImport = namedImports.includes('Arr');
 
         for (const [index, nodeInfo] of mut_nodesToFix.entries()) {
-          const arrayText = toArgumentText(
-            nodeInfo.arrayExpression,
+          const arrayText = getArgumentText(
             sourceCode,
+            nodeInfo.arrayExpression,
           );
 
           context.report({
@@ -289,7 +291,9 @@ export const preferArrSum: TSESLint.RuleModule<MessageIds, Options> = {
 
               const importFixes =
                 index === 0 && !hasArrImport
-                  ? buildImportFixes(fixer, program, tsDataForgeImport, ['Arr'])
+                  ? buildNamedImportFix(fixer, program, TS_DATA_FORGE_MODULE, [
+                      'Arr',
+                    ])
                   : [];
 
               return [