@mohamed_fadl/reactlens 1.2.0-beta.7 → 1.2.0-beta.8
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 +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,20 +9,20 @@
|
|
|
9
9
|
|
|
10
10
|
ReactLens is a high-performance tool designed for deep architectural auditing of React and Next.js applications. It uses static AST analysis to give you a clear "X-ray" view of your project's health.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Quick Reference (TL;DR)
|
|
13
13
|
|
|
14
14
|
| Command | Description | Example |
|
|
15
15
|
| :--- | :--- | :--- |
|
|
16
16
|
| `analyze` | Full architectural health audit | `reactlens analyze ./src` |
|
|
17
17
|
| `graph` | Visual dependency graph (SVG/PNG) | `reactlens graph ./src --output architecture.svg` |
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Installation
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
22
|
npm install -g @mohamed_fadl/reactlens
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Usage Examples
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
# Basic health check
|
|
@@ -37,7 +37,7 @@ reactlens analyze --json report.json --silent
|
|
|
37
37
|
|
|
38
38
|
---
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## System Requirements (Graphviz)
|
|
41
41
|
|
|
42
42
|
To use the `graph` command, you need **Graphviz (2.40+)** installed:
|
|
43
43
|
|
|
@@ -50,7 +50,7 @@ To use the `graph` command, you need **Graphviz (2.40+)** installed:
|
|
|
50
50
|
|
|
51
51
|
---
|
|
52
52
|
|
|
53
|
-
##
|
|
53
|
+
## Detailed Commands
|
|
54
54
|
|
|
55
55
|
### `reactlens analyze [path] [options]`
|
|
56
56
|
Analyze architectural health, complexity, and dependencies.
|
|
@@ -60,7 +60,7 @@ Analyze architectural health, complexity, and dependencies.
|
|
|
60
60
|
- `-s, --silent` : Suppress visual terminal report.
|
|
61
61
|
- `--fail-under <score>` : Exit with error if score is below the limit.
|
|
62
62
|
|
|
63
|
-
###
|
|
63
|
+
### JSON Structure
|
|
64
64
|
When using `--json`, the output follows this schema:
|
|
65
65
|
- `summary`: High-level counts (Modules, Components).
|
|
66
66
|
- `metrics`: Scores for Complexity, Coupling, and Zombies.
|
|
@@ -72,7 +72,7 @@ Visualize module relationships. Supports `.svg`, `.png`, and `.dot` formats.
|
|
|
72
72
|
|
|
73
73
|
---
|
|
74
74
|
|
|
75
|
-
##
|
|
75
|
+
## Understanding the Score
|
|
76
76
|
|
|
77
77
|
We calculate project health based on three pillars:
|
|
78
78
|
|
|
@@ -82,7 +82,7 @@ We calculate project health based on three pillars:
|
|
|
82
82
|
|
|
83
83
|
---
|
|
84
84
|
|
|
85
|
-
##
|
|
85
|
+
## Deep Dive
|
|
86
86
|
|
|
87
87
|
For technical details on algorithms and scoring, visit the [Engineering Reference](ENGINEERING.md).
|
|
88
88
|
|