dev-workflows 0.2.1 → 0.2.2
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 +69 -40
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,69 +4,98 @@
|
|
|
4
4
|
[](./LICENSE)
|
|
5
5
|
[](https://docs.dev-workflows.com)
|
|
6
6
|
|
|
7
|
+
Define rules once. Compile them everywhere.
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
A local-first CLI to define AI coding rules and compile them for every editor and agent.
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
---
|
|
11
12
|
|
|
12
|
-
## Quick
|
|
13
|
+
## Quick Start
|
|
13
14
|
|
|
14
15
|
```bash
|
|
15
16
|
npx dev-workflows init
|
|
16
|
-
devw add
|
|
17
|
+
devw add react-conventions
|
|
17
18
|
devw compile
|
|
18
19
|
```
|
|
19
20
|
|
|
20
|
-
|
|
21
|
+
---
|
|
21
22
|
|
|
22
|
-
##
|
|
23
|
+
## What it does
|
|
23
24
|
|
|
24
|
-
```bash
|
|
25
|
-
devw init # set up .dwf/ in your project
|
|
26
|
-
devw add typescript-strict # install a rule block
|
|
27
|
-
devw compile # generate CLAUDE.md, .cursor/rules, GEMINI.md
|
|
28
25
|
```
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
Running `devw compile` produces tool-specific files with your rules between markers:
|
|
33
|
-
|
|
34
|
-
```md
|
|
35
|
-
<!-- BEGIN dev-workflows -->
|
|
36
|
-
- Never use `any`. Use `unknown` when the type is truly unknown.
|
|
37
|
-
- Always declare explicit return types on exported functions.
|
|
38
|
-
- Prefer union types over enums. Use `as const` objects when you need runtime values.
|
|
39
|
-
<!-- END dev-workflows -->
|
|
26
|
+
.dwf/rules/*.yml → devw compile → CLAUDE.md
|
|
27
|
+
.cursor/rules
|
|
28
|
+
GEMINI.md
|
|
40
29
|
```
|
|
41
30
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
## Available blocks
|
|
31
|
+
You define rules in YAML. The compiler generates each editor's native format. Change a rule, recompile — every editor stays in sync.
|
|
45
32
|
|
|
46
|
-
|
|
47
|
-
|-------|-------------|
|
|
48
|
-
| `typescript-strict` | Strict TypeScript conventions (no any, explicit returns) |
|
|
49
|
-
| `react-conventions` | Hooks rules, component patterns, naming |
|
|
50
|
-
| `nextjs-approuter` | App Router patterns, RSC, server actions |
|
|
51
|
-
| `tailwind` | Utility-first CSS conventions and design tokens |
|
|
52
|
-
| `testing-basics` | Test naming, AAA pattern, mock boundaries |
|
|
53
|
-
| `supabase-rls` | Row-Level Security enforcement and auth patterns |
|
|
33
|
+
---
|
|
54
34
|
|
|
55
35
|
## Commands
|
|
56
36
|
|
|
57
37
|
| Command | Description |
|
|
58
38
|
|---------|-------------|
|
|
59
|
-
| `devw init` | Initialize
|
|
60
|
-
| `devw
|
|
61
|
-
| `devw
|
|
62
|
-
| `devw
|
|
63
|
-
| `devw
|
|
64
|
-
| `devw
|
|
39
|
+
| `devw init` | Initialize a `.dwf/` ruleset in your project |
|
|
40
|
+
| `devw add <block>` | Install a prebuilt rule block |
|
|
41
|
+
| `devw remove <block>` | Remove a rule block |
|
|
42
|
+
| `devw compile` | Generate editor-specific rule files |
|
|
43
|
+
| `devw doctor` | Validate config and detect rule drift |
|
|
44
|
+
| `devw list rules` | List all active rules |
|
|
45
|
+
| `devw list blocks` | List installed blocks |
|
|
46
|
+
| `devw list tools` | List configured editors |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Rule Blocks
|
|
51
|
+
|
|
52
|
+
Prebuilt rule blocks you can stack. Install with `devw add <block>`.
|
|
53
|
+
|
|
54
|
+
| Block | Purpose |
|
|
55
|
+
|-------|---------|
|
|
56
|
+
| `typescript-strict` | Enforces strict TypeScript patterns |
|
|
57
|
+
| `react-conventions` | Common React component and hook rules |
|
|
58
|
+
| `nextjs-approuter` | Next.js App Router best practices |
|
|
59
|
+
| `tailwind` | Utility-first styling conventions |
|
|
60
|
+
| `supabase-rls` | Database security and RLS rules |
|
|
61
|
+
| `testing-basics` | Test naming and structure rules |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Bridges
|
|
66
|
+
|
|
67
|
+
Bridges generate editor-compatible rule files. One adapter per tool.
|
|
68
|
+
|
|
69
|
+
| Tool | Output |
|
|
70
|
+
|------|--------|
|
|
71
|
+
| Claude Code | `CLAUDE.md` |
|
|
72
|
+
| Cursor | `.cursor/rules/devworkflows.mdc` |
|
|
73
|
+
| Gemini CLI | `GEMINI.md` |
|
|
74
|
+
| Windsurf | `.windsurfrules` |
|
|
75
|
+
| VS Code Copilot | `.github/copilot-instructions.md` |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Why
|
|
80
|
+
|
|
81
|
+
- Every AI coding tool requires rules in a different format.
|
|
82
|
+
- Maintaining the same rules in three files means they drift apart.
|
|
83
|
+
- dev-workflows makes your rules a single source of truth.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Philosophy
|
|
88
|
+
|
|
89
|
+
- Local-first
|
|
90
|
+
- Source over output
|
|
91
|
+
- No accounts. No cloud.
|
|
92
|
+
|
|
93
|
+
---
|
|
65
94
|
|
|
66
95
|
## Contributing
|
|
67
96
|
|
|
68
|
-
|
|
97
|
+
Issues and PRs welcome. If you find a bug or have an idea, [open an issue](https://github.com/gpolanco/dev-workflows/issues).
|
|
69
98
|
|
|
70
99
|
## License
|
|
71
100
|
|
|
72
|
-
MIT
|
|
101
|
+
MIT
|