projscan 0.1.11 → 0.1.13
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 +49 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
|
|
11
11
|
[Install](#install) · [Quick Start](#quick-start) · [Commands](#commands) · [Full Guide](docs/GUIDE.md)
|
|
12
12
|
|
|
13
|
+
<img src="docs/hero.png" alt="projscan banner" width="600">
|
|
14
|
+
|
|
13
15
|
</div>
|
|
14
16
|
|
|
15
17
|
---
|
|
@@ -28,35 +30,19 @@ Answering these manually takes 10-30 minutes of poking through config files and
|
|
|
28
30
|
**projscan answers all of this in one command, in under 2 seconds.**
|
|
29
31
|
|
|
30
32
|
```bash
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
Project Health Report
|
|
34
|
-
──────────────────────────────────────────
|
|
35
|
-
|
|
36
|
-
Health Score: C (67/100)
|
|
37
|
-
Found 3 warnings, 2 info
|
|
38
|
-
|
|
39
|
-
Issues Detected
|
|
40
|
-
──────────────────────────────────────────
|
|
41
|
-
⚠ No ESLint configuration
|
|
42
|
-
⚠ No Prettier configuration
|
|
43
|
-
⚠ No test framework detected
|
|
44
|
-
ℹ Missing .editorconfig
|
|
45
|
-
ℹ README is nearly empty
|
|
46
|
-
|
|
47
|
-
Run projscan fix to auto-fix 4 issues.
|
|
33
|
+
npx projscan
|
|
48
34
|
```
|
|
49
35
|
|
|
50
|
-
|
|
36
|
+
<img src="docs/npx%20projscan.png" alt="npx projscan" width="700">
|
|
37
|
+
|
|
38
|
+
Run `projscan doctor` for a focused health check:
|
|
51
39
|
|
|
52
40
|
```bash
|
|
53
|
-
|
|
54
|
-
✔ Installed ESLint with TypeScript support
|
|
55
|
-
✔ Installed Prettier with sensible defaults
|
|
56
|
-
✔ Installed Vitest with sample test
|
|
57
|
-
✔ Created .editorconfig
|
|
41
|
+
npx projscan doctor
|
|
58
42
|
```
|
|
59
43
|
|
|
44
|
+
<img src="docs/npx%20projscan%20doctor.png" alt="npx projscan doctor" width="700">
|
|
45
|
+
|
|
60
46
|
## Install
|
|
61
47
|
|
|
62
48
|
```bash
|
|
@@ -83,6 +69,8 @@ projscan diagram # Architecture visualization
|
|
|
83
69
|
projscan structure # Directory tree
|
|
84
70
|
```
|
|
85
71
|
|
|
72
|
+
<img src="docs/npx%20projscan%20--help.png" alt="npx projscan --help" width="700">
|
|
73
|
+
|
|
86
74
|
For a comprehensive walkthrough, see the **[Full Guide](docs/GUIDE.md)**.
|
|
87
75
|
|
|
88
76
|
## Commands
|
|
@@ -106,6 +94,38 @@ To see all commands and options, run:
|
|
|
106
94
|
projscan --help
|
|
107
95
|
```
|
|
108
96
|
|
|
97
|
+
### Command Screenshots
|
|
98
|
+
|
|
99
|
+
<details>
|
|
100
|
+
<summary><strong>projscan structure</strong> — Directory tree with file counts</summary>
|
|
101
|
+
|
|
102
|
+
<img src="docs/npx%20projscan%20structure.png" alt="npx projscan structure" width="700">
|
|
103
|
+
</details>
|
|
104
|
+
|
|
105
|
+
<details>
|
|
106
|
+
<summary><strong>projscan diagram</strong> — Architecture visualization</summary>
|
|
107
|
+
|
|
108
|
+
<img src="docs/npx%20projscan%20diagram.png" alt="npx projscan diagram" width="700">
|
|
109
|
+
</details>
|
|
110
|
+
|
|
111
|
+
<details>
|
|
112
|
+
<summary><strong>projscan dependencies</strong> — Dependency analysis</summary>
|
|
113
|
+
|
|
114
|
+
<img src="docs/npx%20projscan%20dependencies.png" alt="npx projscan dependencies" width="700">
|
|
115
|
+
</details>
|
|
116
|
+
|
|
117
|
+
<details>
|
|
118
|
+
<summary><strong>projscan explain</strong> — File explanation</summary>
|
|
119
|
+
|
|
120
|
+
<img src="docs/npx%20projscan%20explain.png" alt="npx projscan explain" width="700">
|
|
121
|
+
</details>
|
|
122
|
+
|
|
123
|
+
<details>
|
|
124
|
+
<summary><strong>projscan badge</strong> — Health badge generation</summary>
|
|
125
|
+
|
|
126
|
+
<img src="docs/npx%20projscan%20badge.png" alt="npx projscan badge" width="700">
|
|
127
|
+
</details>
|
|
128
|
+
|
|
109
129
|
### Output Formats
|
|
110
130
|
|
|
111
131
|
All commands support `--format` for different output targets:
|
|
@@ -147,6 +167,8 @@ projscan badge
|
|
|
147
167
|
|
|
148
168
|
This outputs a [shields.io](https://shields.io) badge URL and markdown snippet you can paste into your README.
|
|
149
169
|
|
|
170
|
+
**Sample badge:** [](https://github.com/abhiyoheswaran1/projscan)
|
|
171
|
+
|
|
150
172
|
## What It Detects
|
|
151
173
|
|
|
152
174
|
**Languages**: TypeScript, JavaScript, Python, Go, Rust, Java, Ruby, C/C++, PHP, Swift, Kotlin, and 20+ more
|
|
@@ -180,6 +202,8 @@ projscan ci --min-score 70 # Exits 1 if score < 70
|
|
|
180
202
|
projscan ci --min-score 80 --format json # JSON output for parsing
|
|
181
203
|
```
|
|
182
204
|
|
|
205
|
+
<img src="docs/npx%20projscan%20ci%20--min-score%2070.png" alt="npx projscan ci --min-score 70" width="700">
|
|
206
|
+
|
|
183
207
|
### GitHub Actions
|
|
184
208
|
|
|
185
209
|
Copy the included workflow template to your project:
|
|
@@ -201,6 +225,8 @@ projscan diff # Compare against baseline
|
|
|
201
225
|
projscan diff --format markdown # Markdown diff for PRs
|
|
202
226
|
```
|
|
203
227
|
|
|
228
|
+
<img src="docs/npx%20projscan%20diff%20--save-baseline.png" alt="npx projscan diff --save-baseline" width="700">
|
|
229
|
+
|
|
204
230
|
## Use Cases
|
|
205
231
|
|
|
206
232
|
- **Onboarding**: Understand any codebase in seconds, not hours
|