@noahnu/unused-files 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!-- MONOWEAVE:BELOW -->
 
+## @noahnu/unused-files (v0.3.0) <a name="0.3.0"></a>
+
+Migrate to ESM.
+
+
+
+## @noahnu/unused-files (v0.2.3) <a name="0.2.3"></a>
+
+Ignore builtins.
+
+
+
 ## @noahnu/unused-files (v0.2.2) <a name="0.2.2"></a>
 
 Filter out files based on source directories.

package/lib/api/{index.d.ts → index.d.mts}

@@ -1,5 +1,5 @@
-import { type Resolver } from './types';
-export type { Resolver, ResolverResult, ResolverParams } from './types';
+import { type Resolver } from '@noahnu/dependency-utils';
+export type { Resolver, ResolverResult, ResolverParams } from '@noahnu/dependency-utils';
 export interface FindUnusedFilesOptions {
     /**
      * Entry files into the codebase. These files are known to be used and any files that

package/lib/api/index.mjs

@@ -0,0 +1,57 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { resolveRealpath, walkDependencyTree } from '@noahnu/dependency-utils';
+import createDebug from 'debug';
+import fg from 'fast-glob';
+const debug = createDebug('unused-files');
+export async function findUnusedFiles({ entryFiles, ignorePatterns = ['**/node_modules'], sourceDirectories = [], resolvers, depth, cwd = process.cwd(), }) {
+    cwd = await fs.promises.realpath(cwd);
+    const globFromSource = async (source) => {
+        const files = await fg.glob(fg.isDynamicPattern(source) ? source : path.join(source, '**'), {
+            dot: false,
+            ignore: ignorePatterns,
+            absolute: true,
+            cwd,
+        });
+        return Promise.all(files.map(async (file) => await resolveRealpath(file)));
+    };
+    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 resolveRealpath(path.resolve(cwd, entryFile));
+        unvisitedFiles.delete(entry);
+        for await (const { source, dependency } of walkDependencyTree(entry, {
+            resolvers,
+            depth,
+            visited: visitedFiles,
+            ignorePatterns,
+        })) {
+            let resolvedDependency = dependency;
+            if (files.has(dependency)) {
+                debug(`${source}: ${dependency} [dependency]`);
+            }
+            else {
+                const realpath = await resolveRealpath(dependency);
+                if (files.has(realpath)) {
+                    resolvedDependency = realpath;
+                }
+                else {
+                    debug(`${source}: ${dependency} [unknown dependency]`);
+                }
+            }
+            unvisitedFiles.delete(resolvedDependency);
+        }
+    }
+    const unused = Array.from(unvisitedFiles.intersection(files))
+        .map((abspath) => path.relative(cwd, abspath))
+        .sort();
+    const used = Array.from(visitedFiles.intersection(files))
+        .map((abspath) => path.relative(cwd, abspath))
+        .sort();
+    return {
+        unused,
+        used,
+    };
+}

package/lib/{bin.js → bin.mjs}

