@hunchoweb/nclean 0.0.0-stage → 0.1.1

package/dist/utils/paths.js

@@ -0,0 +1,50 @@
+import path from 'node:path';
+import os from 'node:os';
+import { lstat, realpath } from 'node:fs/promises';
+import { terminalText } from './format.js';
+import { assertProjectScope } from './project-scope.js';
+export function expandPath(input) {
+    if (input === '~')
+        return os.homedir();
+    return path.resolve(input.startsWith('~/') || input.startsWith('~\\') ? path.join(os.homedir(), input.slice(2)) : input);
+}
+export function within(root, target) {
+    const relative = path.relative(root, target);
+    return relative === '' || (!relative.startsWith(`..${path.sep}`) && relative !== '..' && !path.isAbsolute(relative));
+}
+export function displayPath(value) {
+    const home = os.homedir();
+    return terminalText(within(home, value) ? `~${value.slice(home.length)}` : value);
+}
+export async function scanRoots(inputs) {
+    const roots = [];
+    for (const input of inputs.length ? inputs : [process.cwd()]) {
+        const resolved = expandPath(input);
+        const stat = await lstat(resolved);
+        if (!stat.isDirectory() || stat.isSymbolicLink())
+            throw new Error(`Scan root must be a real directory: ${displayPath(resolved)}`);
+        const canonical = await realpath(resolved);
+        if (canonical === path.parse(canonical).root)
+            throw new Error('Scanning the filesystem root is not supported. Choose a project directory.');
+        if (canonical.split(path.sep).includes('node_modules'))
+            throw new Error('Choose a project directory, not a directory inside node_modules.');
+        assertProjectScope(canonical);
+        roots.push(canonical);
+    }
+    return [...new Set(roots)].filter(root => !roots.some(other => other !== root && within(other, root)));
+}
+export async function assertRealPath(root, target) {
+    if (!within(root, target))
+        throw new Error('Path is outside the scan root.');
+    let current = root;
+    const parts = path.relative(root, target).split(path.sep).filter(Boolean);
+    for (const part of ['', ...parts]) {
+        if (part)
+            current = path.join(current, part);
+        const stat = await lstat(current);
+        if (!stat.isDirectory() || stat.isSymbolicLink())
+            throw new Error(`Directory changed or is a symlink: ${displayPath(current)}`);
+    }
+    if (await realpath(target) !== target)
+        throw new Error('Path resolves through a symlink.');
+}

package/dist/utils/project-scope.d.ts

@@ -0,0 +1,2 @@
+export declare function projectScopeReason(folder: string): string | null;
+export declare function assertProjectScope(folder: string): void;

package/dist/utils/project-scope.js

@@ -0,0 +1,26 @@
+import path from 'node:path';
+// Apply to the full path so choosing a protected subdirectory explicitly
+// cannot bypass the same exclusions used during recursive discovery.
+const generated = new Set(['node_modules', 'dist', 'build', 'coverage', 'vendor']);
+const managed = new Set(['library', 'applications', 'appdata', 'program files', 'program files (x86)', 'programdata', 'windows']);
+const systemRoots = ['/usr', '/opt', '/System', '/Applications', '/Library'];
+export function projectScopeReason(folder) {
+    const absolute = path.resolve(folder);
+    if (process.platform !== 'win32' && systemRoots.some(root => absolute === root || absolute.startsWith(`${root}/`))) {
+        return 'system or installed-software directory';
+    }
+    for (const part of absolute.split(path.sep).filter(Boolean)) {
+        if (part.startsWith('.'))
+            return 'hidden or tool-managed directory';
+        if (generated.has(part.toLowerCase()))
+            return 'dependency or generated directory';
+        if (managed.has(part.toLowerCase()) || /\.(?:app|framework|bundle)$/i.test(part))
+            return 'application or tool-managed directory';
+    }
+    return null;
+}
+export function assertProjectScope(folder) {
+    const reason = projectScopeReason(folder);
+    if (reason)
+        throw new Error(`Refusing project cleanup in a ${reason}. Choose a source project directory.`);
+}

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@hunchoweb/nclean",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Clean up forgotten Node.js dependencies.",
+  "type": "module",
+  "bin": {
+    "nclean": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "dev": "node --import tsx src/cli.ts",
+    "build": "tsc",
+    "test": "npm run build && node --import tsx --test test/*.test.ts",
+    "lint": "tsc --noEmit",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm test && npm run lint",
+    "demo:setup": "node scripts/demo.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hunchoweb/nodeprune.git"
+  },
+  "homepage": "https://github.com/hunchoweb/nodeprune#readme",
+  "bugs": {
+    "url": "https://github.com/hunchoweb/nodeprune/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "keywords": [
+    "cli",
+    "node_modules",
+    "cleanup",
+    "disk-space",
+    "node",
+    "npm",
+    "pnpm"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@inquirer/core": "^10.3.2",
+    "commander": "^14.0.0",
+    "ora": "^8.2.0",
+    "picocolors": "^1.1.1",
+    "string-width": "^7.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsx": "^4.20.0",
+    "typescript": "^5.9.0"
+  }
+}