refactor: use strictest typescript configuration

Author: danielpza

package.json

@@ -62,6 +62,7 @@
   "devDependencies": {
     "@eslint/js": "^9.8.0",
     "@tsconfig/node18": "^18.2.4",
+    "@tsconfig/strictest": "^2.0.5",
     "@types/eslint": "^9",
     "@types/minimatch": "^5.1.2",
     "@types/node": "^22.2.0",

src/harmony/versions/four-seven.ts

@@ -49,7 +49,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateImportDeclaration":
       return function (
         node: ImportDeclaration,
-        modifiers: readonly Modifier[] | undefined,
+        _modifiers: readonly Modifier[] | undefined,
         importClause: ImportClause | undefined,
         moduleSpecifier: Expression,
         assertClause: AssertClause | undefined,
@@ -73,7 +73,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateExportDeclaration":
       return function (
         node: ExportDeclaration,
-        modifiers: readonly Modifier[] | undefined,
+        _modifiers: readonly Modifier[] | undefined,
         isTypeOnly: boolean,
         exportClause: NamedExportBindings | undefined,
         moduleSpecifier: Expression | undefined,
@@ -99,7 +99,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateModuleDeclaration":
       return function (
         node: ModuleDeclaration,
-        modifiers: readonly Modifier[] | undefined,
+        _modifiers: readonly Modifier[] | undefined,
         name: ModuleName,
         body: ModuleBody | undefined,
       ) {

src/harmony/versions/three-eight.ts

@@ -70,7 +70,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateImportClause":
       return function (
         node: ImportClause,
-        isTypeOnly: boolean,
+        _isTypeOnly: boolean,
         name: Identifier | undefined,
         namedBindings: NamedImportBindings | undefined,
       ) {
@@ -80,7 +80,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateImportDeclaration":
       return function (
         node: ImportDeclaration,
-        modifiers: readonly Modifier[] | undefined,
+        _modifiers: readonly Modifier[] | undefined,
         importClause: ImportClause | undefined,
         moduleSpecifier: Expression,
       ) {
@@ -97,8 +97,8 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateExportDeclaration":
       return function (
         node: ExportDeclaration,
-        modifiers: readonly Modifier[] | undefined,
-        isTypeOnly: boolean,
+        _modifiers: readonly Modifier[] | undefined,
+        _isTypeOnly: boolean,
         exportClause: NamedExportBindings | undefined,
         moduleSpecifier: Expression | undefined,
       ) {
@@ -115,7 +115,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
     case "updateModuleDeclaration":
       return function (
         node: ModuleDeclaration,
-        modifiers: readonly Modifier[] | undefined,
+        _modifiers: readonly Modifier[] | undefined,
         name: ModuleName,
         body: ModuleBody | undefined,
       ) {
@@ -127,7 +127,7 @@ export function handler(context: TsTransformPathsContext, prop: string | symbol)
       return function (
         node: ImportTypeNode,
         argument: TypeNode,
-        assertions: ImportTypeAssertionContainer | undefined,
+        _assertions: ImportTypeAssertionContainer | undefined,
         qualifier: EntityName | undefined,
         typeArguments: readonly TypeNode[] | undefined,
         isTypeOf?: boolean,

src/index.ts

@@ -1,6 +1,6 @@
 import transformer from "./transformer";
 export default transformer;
 
-export { TsTransformPathsConfig } from "./types";
+export type { TsTransformPathsConfig } from "./types";
 export { register } from "./register";
 export { nxTransformerPlugin } from "./plugins";

src/register.ts

@@ -1,4 +1,4 @@
-import type TSNode from "ts-node";
+import TSNode from "ts-node";
 import type { REGISTER_INSTANCE } from "ts-node";
 import ts from "typescript";
 import transformer from "./transformer";
@@ -7,11 +7,18 @@ import transformer from "./transformer";
 // region: Helpers
 /* ****************************************************************************************************************** */
 
+type PluginExtended = ts.PluginImport & {
+  transform?: string;
+  after?: boolean;
+  before?: boolean;
+  afterDeclarations?: boolean;
+};
+
 function getProjectTransformerConfig(pcl: ts.ParsedCommandLine) {
-  const plugins = pcl.options.plugins as Record<string, string>[] | undefined;
+  const plugins = pcl.options.plugins as PluginExtended[];
   if (!plugins) return;
 
-  const res: { afterDeclarations?: Record<string, string>; before?: Record<string, string> } = {};
+  const res: { afterDeclarations?: PluginExtended; before?: PluginExtended } = {};
   for (const plugin of plugins) {
     if (plugin.transform === "typescript-transform-paths" && !plugin.after)
       res[plugin.afterDeclarations ? "afterDeclarations" : "before"] = plugin;
@@ -22,8 +29,8 @@ function getProjectTransformerConfig(pcl: ts.ParsedCommandLine) {
 
 function getTransformers(
   program?: ts.Program,
-  beforeConfig?: Record<string, string>,
-  afterDeclarationsConfig?: Record<string, string>,
+  beforeConfig?: PluginExtended,
+  afterDeclarationsConfig?: PluginExtended,
 ): ts.CustomTransformers {
   return {
     ...(beforeConfig && { before: [transformer(program, beforeConfig)] }),

src/transformer.ts

@@ -7,10 +7,6 @@ import { Minimatch } from "minimatch";
 import { createSyntheticEmitHost, getTsNodeRegistrationProperties } from "./utils/ts-helpers";
 import { TransformerExtras } from "ts-patch";
 
-/* ****************************************************************************************************************** */
-// region: Helpers
-/* ****************************************************************************************************************** */
-
 function getTsProperties(args: Parameters<typeof transformer>) {
   let fileNames: readonly string[] | undefined;
   let compilerOptions: CompilerOptions;
@@ -69,12 +65,6 @@ function getTsProperties(args: Parameters<typeof transformer>) {
   return { tsInstance, compilerOptions, fileNames, runMode, tsNodeState };
 }
 
-// endregion
-
-/* ****************************************************************************************************************** */
-// region: Transformer
-/* ****************************************************************************************************************** */
-
 export default function transformer(
   program?: ts.Program,
   pluginConfig?: TsTransformPathsConfig,
@@ -114,6 +104,8 @@ export default function transformer(
     const { tryParsePatterns } = tsInstance;
     const [tsVersionMajor, tsVersionMinor] = tsInstance.versionMajorMinor.split(".").map((v) => +v);
 
+    if (!tsVersionMajor || !tsVersionMinor) throw new Error("Expected version to be parsed");
+
     const tsTransformPathsContext: TsTransformPathsContext = {
       compilerOptions,
       config,
@@ -154,5 +146,3 @@ export default function transformer(
     };
   };
 }
-
-// endregion

src/utils/elide-import-export.ts

@@ -131,7 +131,7 @@ export function elideImportOrExportDeclaration(
     }
 
     const allowEmpty =
-      !!compilerOptions.verbatimModuleSyntax ||
+      !!compilerOptions["verbatimModuleSyntax"] ||
       (!!node.moduleSpecifier &&
         (compilerOptions.importsNotUsedAsValues === ImportsNotUsedAsValues.Preserve ||
           compilerOptions.importsNotUsedAsValues === ImportsNotUsedAsValues.Error));
@@ -187,7 +187,7 @@ export function elideImportOrExportDeclaration(
     } else {
       // Elide named imports if all of its import specifiers are elided.
       const allowEmpty =
-        compilerOptions.verbatimModuleSyntax ||
+        compilerOptions["verbatimModuleSyntax"] ||
         (compilerOptions.preserveValueImports &&
           (compilerOptions.importsNotUsedAsValues === ImportsNotUsedAsValues.Preserve ||
             compilerOptions.importsNotUsedAsValues === ImportsNotUsedAsValues.Error));
@@ -234,14 +234,14 @@ export function elideImportOrExportDeclaration(
    */
   function visitExportSpecifier(node: ExportSpecifier): VisitResult<ExportSpecifier> {
     // Elide an export specifier if it does not reference a value.
-    return !node.isTypeOnly && (compilerOptions.verbatimModuleSyntax || resolver.isValueAliasDeclaration(node))
+    return !node.isTypeOnly && (compilerOptions["verbatimModuleSyntax"] || resolver.isValueAliasDeclaration(node))
       ? node
       : undefined;
   }
 
   function shouldEmitAliasDeclaration(node: Node): boolean {
     return (
-      !!compilerOptions.verbatimModuleSyntax ||
+      !!compilerOptions["verbatimModuleSyntax"] ||
       isInJSFile(node) ||
       (compilerOptions.preserveValueImports
         ? resolver.isValueAliasDeclaration(node)

src/utils/general-utils.ts

@@ -5,7 +5,7 @@ import path from "path";
  * General Utilities & Helpers
  * ****************************************************************************************************************** */
 
-export const isURL = (s: string): boolean => !!s && (!!url.parse(s).host || !!url.parse(s).hostname);
+export const isURL = (s: string | undefined): s is string => !!s && (!!url.parse(s).host || !!url.parse(s).hostname);
 
 export const isBaseDir = (baseDir: string, testDir: string): boolean => {
   const relative = path.relative(baseDir, testDir);

src/utils/resolve-module-name.ts

@@ -5,10 +5,6 @@ import { removeFileExtension, removeSuffix, ResolvedModuleFull, SourceFile } fro
 import { getOutputDirForSourceFile } from "./ts-helpers";
 import { getRelativePath } from "./get-relative-path";
 
-/* ****************************************************************************************************************** */
-// region: Types
-/* ****************************************************************************************************************** */
-
 export interface ResolvedModule {
   /** Absolute path to resolved module */
   resolvedPath: string | undefined;
@@ -25,12 +21,6 @@ enum IndexType {
   ImplicitPackage,
 }
 
-// endregion
-
-/* ****************************************************************************************************************** */
-// region: Helpers
-/* ****************************************************************************************************************** */
-
 function getPathDetail(moduleName: string, resolvedModule: ResolvedModuleFull) {
   const resolvedFileName = resolvedModule.originalPath ?? resolvedModule.resolvedFileName;
   const implicitPackageIndex = resolvedModule.packageId?.subModuleName;
@@ -105,12 +95,6 @@ function getResolvedSourceFile(context: VisitorContext, fileName: string): Sourc
   return tsInstance.createSourceFile(fileName, ``, tsInstance.ScriptTarget.ESNext, /* setParentNodes */ false);
 }
 
-// endregion
-
-/* ****************************************************************************************************************** */
-// region: Utils
-/* ****************************************************************************************************************** */
-
 /** Resolve a module name */
 export function resolveModuleName(context: VisitorContext, moduleName: string): ResolvedModule | undefined {
   const { tsInstance, compilerOptions, sourceFile, config, rootDirs } = context;
@@ -126,10 +110,10 @@ export function resolveModuleName(context: VisitorContext, moduleName: string):
   // Handle non-resolvable module
   if (!resolvedModule) {
     const maybeURL = failedLookupLocations[0];
-    if (!isURL(maybeURL)) return void 0;
+    if (!isURL(maybeURL)) return undefined;
     return {
       isURL: true,
-      resolvedPath: void 0,
+      resolvedPath: undefined,
       outputPath: maybeURL,
     };
   }
@@ -172,5 +156,3 @@ export function resolveModuleName(context: VisitorContext, moduleName: string):
 
   return { isURL: false, outputPath, resolvedPath: resolvedFileName };
 }
-
-// endregion

src/utils/resolve-path-update-node.ts

@@ -4,10 +4,6 @@ import { isURL, maybeAddRelativeLocalPrefix } from "./general-utils";
 import { isModulePathsMatch } from "./ts-helpers";
 import { resolveModuleName } from "./resolve-module-name";
 
-/* ****************************************************************************************************************** */
-// region: Node Updater Utility
-/* ****************************************************************************************************************** */
-
 /** Gets proper path and calls updaterFn to get the new node if it should be updated */
 export function resolvePathAndUpdateNode(
   context: VisitorContext,
@@ -69,7 +65,8 @@ export function resolvePathAndUpdateNode(
         const trivia = targetNode.getFullText(sourceFile).slice(0, targetNode.getLeadingTriviaWidth(sourceFile));
         const regex = /^\s*\/\/\/?\s*@(transform-path|no-transform-path)(?:[^\S\r\n](.+?))?$/gim;
 
-        for (let match = regex.exec(trivia); match; match = regex.exec(trivia)) commentTags.set(match[1], match[2]);
+        for (let match = regex.exec(trivia); match; match = regex.exec(trivia))
+          if (match[1]) commentTags.set(match[1], match[2]);
       } catch {}
     }
 
@@ -83,7 +80,7 @@ export function resolvePathAndUpdateNode(
 
     function findTag(expected: string): boolean | string | undefined {
       if (commentTags.has(expected)) return commentTags.get(expected) || true;
-      if (!jsDocTags?.length) return void 0;
+      if (!jsDocTags?.length) return undefined;
 
       for (const tag of jsDocTags) {
         const tagName = tag.tagName.text.toLowerCase();
@@ -103,8 +100,8 @@ export function resolvePathAndUpdateNode(
             : void 0;
         }
       }
+
+      return undefined;
     }
   }
 }
-
-// endregion

src/visitor.ts

@@ -2,27 +2,21 @@ import ts from "typescript";
 import { VisitorContext } from "./types";
 import { elideImportOrExportDeclaration, resolvePathAndUpdateNode } from "./utils";
 
-/* ****************************************************************************************************************** *
- * Helpers
- * ****************************************************************************************************************** */
-
 const isAsyncImport = ({ tsInstance }: VisitorContext, node: ts.Node): node is ts.CallExpression =>
   tsInstance.isCallExpression(node) &&
   node.expression.kind === tsInstance.SyntaxKind.ImportKeyword &&
+  !!node.arguments[0] &&
   tsInstance.isStringLiteral(node.arguments[0]) &&
   node.arguments.length === 1;
 
 const isRequire = ({ tsInstance }: VisitorContext, node: ts.Node): node is ts.CallExpression =>
   tsInstance.isCallExpression(node) &&
   tsInstance.isIdentifier(node.expression) &&
   node.expression.text === "require" &&
+  !!node.arguments[0] &&
   tsInstance.isStringLiteral(node.arguments[0]) &&
   node.arguments.length === 1;
 
-/* ****************************************************************************************************************** *
- * Node Visitor
- * ****************************************************************************************************************** */
-
 /** Visit and replace nodes with module specifiers */
 export function nodeVisitor(this: VisitorContext, node: ts.Node): ts.Node | undefined {
   const { factory, tsInstance, transformationContext } = this;
@@ -40,7 +34,8 @@ export function nodeVisitor(this: VisitorContext, node: ts.Node): ts.Node | unde
 
       /* Handle comments */
       const textNode = node.arguments[0];
-      const commentRanges = tsInstance.getLeadingCommentRanges(textNode.getFullText(), 0) || [];
+      if (!textNode) throw new Error("Expected textNode");
+      const commentRanges = tsInstance.getLeadingCommentRanges(textNode.getFullText(), 0) ?? [];
 
       for (const range of commentRanges) {
         const { kind, pos, end, hasTrailingNewLine } = range;

tsconfig.json

@@ -1,11 +1,13 @@
 {
-  "extends": "@tsconfig/node18",
+  "extends": ["@tsconfig/strictest", "@tsconfig/node18"],
   "include": ["src"],
   "exclude": ["src/declarations"],
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",
     "declaration": true,
-    "sourceMap": true
+    "sourceMap": true,
+    // less strict
+    "exactOptionalPropertyTypes": false
   }
 }

yarn.lock

@@ -217,6 +217,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@tsconfig/strictest@npm:^2.0.5":
+  version: 2.0.5
+  resolution: "@tsconfig/strictest@npm:2.0.5"
+  checksum: 10c0/cfc86da2d57f7b4b0827701b132c37a4974284e5c40649656c0e474866dfd8a69f57c6718230d8a8139967e2a95438586b8224c13ab0ff9d3a43eda771c50cc4
+  languageName: node
+  linkType: hard
+
 "@types/debug@npm:^4.0.0":
   version: 4.1.12
   resolution: "@types/debug@npm:4.1.12"
@@ -3019,6 +3026,7 @@ __metadata:
   dependencies:
     "@eslint/js": "npm:^9.8.0"
     "@tsconfig/node18": "npm:^18.2.4"
+    "@tsconfig/strictest": "npm:^2.0.5"
     "@types/eslint": "npm:^9"
     "@types/minimatch": "npm:^5.1.2"
     "@types/node": "npm:^22.2.0"