@enhance-eng/archangel 0.0.1 → 0.1.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 +25 -3
- package/archangel.schema.json +1192 -0
- package/bin/archangel.js +28 -0
- package/index.d.ts +374 -0
- package/index.js +9 -0
- package/lib/platform.js +41 -0
- package/package.json +53 -7
- package/plugin.d.ts +121 -0
- package/plugin.js +8 -0
- package/presets/fsd-conditions.js +360 -0
- package/presets/fsd.js +285 -0
- package/presets/nextjs.js +45 -0
package/README.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Archangel
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Make architecture verifiable.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Archangel checks the architecture rules of a TypeScript codebase. You write down how your code is
|
|
6
|
+
organized. Archangel tells you when the code breaks those rules, and what to do about it. It checks
|
|
7
|
+
a large repository in about a second, so it can run in your editor as you type.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install --save-dev @enhance-eng/archangel
|
|
11
|
+
npx archangel init --typescript
|
|
12
|
+
npx archangel check
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Archangel checks imports, import cycles, file and folder names, the files that folders must contain,
|
|
16
|
+
and exports. It has presets for Feature-Sliced Design and Next.js, and you can write your own
|
|
17
|
+
conditions in TypeScript.
|
|
18
|
+
|
|
19
|
+
- [Quick start](https://github.com/enhance-labs-builds/archangel/blob/main/README.md#quick-start)
|
|
20
|
+
- [Rules](https://github.com/enhance-labs-builds/archangel/blob/main/docs/rules.md)
|
|
21
|
+
- [Presets](https://github.com/enhance-labs-builds/archangel/blob/main/docs/presets.md)
|
|
22
|
+
- [Plugins](https://github.com/enhance-labs-builds/archangel/blob/main/docs/plugins.md)
|
|
23
|
+
- [Commands](https://github.com/enhance-labs-builds/archangel/blob/main/docs/commands.md)
|
|
24
|
+
|
|
25
|
+
The package includes a prebuilt binary for macOS, Linux and Windows. You do not need Rust.
|
|
26
|
+
|
|
27
|
+
Licensed under MIT or Apache-2.0, at your option.
|