rev-dep 2.13.1 → 2.14.0
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 +17 -6
- package/package.json +5 -5
package/Readme.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<a href="#capabilities-">Capabilities</a> •
|
|
9
9
|
<a href="#installation-">Installation</a> •
|
|
10
|
+
<a href="https://rev-dep.com/docs/intro"><b>Documentation</b></a> •
|
|
10
11
|
<a href="#exploratory-toolkit-">Exploratory Toolkit</a> •
|
|
11
12
|
<a href="#cli-reference-">CLI Reference</a>
|
|
12
13
|
</p>
|
|
@@ -31,7 +32,7 @@ As codebases scale, maintaining a mental map of dependencies becomes impossible.
|
|
|
31
32
|
|
|
32
33
|
<p align="center"><b>Think of Rev-dep as a high-speed linter for your dependency graph.</b></p>
|
|
33
34
|
|
|
34
|
-
**Consolidate fragmented, sequential checks from multiple slow tools into a single, high-performance engine.** Rev-dep executes a full suite of governance checks
|
|
35
|
+
**Consolidate fragmented, sequential checks from multiple slow tools into a single, high-performance engine.** Rev-dep executes a full suite of governance checks - including circularity, orphans, module boundaries and more, in one parallelized pass. Implemented in **Go** to bypass the performance bottlenecks of Node-based analysis, it can audit a **500k+ LoC project in approximately 500ms**.
|
|
35
36
|
|
|
36
37
|
### **Automated Codebase Governance**
|
|
37
38
|
|
|
@@ -95,6 +96,8 @@ Use CLI commands for ad-hoc dependency exploration:
|
|
|
95
96
|
|
|
96
97
|
## **Installation 📦**
|
|
97
98
|
|
|
99
|
+
Full documentation: [rev-dep.com/docs/intro](https://rev-dep.com/docs/intro)
|
|
100
|
+
|
|
98
101
|
**Install locally to set up project check scripts**
|
|
99
102
|
|
|
100
103
|
```
|
|
@@ -215,8 +218,8 @@ The configuration file (`rev-dep.config.json(c)` or `.rev-dep.config.json(c)`) a
|
|
|
215
218
|
|
|
216
219
|
```jsonc
|
|
217
220
|
{
|
|
218
|
-
"configVersion": "1.
|
|
219
|
-
"$schema": "https://github.com/jayu/rev-dep/blob/master/config-schema/1.
|
|
221
|
+
"configVersion": "1.8",
|
|
222
|
+
"$schema": "https://github.com/jayu/rev-dep/blob/master/config-schema/1.8.schema.json?raw=true",
|
|
220
223
|
"rules": [
|
|
221
224
|
{
|
|
222
225
|
"path": ".",
|
|
@@ -251,8 +254,8 @@ Here's a comprehensive example showing all available properties:
|
|
|
251
254
|
|
|
252
255
|
```jsonc
|
|
253
256
|
{
|
|
254
|
-
"configVersion": "1.
|
|
255
|
-
"$schema": "https://github.com/jayu/rev-dep/blob/master/config-schema/1.
|
|
257
|
+
"configVersion": "1.8",
|
|
258
|
+
"$schema": "https://github.com/jayu/rev-dep/blob/master/config-schema/1.8.schema.json?raw=true", // enables json autocompletion
|
|
256
259
|
"conditionNames": ["import", "default"],
|
|
257
260
|
"ignoreFiles": ["**/*.test.*"],
|
|
258
261
|
"rules": [
|
|
@@ -261,6 +264,7 @@ Here's a comprehensive example showing all available properties:
|
|
|
261
264
|
"followMonorepoPackages": true,
|
|
262
265
|
"prodEntryPoints": ["src/main.tsx", "src/pages/**/*.tsx", "src/server.ts"],
|
|
263
266
|
"devEntryPoints": ["scripts/**", "**/*.test.*"],
|
|
267
|
+
"ignoreEntryPoints": ["src/legacy/oldDashboard.tsx"],
|
|
264
268
|
"moduleBoundaries": [
|
|
265
269
|
{
|
|
266
270
|
"name": "ui-components",
|
|
@@ -374,6 +378,7 @@ Each rule can contain the following properties:
|
|
|
374
378
|
- **`followMonorepoPackages`** (optional): Control monorepo package resolution. `true` follows all workspace packages (default), `false` disables it, array follows only selected package names.
|
|
375
379
|
- **`prodEntryPoints`** (optional): Rule-level production entry point patterns for detector defaults
|
|
376
380
|
- **`devEntryPoints`** (optional): Rule-level development entry point patterns for detector defaults
|
|
381
|
+
- **`ignoreEntryPoints`** (optional): Rule-level patterns for leftover entry points you no longer care about. Files matching these patterns are not processed as issues - they are never reported as orphan files, and their unused exports are not reported. Useful for files that must stay committed but are no longer wired into the app.
|
|
377
382
|
- **`moduleBoundaries`** (optional): Array of module boundary rules
|
|
378
383
|
- **`circularImportsDetection`** (optional): Circular import detection configuration (single object or array of objects)
|
|
379
384
|
- **`orphanFilesDetection`** (optional): Orphan files detection configuration (single object or array of objects)
|
|
@@ -781,6 +786,7 @@ rev-dep config run [flags]
|
|
|
781
786
|
-h, --help help for run
|
|
782
787
|
--list-all-issues List all issues instead of limiting output
|
|
783
788
|
--package-json string Path to package.json (default: ./package.json)
|
|
789
|
+
--recheck Run all checks again after '--fix' to validate the final state
|
|
784
790
|
--rules strings Subset of rules to run (comma-separated list of rule paths)
|
|
785
791
|
--tsconfig-json string Path to tsconfig.json (default: ./tsconfig.json)
|
|
786
792
|
-v, --verbose Show warnings and verbose output
|
|
@@ -1308,7 +1314,7 @@ It can represent:
|
|
|
1308
1314
|
* an individual page or feature
|
|
1309
1315
|
* configuration or test bootstrap files
|
|
1310
1316
|
|
|
1311
|
-
|
|
1317
|
+
- depending on the project structure.
|
|
1312
1318
|
|
|
1313
1319
|
### Unused / Dead file
|
|
1314
1320
|
|
|
@@ -1350,3 +1356,8 @@ The top-level directory used as the starting point for dependency analysis.
|
|
|
1350
1356
|
## Made in 🇵🇱 and 🇯🇵 with 🧠 by [@jayu](https://github.com/jayu)
|
|
1351
1357
|
|
|
1352
1358
|
I hope that this small piece of software will help you discover and understood complexity of your project hence make you more confident while refactoring. If this tool was useful, don't hesitate to give it a ⭐!
|
|
1359
|
+
|
|
1360
|
+
### My other projects
|
|
1361
|
+
|
|
1362
|
+
- [CodeQue - Structural code search](https://codeque.co)
|
|
1363
|
+
- [Structural Code Search VSCode](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rev-dep",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.14.0",
|
|
4
4
|
"description": "Trace imports, detect unused code, clean dependencies — all with a super-fast CLI",
|
|
5
5
|
"bin": "bin.js",
|
|
6
6
|
"files": [
|
|
@@ -12,14 +12,14 @@
|
|
|
12
12
|
"type": "git",
|
|
13
13
|
"url": "https://github.com/jayu/rev-dep"
|
|
14
14
|
},
|
|
15
|
-
"homepage": "https://
|
|
15
|
+
"homepage": "https://rev-dep.com",
|
|
16
16
|
"engines": {
|
|
17
17
|
"node": ">=18"
|
|
18
18
|
},
|
|
19
19
|
"optionalDependencies": {
|
|
20
|
-
"@rev-dep/darwin-arm64": "2.
|
|
21
|
-
"@rev-dep/linux-x64": "2.
|
|
22
|
-
"@rev-dep/win32-x64": "2.
|
|
20
|
+
"@rev-dep/darwin-arm64": "2.14.0",
|
|
21
|
+
"@rev-dep/linux-x64": "2.14.0",
|
|
22
|
+
"@rev-dep/win32-x64": "2.14.0"
|
|
23
23
|
},
|
|
24
24
|
"keywords": [
|
|
25
25
|
"dependency-analysis",
|