dev-workflows 0.1.2 → 0.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 +18 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,12 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
> Define AI coding rules once. Compile to CLAUDE.md, .cursor/rules, GEMINI.md.
|
|
4
4
|
|
|
5
|
+
AI coding tools (Claude Code, Cursor, Gemini CLI) each use different config files for project rules. dev-workflows lets you define rules once in YAML and compile them to each tool's native format. No duplication, no drift.
|
|
6
|
+
|
|
5
7
|
## Quick start
|
|
6
8
|
|
|
7
9
|
```bash
|
|
8
10
|
npx dev-workflows init
|
|
9
11
|
```
|
|
10
12
|
|
|
13
|
+
Requires Node.js >= 22.
|
|
14
|
+
|
|
11
15
|
## Usage
|
|
12
16
|
|
|
13
17
|
```bash
|
|
@@ -16,6 +20,20 @@ devw add typescript-strict # install a rule block
|
|
|
16
20
|
devw compile # generate CLAUDE.md, .cursor/rules, GEMINI.md
|
|
17
21
|
```
|
|
18
22
|
|
|
23
|
+
## What it generates
|
|
24
|
+
|
|
25
|
+
Running `devw compile` produces tool-specific files with your rules between markers:
|
|
26
|
+
|
|
27
|
+
```md
|
|
28
|
+
<!-- BEGIN dev-workflows -->
|
|
29
|
+
- Never use `any`. Use `unknown` when the type is truly unknown.
|
|
30
|
+
- Always declare explicit return types on exported functions.
|
|
31
|
+
- Prefer union types over enums. Use `as const` objects when you need runtime values.
|
|
32
|
+
<!-- END dev-workflows -->
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Content outside the markers is preserved — your manual notes stay intact.
|
|
36
|
+
|
|
19
37
|
## Available blocks
|
|
20
38
|
|
|
21
39
|
| Block | Description |
|
|
@@ -38,10 +56,6 @@ devw compile # generate CLAUDE.md, .cursor/rules, GEMINI.md
|
|
|
38
56
|
| `devw list` | List available blocks and rules |
|
|
39
57
|
| `devw doctor` | Validate configuration |
|
|
40
58
|
|
|
41
|
-
## Documentation
|
|
42
|
-
|
|
43
|
-
Full specification: [docs/CLI_SPEC.md](docs/CLI_SPEC.md)
|
|
44
|
-
|
|
45
59
|
## License
|
|
46
60
|
|
|
47
61
|
MIT
|