@noahnu/unused-files 0.0.2 → 0.1.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!-- MONOWEAVE:BELOW -->
 
+## @noahnu/unused-files (v0.1.0) <a name="0.1.0"></a>
+
+Support custom resolvers.
+
+
+
 ## @noahnu/unused-files (v0.0.2) <a name="0.0.2"></a>
 
 Update ESLint config and plugins to ESLint v9.

package/README.md

@@ -17,9 +17,14 @@ const result = await findUnusedFiles({
     // optional
     sourceDirectories: [process.cwd()],
     ignorePatterns: ['**/node_modules'],
-    aliases: {
-        '@my/alias': 'path/to/file/index.ts',
-    },
+    resolvers: [
+        async ({ request, context }) => {
+            if (request === '@my/alias') {
+                return { result: 'path/to/file/index.ts' }
+            }
+            return null;
+        }
+    ],
     depth: 10,
 })
 

package/lib/api/index.d.ts

@@ -1,3 +1,5 @@
+import { type Resolver } from './types';
+export type { Resolver, ResolverResult, ResolverParams } from './types';
 export interface FindUnusedFilesOptions {
     /**
      * Entry files into the codebase. These files are known to be used and any files that
@@ -14,10 +16,11 @@ export interface FindUnusedFilesOptions {
      */
     ignorePatterns?: string[];
     /**
-     * Custom aliases that are consulted first before attempting to resolve the import path.
-     * It is recommended to rely on package.json aliases over these custom ones.
+     * Custom resolver to use to resolve an import path relative to a source file.
+     * It is recommended to rely on package.json aliases over these custom ones
+     * when possible.
      */
-    aliases?: Partial<Record<string, string>>;
+    resolvers?: Resolver[];
     /**
      * Maximum depth to traverse. -1 can be used to disable the depth limit (the default).
      */
@@ -25,6 +28,7 @@ export interface FindUnusedFilesOptions {
     cwd?: string;
 }
 export interface UnusedFilesResult {
-    unusedFiles: string[];
+    used: string[];
+    unused: string[];
 }
-export declare function findUnusedFiles({ entryFiles, ignorePatterns, sourceDirectories, aliases, depth, cwd, }: FindUnusedFilesOptions): Promise<UnusedFilesResult>;
+export declare function findUnusedFiles({ entryFiles, ignorePatterns, sourceDirectories, resolvers, depth, cwd, }: FindUnusedFilesOptions): Promise<UnusedFilesResult>;

package/lib/api/index.js

@@ -10,7 +10,7 @@ const debug_1 = __importDefault(require("debug"));
 const fast_glob_1 = __importDefault(require("fast-glob"));
 const walkDependencyTree_1 = require("./walkDependencyTree");
 const debug = (0, debug_1.default)('unused-files');
-async function findUnusedFiles({ entryFiles, ignorePatterns = ['**/node_modules'], sourceDirectories = [], aliases, depth, cwd = process.cwd(), }) {
+async function findUnusedFiles({ entryFiles, ignorePatterns = ['**/node_modules'], sourceDirectories = [], resolvers, depth, cwd = process.cwd(), }) {
     cwd = await node_fs_1.default.promises.realpath(cwd);
     const globFromSource = async (source) => {
         const files = await fast_glob_1.default.glob(fast_glob_1.default.isDynamicPattern(source) ? source : node_path_1.default.join(source, '**'), {
@@ -24,12 +24,14 @@ async function findUnusedFiles({ entryFiles, ignorePatterns = ['**/node_modules'
     const sourceDirs = sourceDirectories.length > 0 ? sourceDirectories : [cwd];
     const files = new Set([].concat(...(await Promise.all(sourceDirs.map((source) => globFromSource(source))))));
     const unvisitedFiles = new Set(files);
+    const visitedFiles = new Set();
     for (const entryFile of entryFiles) {
         const entry = await node_fs_1.default.promises.realpath(node_path_1.default.resolve(cwd, entryFile));
         unvisitedFiles.delete(entry);
         for await (const { source, dependency } of (0, walkDependencyTree_1.walkDependencyTree)(entry, {
-            aliases,
+            resolvers,
             depth,
+            visited: visitedFiles,
         })) {
             let resolvedDependency = dependency;
             if (files.has(dependency)) {
@@ -48,7 +50,10 @@ async function findUnusedFiles({ entryFiles, ignorePatterns = ['**/node_modules'
         }
     }
     return {
-        unusedFiles: Array.from(unvisitedFiles)
+        unused: Array.from(unvisitedFiles)
+            .map((abspath) => node_path_1.default.relative(cwd, abspath))
+            .sort(),
+        used: Array.from(visitedFiles)
             .map((abspath) => node_path_1.default.relative(cwd, abspath))
             .sort(),
     };

package/lib/api/types.d.ts

@@ -0,0 +1,15 @@
+export interface ResolverResult {
+    /** Resolved path. */
+    result: string;
+}
+export interface ResolverParams {
+    /** The module/path being requested. */
+    request: string;
+    /** The file or directory to resolve the request from. */
+    context: string;
+}
+/**
+ * Used to resolve imports to the absolute path of the file.
+ * Return 'null' if unable to resolve and we will attempt the next resolver in the chain.
+ */
+export type Resolver = (params: ResolverParams) => Promise<ResolverResult | null>;

package/lib/api/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/api/walkDependencyTree.d.ts

@@ -1,5 +1,6 @@
-export declare function walkDependencyTree(source: string, { aliases, visited, depth, }?: {
-    aliases?: Partial<Record<string, string>>;
+import { type Resolver } from './types';
+export declare function walkDependencyTree(source: string, { resolvers, visited, depth, }?: {
+    resolvers?: Resolver[];
     visited?: Set<string>;
     depth?: number;
 }): AsyncGenerator<{

package/lib/api/walkDependencyTree.js

@@ -10,8 +10,8 @@ const typescript_estree_1 = require("@typescript-eslint/typescript-estree");
 const debug_1 = __importDefault(require("debug"));
 const debug = (0, debug_1.default)('unused-files:parse');
 const DEFAULT_DEPTH_LIMIT = -1; // no depth limit
-const VALID_EXTENSIONS = new Set(['ts', 'tsx', 'mts', 'cts', 'js', 'mjs', 'cjs']);
-async function* walkDependencyTree(source, { aliases, visited, depth = DEFAULT_DEPTH_LIMIT, } = {}) {
+const VALID_EXTENSIONS = new Set(['ts', 'tsx', 'mts', 'cts', 'js', 'jsx', 'mjs', 'cjs']);
+async function* walkDependencyTree(source, { resolvers, visited, depth = DEFAULT_DEPTH_LIMIT, } = {}) {
     const ext = node_path_1.default.extname(source).substring(1);
     if (!VALID_EXTENSIONS.has(ext)) {
         debug(`${source}: Unknown file extension '${ext}' [skipping]`);
@@ -59,6 +59,11 @@ async function* walkDependencyTree(source, { aliases, visited, depth = DEFAULT_D
                         importFroms.add(node.source.value);
                     }
                 }
+                else if (node.source.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.TemplateLiteral &&
+                    !node.source.expressions.length &&
+                    node.source.quasis.length === 1) {
+                    importFroms.add(node.source.quasis[0].value.cooked);
+                }
                 else {
                     debug(`${source}: Dynamic import expression found at ${node.loc.start}:${node.loc.end}`);
                 }
@@ -68,10 +73,12 @@ async function* walkDependencyTree(source, { aliases, visited, depth = DEFAULT_D
     for (const body of ast.body) {
         (0, typescript_estree_1.simpleTraverse)(body, { visitors });
     }
-    const resolveToAbsPath = (request) => {
-        const aliasedPath = aliases?.[request];
-        if (aliasedPath) {
-            return node_path_1.default.resolve(aliasedPath);
+    const resolveToAbsPath = async (request) => {
+        for (const resolver of resolvers ?? []) {
+            const resolution = await resolver({ context: source, request });
+            if (resolution) {
+                return node_path_1.default.resolve(resolution.result);
+            }
         }
         try {
             return require.resolve(request, { paths: [node_path_1.default.dirname(source)] });
@@ -80,12 +87,12 @@ async function* walkDependencyTree(source, { aliases, visited, depth = DEFAULT_D
         return undefined;
     };
     for (const importFrom of Array.from(importFroms)) {
-        const absPath = resolveToAbsPath(importFrom);
+        const absPath = await resolveToAbsPath(importFrom);
         if (absPath) {
             yield { dependency: absPath, source };
             if (depth === -1 || depth > 0) {
                 yield* walkDependencyTree(absPath, {
-                    aliases,
+                    resolvers,
                     visited: visitedSet,
                     depth: depth === -1 ? depth : depth - 1,
                 });

package/lib/command.js

@@ -57,7 +57,7 @@ class BaseCommand extends clipanion_1.Command {
                 ? -1
                 : parseInt(Math.max(this.depth, -1).toFixed(0), 10),
         });
-        this.context.stdout.write(result.unusedFiles.join('\n'));
+        this.context.stdout.write(result.unused.join('\n'));
     }
 }
 exports.BaseCommand = BaseCommand;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noahnu/unused-files",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/noahnu/nodejs-tools.git",