@@ -1,13 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const clipanion_1 = require("clipanion");
-const command_1 = require("./command");
-const cli = new clipanion_1.Cli({
+import { Cli } from 'clipanion';
+import { BaseCommand } from './command.mjs';
+const cli = new Cli({
     binaryLabel: '@noahnu/unused-files',
     binaryName: 'yarn @noahnu/unused-files',
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     binaryVersion: require('../package.json').version,
     enableCapture: true,
 });
-cli.register(command_1.BaseCommand);
+cli.register(BaseCommand);
 cli.runExit(process.argv.slice(2));

package/lib/command.mjs

@@ -0,0 +1,36 @@
+import { Command, Option } from 'clipanion';
+import * as t from 'typanion';
+import { findUnusedFiles } from './api/index.mjs';
+export class BaseCommand extends Command {
+    entryFiles = Option.Array('--entry', {
+        description: 'Entry files into the codebase. These files are known to be ' +
+            'used and any files that are dependencies of these entry files ' +
+            'are also considered used files.',
+        required: true,
+    });
+    ignorePatterns = Option.Array('--ignore', {
+        description: 'Glob patterns usued to exclude files. ' +
+            'The patterns are applied during traversal ' +
+            'of the directory tree.',
+        required: false,
+    });
+    depth = Option.String('--depth', {
+        description: 'Depth limit. Set to -1 to disable.',
+        required: false,
+        validator: t.isNumber(),
+    });
+    sourceDirectories = Option.Rest();
+    async execute() {
+        const result = await findUnusedFiles({
+            entryFiles: this.entryFiles,
+            ignorePatterns: this.ignorePatterns,
+            sourceDirectories: this.sourceDirectories.length
+                ? this.sourceDirectories
+                : [process.cwd()],
+            depth: typeof this.depth === 'undefined'
+                ? -1
+                : parseInt(Math.max(this.depth, -1).toFixed(0), 10),
+        });
+        this.context.stdout.write(result.unused.join('\n'));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noahnu/unused-files",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/noahnu/nodejs-tools.git",
@@ -15,26 +15,27 @@
   "scripts": {
     "clean": "run workspace:clean \"$(pwd)\"",
     "prepack": "run workspace:build \"$(pwd)\"",
-    "run-local": "run -T tsx ./src/bin.ts"
+    "run-local": "run -T tsx ./src/bin.mts"
   },
-  "bin": "./lib/bin.js",
-  "main": "./lib/api/index.js",
+  "bin": "./lib/bin.mjs",
+  "main": "./lib/api/index.mjs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public",
-    "bin": "./lib/bin.js",
-    "main": "./lib/api/index.js",
-    "types": "./lib/api/index.d.ts"
+    "bin": "./lib/bin.mjs",
+    "main": "./lib/api/index.mjs",
+    "types": "./lib/api/index.d.mts"
   },
   "files": [
     "lib"
   ],
   "dependencies": {
+    "@noahnu/dependency-utils": "^0.0.1",
     "@types/debug": "^4.1.12",
-    "@typescript-eslint/typescript-estree": "^8.13.0",
+    "@typescript-eslint/typescript-estree": "^8.22.0",
     "clipanion": "^4.0.0-rc.4",
-    "debug": "^4.3.7",
-    "fast-glob": "^3.3.2",
+    "debug": "^4.4.0",
+    "fast-glob": "^3.3.3",
     "micromatch": "^4.0.8",
     "typanion": "^3.14.0"
   },
@@ -42,8 +43,8 @@
     "@jest/globals": "^29.7.0",
     "@noahnu/internal-test-utils": "0.0.0",
     "@types/micromatch": "^4.0.9",
-    "@types/node": "^22.9.0",
-    "typescript": "^5.7.2"
+    "@types/node": "^22.12.0",
+    "typescript": "^5.7.3"
   },
-  "types": "./lib/api/index.d.ts"
+  "types": "./lib/api/index.d.mts"
 }

package/lib/api/index.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findUnusedFiles = findUnusedFiles;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
-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 = [], 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, '**'), {
-            dot: false,
-            ignore: ignorePatterns,
-            absolute: true,
-            cwd,
-        });
-        return Promise.all(files.map(async (file) => await node_fs_1.default.promises.realpath(file).catch(() => file)));
-    };
-    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, {
-            resolvers,
-            depth,
-            visited: visitedFiles,
-            ignorePatterns,
-        })) {
-            let resolvedDependency = dependency;
-            if (files.has(dependency)) {
-                debug(`${source}: ${dependency} [dependency]`);
-            }
-            else {
-                const realpath = await node_fs_1.default.promises.realpath(dependency);
-                if (files.has(realpath)) {
-                    resolvedDependency = realpath;
-                }
-                else {
-                    debug(`${source}: ${dependency} [unknown dependency]`);
-                }
-            }
-            unvisitedFiles.delete(resolvedDependency);
-        }
-    }
-    const unused = Array.from(unvisitedFiles.intersection(files))
-        .map((abspath) => node_path_1.default.relative(cwd, abspath))
-        .sort();
-    const used = Array.from(visitedFiles.intersection(files))
-        .map((abspath) => node_path_1.default.relative(cwd, abspath))
-        .sort();
-    return {
-        unused,
-        used,
-    };
-}

package/lib/api/types.d.ts

@@ -1,15 +0,0 @@
-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

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

package/lib/api/walkDependencyTree.d.ts

@@ -1,10 +0,0 @@
-import { type Resolver } from './types';
-export declare function walkDependencyTree(source: string, { resolvers, visited, depth, ignorePatterns, }?: {
-    resolvers?: Resolver[];
-    visited?: Set<string>;
-    depth?: number;
-    ignorePatterns?: string[];
-}): AsyncGenerator<{
-    source: string;
-    dependency: string;
-}, void, void>;

package/lib/api/walkDependencyTree.js

