eslint-plugin-ts-std-forge 0.1.7 → 0.1.9

package/src/rules/prefer-safe-array-length-guard.test.mts

@@ -168,6 +168,20 @@ describe('prefer-safe-array-length-guard through type wrappers', () => {
           const ok = xs.length > (2 as const);
         `,
       },
+      {
+        name: 'an array widened by `as` to one that may be a string',
+        code: dedent`
+          declare const xs: readonly string[];
+          const ok = (xs as readonly string[] | string).length > 0;
+        `,
+      },
+      {
+        name: '`!` on an optional array, which leaves undefined in place',
+        code: dedent`
+          declare const xs: readonly number[] | undefined;
+          const ok = xs!.length !== 0;
+        `,
+      },
     ],
     invalid: [
       {
@@ -210,15 +224,15 @@ describe('prefer-safe-array-length-guard through type wrappers', () => {
         errors: [{ messageId: 'useIsEmpty' }],
       },
       {
-        name: 'keeps a wrapper on the array and reads `!` as the array it asserts',
+        name: 'keeps a wrapper on an array that is an array at every layer',
         code: dedent`
-          declare const xs: readonly number[] | undefined;
-          const ok = xs!.length !== 0;
+          declare const xs: readonly number[];
+          const ok = (xs! as readonly number[]).length !== 0;
         `,
         output: dedent`
           import { SafeArray } from 'ts-std-forge';
-          declare const xs: readonly number[] | undefined;
-          const ok = SafeArray.isNonEmpty(xs!);
+          declare const xs: readonly number[];
+          const ok = SafeArray.isNonEmpty(xs! as readonly number[]);
         `,
         errors: [{ messageId: 'useIsNonEmpty' }],
       },

package/src/rules/prefer-safe-number-parse-integer.mts

@@ -3,18 +3,16 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import * as ts from 'typescript';
 import {
+  buildNamedImportFix,
   getArgumentText,
-  getValueType,
-  isIdentifierNamed,
-  skipTypeWrappers,
-} from './ast-utils.mjs';
-import {
-  buildImportFixes,
+  getImportDeclarations,
   getNamedImports,
-  getTsStdForgeImport,
-} from './import-utils.mjs';
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
+import * as ts from 'typescript';
+import { isIdentifierNamed, typeHoldsAtEveryLayer } from './ast-utils.mjs';
+import { TS_STD_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -66,7 +64,10 @@ export const preferSafeNumberParseInteger: TSESLint.RuleModule<
 
     const program = sourceCode.ast;
 
-    const tsStdForgeImport = getTsStdForgeImport(program);
+    const tsStdForgeImports = getImportDeclarations(
+      program,
+      TS_STD_FORGE_MODULE,
+    );
 
     const mut_nodesToFix: {
       node: TSESTree.CallExpression;
@@ -117,20 +118,20 @@ export const preferSafeNumberParseInteger: TSESLint.RuleModule<
           }
         }
 
-        // The argument must be a `string` so the autofix is type-safe against
-        // `SafeNumber.parseInteger(value: string)`, and that of the value, not
-        // of a cast: `parseInt(1e21 as unknown as string)` is 1, the rewrite
-        // 1e21. Without type information, skip.
-        const argType = getValueType(sourceCode, firstArg);
-
-        if (argType === undefined || !isStringType(argType)) {
+        // The argument must be a `string` at every layer of type wrappers:
+        // the value's own type is what `parseInt` sees at run time
+        // (`parseInt(1e21 as unknown as string)` is 1, the rewrite 1e21), and
+        // the type a wrapper states is what the fix, which keeps the wrapper,
+        // hands `SafeNumber.parseInteger(value: string)`. Without type
+        // information, skip.
+        if (!typeHoldsAtEveryLayer(sourceCode, firstArg, isStringType)) {
           return;
         }
 
         mut_nodesToFix.push({ node, argExpression: firstArg });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsStdForgeImport);
+        const namedImports = getNamedImports(tsStdForgeImports);
 
         const missingImports = (['Result', 'SafeNumber'] as const).filter(
           (name) => !namedImports.includes(name),
@@ -154,7 +155,12 @@ export const preferSafeNumberParseInteger: TSESLint.RuleModule<
 
               const importFixes =
                 index === 0 && missingImports.length > 0
-                  ? buildImportFixes(fixer, program, missingImports)
+                  ? buildNamedImportFix(
+                      fixer,
+                      program,
+                      TS_STD_FORGE_MODULE,
+                      missingImports,
+                    )
                   : [];
 
               return [...importFixes, fixer.replaceText(node, core)];

package/src/rules/prefer-safe-number-parse-integer.test.mts

@@ -84,6 +84,20 @@ describe('prefer-safe-number-parse-integer through type wrappers', () => {
           const n = parseInt(s, 16 as const);
         `,
       },
+      {
+        name: 'ignores a string widened by `as` to one that may be a number',
+        code: dedent`
+          declare const s: string;
+          const n = parseInt(s as string | number as string);
+        `,
+      },
+      {
+        name: 'ignores `!` on an optional string, which leaves undefined in place',
+        code: dedent`
+          declare const s: string | undefined;
+          const n = parseInt(s!);
+        `,
+      },
     ],
     invalid: [
       {
@@ -131,15 +145,15 @@ describe('prefer-safe-number-parse-integer through type wrappers', () => {
         ],
       },
       {
-        name: 'reads `!` on an optional string as the string it asserts',
+        name: 'rewrites a string that is a string at every layer',
         code: dedent`
-          declare const s: string | undefined;
-          const n = parseInt(s!);
+          declare const s: string;
+          const n = parseInt(s! as string);
         `,
         output: dedent`
           import { Result, SafeNumber } from 'ts-std-forge';
-          declare const s: string | undefined;
-          const n = Result.unwrapOkOr(SafeNumber.parseInteger(s!), Number.NaN);
+          declare const s: string;
+          const n = Result.unwrapOkOr(SafeNumber.parseInteger(s! as string), Number.NaN);
         `,
         errors: [{ messageId: 'useSafeNumberParseInteger' }],
       },

package/src/rules/prefer-safe-number-parse.mts

@@ -3,18 +3,16 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import * as ts from 'typescript';
 import {
+  buildNamedImportFix,
   getArgumentText,
-  getValueType,
-  isIdentifierNamed,
-  skipTypeWrappers,
-} from './ast-utils.mjs';
-import {
-  buildImportFixes,
+  getImportDeclarations,
   getNamedImports,
-  getTsStdForgeImport,
-} from './import-utils.mjs';
+  skipTypeWrappers,
+} from 'eslint-rule-forge';
+import * as ts from 'typescript';
+import { isIdentifierNamed, typeHoldsAtEveryLayer } from './ast-utils.mjs';
+import { TS_STD_FORGE_MODULE } from './constants.mjs';
 
 type Options = readonly [];
 
@@ -69,7 +67,10 @@ export const preferSafeNumberParse: TSESLint.RuleModule<MessageIds, Options> = {
 
     const program = sourceCode.ast;
 
-    const tsStdForgeImport = getTsStdForgeImport(program);
+    const tsStdForgeImports = getImportDeclarations(
+      program,
+      TS_STD_FORGE_MODULE,
+    );
 
     const mut_nodesToFix: {
       node: TSESTree.CallExpression;
@@ -114,20 +115,20 @@ export const preferSafeNumberParse: TSESLint.RuleModule<MessageIds, Options> = {
           return;
         }
 
-        // The argument must be purely `string` so the autofix is type-safe
-        // against `SafeNumber.parse(value: string)`, and that of the value, not
-        // of a cast: `Number(true as unknown as string)` is 1, the rewrite NaN.
-        // Without type information, skip.
-        const argType = getValueType(sourceCode, firstArg);
-
-        if (argType === undefined || !isStringType(argType)) {
+        // The argument must be purely `string` at every layer of type
+        // wrappers: the value's own type is what `Number` sees at run time
+        // (`Number(true as unknown as string)` is 1, the rewrite NaN), and the
+        // type a wrapper states is what the fix, which keeps the wrapper,
+        // hands `SafeNumber.parse(value: string)`. Without type information,
+        // skip.
+        if (!typeHoldsAtEveryLayer(sourceCode, firstArg, isStringType)) {
           return;
         }
 
         mut_nodesToFix.push({ node, argExpression: firstArg });
       },
       'Program:exit': () => {
-        const namedImports = getNamedImports(tsStdForgeImport);
+        const namedImports = getNamedImports(tsStdForgeImports);
 
         const missingImports = (['Result', 'SafeNumber'] as const).filter(
           (name) => !namedImports.includes(name),
@@ -151,7 +152,12 @@ export const preferSafeNumberParse: TSESLint.RuleModule<MessageIds, Options> = {
 
               const importFixes =
                 index === 0 && missingImports.length > 0
-                  ? buildImportFixes(fixer, program, missingImports)
+                  ? buildNamedImportFix(
+                      fixer,
+                      program,
+                      TS_STD_FORGE_MODULE,
+                      missingImports,
+                    )
                   : [];
 
               return [...importFixes, fixer.replaceText(node, core)];

package/src/rules/prefer-safe-number-parse.test.mts

@@ -132,6 +132,20 @@ describe('prefer-safe-number-parse through type wrappers', () => {
           const n = parseFloat(x! as string);
         `,
       },
+      {
+        name: 'ignores a string widened by `as` to a type Number() reads otherwise',
+        code: dedent`
+          declare const s: string;
+          const n = Number(s as string | boolean);
+        `,
+      },
+      {
+        name: 'ignores `!` on an optional string, which leaves undefined in place',
+        code: dedent`
+          declare const s: string | undefined;
+          const n = parseFloat(s!);
+        `,
+      },
     ],
     invalid: [
       {
@@ -166,15 +180,15 @@ describe('prefer-safe-number-parse through type wrappers', () => {
         ],
       },
       {
-        name: 'reads `!` on an optional string as the string it asserts',
+        name: 'rewrites a string that is a string at every layer',
         code: dedent`
-          declare const s: string | undefined;
-          const n = parseFloat(s!);
+          declare const s: string;
+          const n = parseFloat(s! as string);
         `,
         output: dedent`
           import { Result, SafeNumber } from 'ts-std-forge';
-          declare const s: string | undefined;
-          const n = Result.unwrapOkOr(SafeNumber.parse(s!), Number.NaN);
+          declare const s: string;
+          const n = Result.unwrapOkOr(SafeNumber.parse(s! as string), Number.NaN);
         `,
         errors: [{ messageId: 'useSafeNumberParse' }],
       },

package/dist/rules/import-utils.d.mts

@@ -1,6 +0,0 @@
-import { type TSESLint, type TSESTree } from '@typescript-eslint/utils';
-import type { DeepReadonly } from 'ts-type-forge';
-export declare const getTsStdForgeImport: (program: TSESTree.Program) => TSESTree.ImportDeclaration | undefined;
-export declare const getNamedImports: (node: DeepReadonly<TSESTree.ImportDeclaration> | undefined) => readonly string[];
-export declare const buildImportFixes: (fixer: TSESLint.RuleFixer, program: TSESTree.Program, requiredNames: readonly string[]) => readonly TSESLint.RuleFix[];
-//# sourceMappingURL=import-utils.d.mts.map

package/dist/rules/import-utils.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"import-utils.d.mts","sourceRoot":"","sources":["../../src/rules/import-utils.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,QAAQ,EACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAKlD,eAAO,MAAM,mBAAmB,YACrB,QAAQ,CAAC,OAAO,KACxB,QAAQ,CAAC,iBAAiB,GAAG,SAK7B,CAAC;AAEJ,eAAO,MAAM,eAAe,SACpB,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,SAAS,KACzD,SAAS,MAAM,EAiBjB,CAAC;AAEF,eAAO,MAAM,gBAAgB,UACpB,QAAQ,CAAC,SAAS,WAChB,QAAQ,CAAC,OAAO,iBACV,SAAS,MAAM,EAAE,KAC/B,SAAS,QAAQ,CAAC,OAAO,EAa3B,CAAC"}

package/dist/rules/import-utils.mjs

@@ -1,28 +0,0 @@
-import { AST_NODE_TYPES, } from '@typescript-eslint/utils';
-import { TS_STD_FORGE_MODULE } from './constants.mjs';
-
-export const getTsStdForgeImport = (program) => program.body.find((node) => node.type === AST_NODE_TYPES.ImportDeclaration &&
-    node.source.value === TS_STD_FORGE_MODULE);
-export const getNamedImports = (node) => {
-    if (node === undefined) {
-        return [];
-    }
-    return node.specifiers.flatMap((specifier) => specifier.type === AST_NODE_TYPES.ImportSpecifier
-        ? (() => {
-            const importedName = specifier.imported.type === AST_NODE_TYPES.Identifier
-                ? specifier.imported.name
-                : specifier.imported.value;
-            return typeof importedName === 'string' ? [importedName] : [];
-        })()
-        : []);
-};
-export const buildImportFixes = (fixer, program, requiredNames) => {
-    const specifierText = requiredNames.join(', ');
-    const importStatement = `import { ${specifierText} } from '${TS_STD_FORGE_MODULE}';`;
-    const newLine = '\n';
-    const insertionText = `${importStatement}${newLine}`;
-
-
-    return [fixer.insertTextBefore(program, insertionText)];
-};
-//# sourceMappingURL=import-utils.mjs.map

package/dist/rules/import-utils.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"import-utils.mjs","sourceRoot":"","sources":["../../src/rules/import-utils.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,uEAAuE;AAEvE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAAyB,EACe,EAAE,CAC1C,OAAO,CAAC,IAAI,CAAC,IAAI,CACf,CAAC,IAAI,EAAsC,EAAE,CAC3C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,mBAAmB,CAC5C,CAAC;AAEJ,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,IAA0D,EACvC,EAAE;IACrB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAC3C,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;QAC/C,CAAC,CAAC,CAAC,GAAG,EAAE;YACJ,MAAM,YAAY,GAChB,SAAS,CAAC,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;gBACnD,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI;gBACzB,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;YAE/B,OAAO,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChE,CAAC,CAAC,EAAE;QACN,CAAC,CAAC,EAAE,CACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,KAAyB,EACzB,OAAyB,EACzB,aAAgC,EACH,EAAE;IAC/B,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE/C,MAAM,eAAe,GACnB,YAAY,aAAa,YAAY,mBAAmB,IAAa,CAAC;IAExE,MAAM,OAAO,GAAG,IAAI,CAAC;IAErB,MAAM,aAAa,GAAG,GAAG,eAAe,GAAG,OAAO,EAAW,CAAC;IAE9D,6CAA6C;IAC7C,uDAAuD;IACvD,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;AAC1D,CAAC,CAAC"}

package/src/rules/import-utils.mts

@@ -1,58 +0,0 @@
-import {
-  AST_NODE_TYPES,
-  type TSESLint,
-  type TSESTree,
-} from '@typescript-eslint/utils';
-import type { DeepReadonly } from 'ts-type-forge';
-import { TS_STD_FORGE_MODULE } from './constants.mjs';
-
-/* eslint-disable @typescript-eslint/prefer-readonly-parameter-types */
-
-export const getTsStdForgeImport = (
-  program: TSESTree.Program,
-): TSESTree.ImportDeclaration | undefined =>
-  program.body.find(
-    (node): node is TSESTree.ImportDeclaration =>
-      node.type === AST_NODE_TYPES.ImportDeclaration &&
-      node.source.value === TS_STD_FORGE_MODULE,
-  );
-
-export const getNamedImports = (
-  node: DeepReadonly<TSESTree.ImportDeclaration> | undefined,
-): readonly string[] => {
-  if (node === undefined) {
-    return [];
-  }
-
-  return node.specifiers.flatMap((specifier) =>
-    specifier.type === AST_NODE_TYPES.ImportSpecifier
-      ? (() => {
-          const importedName =
-            specifier.imported.type === AST_NODE_TYPES.Identifier
-              ? specifier.imported.name
-              : specifier.imported.value;
-
-          return typeof importedName === 'string' ? [importedName] : [];
-        })()
-      : [],
-  );
-};
-
-export const buildImportFixes = (
-  fixer: TSESLint.RuleFixer,
-  program: TSESTree.Program,
-  requiredNames: readonly string[],
-): readonly TSESLint.RuleFix[] => {
-  const specifierText = requiredNames.join(', ');
-
-  const importStatement =
-    `import { ${specifierText} } from '${TS_STD_FORGE_MODULE}';` as const;
-
-  const newLine = '\n';
-
-  const insertionText = `${importStatement}${newLine}` as const;
-
-  // Always insert at the beginning of the file
-  // (organize-imports will handle merging/deduplication)
-  return [fixer.insertTextBefore(program, insertionText)];
-};