pkg-scaffold 3.3.2 → 3.3.4

package/README.md

@@ -1,41 +1,82 @@
-# README
+# 📦 pkg-scaffold
 
 ![Logo](./logo.png)
 
-**The Ultimate Enterprise Codebase Janitor: OXC-Powered, Type-Aware, and Self-Healing.**
+> **The Ultimate Enterprise Codebase Janitor.** Faster than Knip with OXC integration, type-aware analysis, and self-healing capabilities. Fully standalone - solving what Knip cannot.
 
-![Version](https://img.shields.io/badge/version-3.1.3-blue.svg) ![License](https://img.shields.io/badge/license-MIT-green.svg) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/DreamLongYT/pkg-scaffold/npm-publish.yml?branch=main) ![Performance](https://img.shields.io/badge/performance-OXC--Inside-blueviolet.svg)
+![Version](https://img.shields.io/npm/v/pkg-scaffold) ![License](https://img.shields.io/badge/license-Apache--2.0-green.svg) ![Performance](https://img.shields.io/badge/performance-OXC--Inside-blueviolet.svg)
 
-`pkg-scaffold` is the industry's most advanced codebase optimization engine. Version 3.1.3 marks a massive leap forward, outperforming Knip v6 with a hybrid **OXC + TypeScript** architecture. It doesn't just find dead code—it safely prunes it and validates your project's integrity through a unique **Self-Healing Loop**.
+`pkg-scaffold` is a next-generation tool designed to declutter your JavaScript and TypeScript projects. It finds unused files, unused dependencies, dead code, circular dependencies, and more. It is built to be a direct and superior competitor to `knip.dev`.
 
-## Features
+## 🚀 Why pkg-scaffold over Knip?
 
-- **Extreme Speed with OXC**: By integrating the Rust-based OXC parser, `pkg-scaffold` achieves a 2-4x performance boost.
-- **True Type-Aware Analysis**: Uses the full TypeScript Compiler API to resolve types across your entire project.
-- **Automated Self-Healing**: Identifies unused code, removes it, and validates the change through tests.
-- **Modular Plugin Ecosystem**: Supports local configurations and custom plugins, including Knip compatibility.
+*   **⚡ Blazing Fast:** Powered by `oxc-parser` (Rust-based) for lightning-fast AST traversal. Fallback to TypeScript compiler API when needed.
+*   **🔌 Massive Plugin Ecosystem:** Over 20+ built-in plugins (Next.js, Nuxt, SvelteKit, Tailwind, Jest, Vitest, Playwright, GitHub Actions, Webpack, Babel, Rollup, ESLint, Prettier, Husky, and many more).
+*   **💀 True Dead Code Detection:** Advanced graph-based reachability analysis to find truly dead files and unused exports, even deep within your codebase.
+*   **🔄 Circular Dependency Detection:** High-performance Tarjan-based algorithm to detect and report circular dependencies.
+*   **🛡️ Supply Chain Guard:** Detects typosquatting and verifies integrity lockfile hashes.
+*   **🔐 Secret Detection:** Scans for hardcoded secrets (API keys, tokens) using AST and Regex.
+*   **🛠️ Self-Healing:** Not just reporting, but automatically fixing structural issues (removing dead files, pruning unused dependencies).
+*   **⚙️ Flexible Configuration:** Supports `pkg-scaffold.json`, `pkg-scaffold.ts`, `scaffold.config.js`, and more.
 
-## Getting Started
-
-### Installation
+## 📦 Installation
 
 ```bash
-npm install -g pkg-scaffold
+npm install -D pkg-scaffold
+# or
+pnpm add -D pkg-scaffold
+# or
+yarn add -D pkg-scaffold
 ```
 
-### Usage
+## 🚀 Usage
+
+Run the CLI at the root of your project:
 
 ```bash
-pkg-scaffold init my-project
-pkg-scaffold --fix --test-command 'npm test'
+npx pkg-scaffold --run
 ```
 
-## Documentation
+### CLI Options
+
+*   `-c, --cwd <path>`: Specify the execution context root directory.
+*   `--fix`: Enable atomic code updates, structural file pruning, and active type sanitization.
+*   `--no-fix`: Disable direct file manipulation (dry-run reporting mode).
+*   `--tsconfig <filename>`: Specify path to custom layout configurations.
+*   `--verbose`: Toggle expanded trace telemetry for debug operational diagnostics.
+*   `-r, --run`: Execute the primary operational pipeline loop.
+*   `-y, --yes`: Skip confirmation prompts.
+
+## ⚙️ Configuration
+
+Create a `pkg-scaffold.json` (or `.js`, `.ts`) in your project root:
+
+```json
+{
+  "entryPoints": ["src/index.ts"],
+  "exclude": ["node_modules/**", "dist/**", "**/*.test.ts"],
+  "rules": {
+    "no-unused-exports": "error",
+    "no-dead-code": "error"
+  }
+}
+```
+
+## 🔌 Supported Plugins
+
+`pkg-scaffold` automatically detects your ecosystem and enables the relevant plugins:
+
+*   **Frameworks:** Next.js, Nuxt, Remix, SvelteKit, Astro, Vue, Angular
+*   **Testing:** Jest, Vitest, Playwright, Cypress
+*   **Build Tools:** Webpack, Rollup, Babel, PostCSS, TailwindCSS
+*   **Linters/Formatters:** ESLint, Prettier, Commitlint, Lint-Staged, Husky
+*   **CI/CD:** GitHub Actions
+*   **And more!**
+
+## 🤝 Contributing
 
-- [home](https://dreamlongyt.github.io/pkg-scaffold/)
-- [guide](https://dreamlongyt.github.io/pkg-scaffold/guide)
-- [references](https://dreamlongyt.github.io/pkg-scaffold/reference)
+Contributions are welcome! Please open an issue or submit a pull request.
 
-## License
+## 📄 License
 
-MIT © DreamLongYT & The Enhanced Contributors.
+Apache-2.0 License.

package/bin/cli.js

@@ -105,9 +105,9 @@ async function bootstrap() {
     // Load local config if available
     let localConfig = {};
     try {
-      const configPath = path.join(targetCwd, 'pkg-scaffold', 'config.json');
-      const configData = await fs.readFile(configPath, 'utf8');
-      localConfig = JSON.parse(configData);
+      const { ConfigLoader } = await import('../src/resolution/ConfigLoader.js');
+      const loader = new ConfigLoader(targetCwd);
+      localConfig = await loader.loadConfig(targetCwd);
     } catch (e) {}
 
     // Merge options with local config
@@ -132,7 +132,7 @@ async function bootstrap() {
 
     console.log(ansis.bold.green(`\n📦 pkg-scaffold v${packageJsonContent.version || '3.3.2'} Engine Activation`));
     console.log(ansis.dim('------------------------------------------------------------'));
-    console.log(`${ansis.bold('Target Workspace Root :')} ${ansis.blue(path.resolve(options.cwd))}`);
+    console.log(`${ansis.bold('Target Workspace Root :')} ${ansis.blue(targetCwd)}`);
     console.log(`${ansis.bold('Refactoring Mode     :')} ${options.fix ? ansis.yellow('Active Fixing & Self-Healing Enabled') : ansis.gray('Dry-Run Reporting Only')}`);
     console.log(`${ansis.bold('Validation Sandbox   :')} ${ansis.magenta(options.testCommand)}`);
     console.log(ansis.dim('------------------------------------------------------------\n'));
@@ -140,7 +140,7 @@ async function bootstrap() {
     const { RefactoringEngine } = await import('../src/index.js');
 
     const engine = new RefactoringEngine({
-      cwd: path.resolve(options.cwd),
+      cwd: targetCwd,
       autoFix: options.fix,
       tsconfig: options.tsconfig,
       testCommand: options.testCommand,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkg-scaffold",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "description": "The Ultimate Enterprise Codebase Janitor. Faster than Knip with OXC integration, type-aware analysis, and self-healing capabilities. Fully standalone - solving what Knip cannot.",
   "type": "module",
   "main": "index.js",
@@ -13,28 +13,51 @@
     "test": "echo \"Error: no test specified\" && exit 0",
     "test:stability": "npm run test",
     "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs && cp docs/sitemap.xml docs/.vitepress/dist/ && cp docs/robots.txt docs/.vitepress/dist",
+    "docs:build": "vitepress build docs && cp docs/sitemap.xml docs/.vitepress/dist/ && cp docs/robots.txt docs/.vitepress/dist && cp logo.png docs/.vitepress/dist",
     "docs:preview": "vitepress preview docs"
   },
   "keywords": [
-    "scaffold",
-    "init",
-    "package.json",
-    "setup",
-    "dx",
-    "cli",
+    "analysis",
+    "analyze",
+    "ast",
     "automation",
-    "unused-packages",
-    "ghost-dependencies",
-    "orphaned-dependencies",
+    "cli",
+    "gui",
+    "class",
+    "dead-code",
+    "dependencies",
     "dependency-analysis",
     "dependency-audit",
+    "detect",
+    "devDependencies",
+    "duplicate",
+    "entropy",
+    "enum",
+    "export",
+    "files",
+    "find",
+    "ghost-dependencies",
+    "javascript",
+    "maintenance",
+    "members",
+    "missing",
     "missing-imports",
-    "dead-code",
-    "self-healing",
-    "ast",
+    "monorepo",
+    "namespace",
     "oxc",
-    "circular-dependencies"
+    "package.json",
+    "packages",
+    "scan",
+    "self-healing",
+    "setup",
+    "type",
+    "types",
+    "typescript",
+    "unreferenced",
+    "unresolved",
+    "unused",
+    "unused-packages",
+    "workspace"
   ],
   "author": "DreamLongYT",
   "license": "Apache-2.0",
@@ -54,20 +77,17 @@
     "oxc-parser": "^0.135.0",
     "oxc-resolver": "^11.20.0",
     "ramda": "^0.29.1",
+    "typescript": "^5.0.0",
     "yocto-spinner": "^0.1.0"
   },
-  "devDepencies": {
-    "vitepress": "^1.0.0",
-    "vue": ">=3.5.0"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
   "devDependencies": {
     "@types/node": "^25.9.3",
     "express": "^5.2.1",
     "lodash": "^4.18.1",
-    "typescript": "^6.0.3",
-    "vitepress": "^1.6.4"
+    "vitepress": "^1.6.4",
+    "vue": ">=3.5.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
-}
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+allowBuilds:
+  esbuild: set this to true or false

package/src/EngineContext.js

@@ -25,6 +25,9 @@ export class GraphNode {
     this.explicitImports = new Set();
     this.dynamicImports = new Set();
     this.importedSymbols = new Set(); // Format: 'specifier:symbol' or 'specifier:*'
+    this.jsxComponents = new Set();
+    this.jsxProps = new Set();
+    this.decorators = new Set();
     
     // Internal API Exposed Interfaces (Symbol Name -> ExportMetadata)
     this.internalExports = new Map();
@@ -87,6 +90,17 @@ export class GraphNode {
 
       // Safe fallback lookup inside string reference caches (e.g., obj['databaseUrl'])
       if (parentNode.rawStringReferences.has(symbolName)) return true;
+
+      // Check for JSX component usage
+      if (parentNode.jsxComponents.has(symbolName)) return true;
+
+      // Check for JSX prop usage (e.g., <MyComponent myProp={symbolName} />)
+      for (const jsxProp of parentNode.jsxProps) {
+        if (jsxProp.endsWith(`:${symbolName}`)) return true;
+      }
+
+      // Check for decorator usage
+      if (parentNode.decorators.has(symbolName)) return true;
     }
 
     return false;