@@ -1,112 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.walkDependencyTree = walkDependencyTree;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
-const typescript_estree_1 = require("@typescript-eslint/typescript-estree");
-const debug_1 = __importDefault(require("debug"));
-const micromatch_1 = __importDefault(require("micromatch"));
-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', 'jsx', 'mjs', 'cjs']);
-async function* walkDependencyTree(source, { resolvers, visited, depth = DEFAULT_DEPTH_LIMIT, ignorePatterns, } = {}) {
-    const ext = node_path_1.default.extname(source).substring(1);
-    if (!VALID_EXTENSIONS.has(ext)) {
-        debug(`${source}: Unknown file extension '${ext}' [skipping]`);
-        return;
-    }
-    // Convert to realpath if possible
-    source = await node_fs_1.default.promises.realpath(source).catch(() => source);
-    const visitedSet = visited ?? new Set();
-    if (visitedSet.has(source))
-        return;
-    visitedSet.add(source);
-    const code = await node_fs_1.default.promises.readFile(source, { encoding: 'utf-8' });
-    const ast = (0, typescript_estree_1.parse)(code, {
-        allowInvalidAST: true,
-        comment: false,
-        suppressDeprecatedPropertyWarnings: true,
-        errorOnUnknownASTType: false,
-        filePath: source,
-        jsDocParsingMode: 'none',
-    });
-    const importFroms = new Set();
-    const visitors = {
-        [typescript_estree_1.TSESTree.AST_NODE_TYPES.ImportDeclaration]: (node) => {
-            if (node.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.ImportDeclaration) {
-                importFroms.add(node.source.value);
-            }
-        },
-        [typescript_estree_1.TSESTree.AST_NODE_TYPES.CallExpression]: (node) => {
-            if (node.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.CallExpression &&
-                node.callee.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.Identifier &&
-                node.callee.name === 'require') {
-                const arg = node.arguments[0];
-                if (arg.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.Literal) {
-                    if (typeof arg.value === 'string') {
-                        importFroms.add(arg.value);
-                    }
-                }
-                else {
-                    debug(`${source}: Dynamic require expression found at ${node.loc.start}:${node.loc.end}`);
-                }
-            }
-        },
-        [typescript_estree_1.TSESTree.AST_NODE_TYPES.ImportExpression]: (node) => {
-            if (node.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.ImportExpression) {
-                if (node.source.type === typescript_estree_1.TSESTree.AST_NODE_TYPES.Literal) {
-                    if (typeof node.source.value === 'string') {
-                        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}`);
-                }
-            }
-        },
-    };
-    for (const body of ast.body) {
-        (0, typescript_estree_1.simpleTraverse)(body, { visitors });
-    }
-    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)] });
-        }
-        catch { }
-        return undefined;
-    };
-    for (const importFrom of Array.from(importFroms)) {
-        const absPath = await resolveToAbsPath(importFrom);
-        if (absPath) {
-            if (ignorePatterns && micromatch_1.default.isMatch(absPath, ignorePatterns)) {
-                continue;
-            }
-            yield { dependency: absPath, source };
-            if (depth === -1 || depth > 0) {
-                yield* walkDependencyTree(absPath, {
-                    resolvers,
-                    visited: visitedSet,
-                    depth: depth === -1 ? depth : depth - 1,
-                    ignorePatterns,
-                });
-            }
-        }
-        else {
-            debug(`${source}: Unable to resolve '${importFrom}'`);
-        }
-    }
-}

package/lib/command.js

@@ -1,73 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseCommand = void 0;
-const clipanion_1 = require("clipanion");
-const t = __importStar(require("typanion"));
-const api_1 = require("./api");
-class BaseCommand extends clipanion_1.Command {
-    entryFiles = clipanion_1.Option.Array('--entry', {
-        description: 'Entry files into the codebase. These files are known to be ' +
-            'used and any files that are dependencies of these entry files ' +
-            'are also considered used files.',
-        required: true,
-    });
-    ignorePatterns = clipanion_1.Option.Array('--ignore', {
-        description: 'Glob patterns usued to exclude files. ' +
-            'The patterns are applied during traversal ' +
-            'of the directory tree.',
-        required: false,
-    });
-    depth = clipanion_1.Option.String('--depth', {
-        description: 'Depth limit. Set to -1 to disable.',
-        required: false,
-        validator: t.isNumber(),
-    });
-    sourceDirectories = clipanion_1.Option.Rest();
-    async execute() {
-        const result = await (0, api_1.findUnusedFiles)({
-            entryFiles: this.entryFiles,
-            ignorePatterns: this.ignorePatterns,
-            sourceDirectories: this.sourceDirectories.length
-                ? this.sourceDirectories
-                : [process.cwd()],
-            depth: typeof this.depth === 'undefined'
-                ? -1
-                : parseInt(Math.max(this.depth, -1).toFixed(0), 10),
-        });
-        this.context.stdout.write(result.unused.join('\n'));
-    }
-}
-exports.BaseCommand = BaseCommand;