@wneng/create-keel 0.1.2 → 0.2.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 +37 -1
- package/dist/index.js +798 -33
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/templates/docs-skeleton/files/usage-quickstart.md +2 -0
package/README.md
CHANGED
|
@@ -1,14 +1,44 @@
|
|
|
1
1
|
# @wneng/create-keel
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@wneng/create-keel)
|
|
4
|
+
[](https://www.npmjs.com/package/@wneng/create-keel)
|
|
5
|
+
[](./LICENSE)
|
|
6
|
+
[](https://nodejs.org)
|
|
7
|
+
|
|
3
8
|
Scaffolder for Contract First + Vibe Coding projects following the `keel` conventions (see root `AGENTS.md`).
|
|
4
9
|
|
|
5
10
|
## Usage
|
|
6
11
|
|
|
12
|
+
### Create a new project
|
|
13
|
+
|
|
7
14
|
```bash
|
|
8
15
|
npx @wneng/create-keel create my-app
|
|
9
16
|
```
|
|
10
17
|
|
|
11
|
-
|
|
18
|
+
### Add a feature to an existing project
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
cd my-app
|
|
22
|
+
npx @wneng/create-keel feature add user-signup
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This scaffolds aligned PRD / ADR / backend / frontend / test artifacts plus
|
|
26
|
+
a contract path stub, all sharing the same kebab-case slug. See
|
|
27
|
+
`docs/03-工程规范与研发基础设施/usage-quickstart.md` (in the parent repo)
|
|
28
|
+
for the full slug convention.
|
|
29
|
+
|
|
30
|
+
### Try a worked example
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx @wneng/create-keel create demo --yes --sample-feature
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Adds the `user-signup` feature with fully written PRD, ADR, designs, test
|
|
37
|
+
plan, and `/users/signup` OpenAPI path so new users can read a working
|
|
38
|
+
end-to-end example instead of empty templates.
|
|
39
|
+
|
|
40
|
+
Options for both subcommands are collected interactively when omitted. See
|
|
41
|
+
`--help`.
|
|
12
42
|
|
|
13
43
|
## Development
|
|
14
44
|
|
|
@@ -19,3 +49,9 @@ npm test
|
|
|
19
49
|
```
|
|
20
50
|
|
|
21
51
|
See `.kiro/specs/project-scaffolder/` in the parent repo for full design artifacts.
|
|
52
|
+
|
|
53
|
+
## Source
|
|
54
|
+
|
|
55
|
+
- Gitee: https://gitee.com/wangneng521/keel
|
|
56
|
+
- npm: https://www.npmjs.com/package/@wneng/create-keel
|
|
57
|
+
- Spec: `.kiro/specs/project-scaffolder/`
|