pkg-scaffold 3.1.2 β 3.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -107
- package/index.js +1 -1
- package/logo.png +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,126 +1,41 @@
|
|
|
1
|
-
#
|
|
1
|
+
# README
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/pkg-scaffold)
|
|
6
|
-
[](LICENSE)
|
|
7
|
-
[](https://oxc.rs/)
|
|
8
|
-
|
|
9
|
-
`pkg-scaffold` is the industry's most advanced codebase optimization engine. Version 3.1.0 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**.
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## π Why pkg-scaffold@3.1.2?
|
|
3
|
+
|
|
14
4
|
|
|
15
|
-
|
|
16
|
-
By integrating the Rust-based **OXC (Oxc-Parser & Oxc-Resolver)**, pkg-scaffold v3.1.0 achieves a **2-4x performance boost** over previous versions, matching and often exceeding the speed of Knip v6 for single-pass analysis.
|
|
17
|
-
|
|
18
|
-
### 2. True Type-Aware Analysis
|
|
19
|
-
Unlike basic linters, pkg-scaffold uses the full **TypeScript Compiler API** to resolve types across your entire project. This ensures that implicitly implemented interfaces, extended objects, and global ambient overrides are correctly tracked, reducing false positives to near zero.
|
|
20
|
-
|
|
21
|
-
### 3. Automated Self-Healing (The "Fix" Loop)
|
|
22
|
-
This is the "Knip-Killer" feature. pkg-scaffold doesn't just give you a report; it:
|
|
23
|
-
1. **Identifies** unused code.
|
|
24
|
-
2. **Prunes** it automatically.
|
|
25
|
-
3. **Validates** the change by running your test suite.
|
|
26
|
-
4. **Self-Heals** by rolling back immediately if a test fails.
|
|
27
|
-
|
|
28
|
-
### 4. Modular Plugin Ecosystem
|
|
29
|
-
With a dedicated `/pkg-scaffold` directory, you can now manage local configurations and custom plugins. We even support **Knip-style plugins**, allowing you to leverage the existing ecosystem while using our superior engine.
|
|
5
|
+
**The Ultimate Enterprise Codebase Janitor: OXC-Powered, Type-Aware, and Self-Healing.**
|
|
30
6
|
|
|
31
|
-
|
|
7
|
+
   
|
|
32
8
|
|
|
33
|
-
|
|
9
|
+
`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**.
|
|
34
10
|
|
|
35
|
-
|
|
36
|
-
| :--- | :---: | :---: | :---: |
|
|
37
|
-
| **Parsing Engine** | β‘ **OXC (Rust) + Hybrid TS** | β‘ OXC (Rust) | β οΈ Regex/Loose |
|
|
38
|
-
| **Type-Awareness** | β
**Full Program API** | β
Yes | β No |
|
|
39
|
-
| **Automated Pruning** | β
**Native & Safe** | β οΈ Experimental | β No |
|
|
40
|
-
| **Self-Healing Loop** | β
**Yes (Auto-Rollback)** | β No | β No |
|
|
41
|
-
| **Plugin Architecture** | β
**Modular + Knip-Compat** | β
Built-in Only | β No |
|
|
42
|
-
| **Namespace Tracking** | β
**Sub-Symbol Level** | β
Yes | β No |
|
|
43
|
-
| **Security Audit** | β
**Dynamic Registry Check** | β No | β No |
|
|
11
|
+
## Features
|
|
44
12
|
|
|
45
|
-
|
|
46
|
-
- **
|
|
47
|
-
- **
|
|
48
|
-
|
|
13
|
+
- **Extreme Speed with OXC**: By integrating the Rust-based OXC parser, `pkg-scaffold` achieves a 2-4x performance boost.
|
|
14
|
+
- **True Type-Aware Analysis**: Uses the full TypeScript Compiler API to resolve types across your entire project.
|
|
15
|
+
- **Automated Self-Healing**: Identifies unused code, removes it, and validates the change through tests.
|
|
16
|
+
- **Modular Plugin Ecosystem**: Supports local configurations and custom plugins, including Knip compatibility.
|
|
49
17
|
|
|
50
|
-
|
|
18
|
+
## Getting Started
|
|
51
19
|
|
|
52
|
-
|
|
20
|
+
### Installation
|
|
53
21
|
|
|
54
|
-
### 1. Add to your project
|
|
55
22
|
```bash
|
|
56
|
-
npm install
|
|
23
|
+
npm install -g pkg-scaffold
|
|
57
24
|
```
|
|
58
25
|
|
|
59
|
-
###
|
|
60
|
-
Create a `pkg-scaffold/config.json` to customize your experience:
|
|
61
|
-
```json
|
|
62
|
-
{
|
|
63
|
-
"interface": "CLI",
|
|
64
|
-
"options": {
|
|
65
|
-
"fastMode": true,
|
|
66
|
-
"selfHealing": true
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
```
|
|
26
|
+
### Usage
|
|
70
27
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
"scripts": {
|
|
75
|
-
"pkg-scaffold:run": "pkg-scaffold --fix --test-command 'npm test'"
|
|
76
|
-
}
|
|
28
|
+
```bash
|
|
29
|
+
pkg-scaffold init my-project
|
|
30
|
+
pkg-scaffold --fix --test-command 'npm test'
|
|
77
31
|
```
|
|
78
32
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
## π Project Structure
|
|
82
|
-
|
|
83
|
-
- **`/pkg-scaffold/config.json`**: Your local settings (CLI/GUI, Plugin Toggles).
|
|
84
|
-
- **`/pkg-scaffold/plugins/`**: Drop your custom or Knip-style plugins here.
|
|
85
|
-
- **`/docs/`**: Full [Plugin Development Guide](https://dreamlongyt.github.io/pkg-scaffold/).
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
## π‘οΈ Suppression
|
|
33
|
+
## Documentation
|
|
90
34
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* @scaffold-suppress
|
|
96
|
-
*/
|
|
97
|
-
export const internalHelper = () => { /* Safe from pruning */ };
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
---
|
|
101
|
-
## Depencies
|
|
102
|
-
```json
|
|
103
|
-
"ansis": "^3.0.0",
|
|
104
|
-
"commander": "^12.0.0",
|
|
105
|
-
"enhanced-resolve": "^5.16.0",
|
|
106
|
-
"execa": "^8.0.1",
|
|
107
|
-
"oxc-parser": "^0.135.0",
|
|
108
|
-
"oxc-resolver": "^11.20.0",
|
|
109
|
-
"ramda": "^0.29.1",
|
|
110
|
-
"yocto-spinner": "^0.1.0"
|
|
111
|
-
```
|
|
112
|
-
---
|
|
113
|
-
## DevDepencies
|
|
114
|
-
```json
|
|
115
|
-
"@types/node": "^25.9.3",
|
|
116
|
-
"express": "^5.2.1",
|
|
117
|
-
"knip": "^6.16.1", //Used to make Plugins from knip compitable with the code
|
|
118
|
-
"lodash": "^4.18.1", //For Analysing
|
|
119
|
-
"typescript": "^6.0.3", //For Analysing
|
|
120
|
-
"vitepress": "^1.6.4" //For the Documentation
|
|
121
|
-
```
|
|
122
|
-
---
|
|
35
|
+
- [home](https://dreamlongyt.github.io/pkg-scaffold/)
|
|
36
|
+
- [guide](https://dreamlongyt.github.io/pkg-scaffold/guide)
|
|
37
|
+
- [references](https://dreamlongyt.github.io/pkg-scaffold/reference)
|
|
123
38
|
|
|
124
|
-
##
|
|
39
|
+
## License
|
|
125
40
|
|
|
126
41
|
MIT Β© DreamLongYT & The Enhanced Contributors.
|
package/index.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* ============================================================================
|
|
5
|
-
* π¦ pkg-scaffold v3.1.
|
|
5
|
+
* π¦ pkg-scaffold v3.1.3: Ultimate Enterprise Codebase Janitor & Self-Healing Engine
|
|
6
6
|
* ============================================================================
|
|
7
7
|
* * Eine hochgradig integrierte Code-Analyse- und Projektbootstrapping-Engine.
|
|
8
8
|
* Kombiniert rekursive Erreichbarkeitsanalysen (Reachability Graphs) auf
|
package/logo.png
ADDED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pkg-scaffold",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.3",
|
|
4
4
|
"description": "The ultimate enterprise-grade codebase janitor. Faster than Knip v6 with OXC integration, type-aware analysis, and self-healing capabilities.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|