@mthanhlm/autodev 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/LICENSE +21 -0
- package/PUBLISH.md +75 -0
- package/README.md +53 -0
- package/autodev/bin/autodev-tools.cjs +346 -0
- package/autodev/templates/config.json +20 -0
- package/autodev/templates/plan.md +25 -0
- package/autodev/templates/project.md +21 -0
- package/autodev/templates/requirements.md +12 -0
- package/autodev/templates/roadmap.md +17 -0
- package/autodev/templates/state.md +10 -0
- package/autodev/templates/summary.md +16 -0
- package/autodev/templates/uat.md +15 -0
- package/autodev/workflows/execute-phase.md +50 -0
- package/autodev/workflows/help.md +57 -0
- package/autodev/workflows/new-project.md +62 -0
- package/autodev/workflows/plan-phase.md +54 -0
- package/autodev/workflows/progress.md +15 -0
- package/autodev/workflows/verify-work.md +39 -0
- package/bin/install.js +565 -0
- package/commands/autodev/execute-phase.md +26 -0
- package/commands/autodev/help.md +18 -0
- package/commands/autodev/new-project.md +28 -0
- package/commands/autodev/plan-phase.md +25 -0
- package/commands/autodev/progress.md +18 -0
- package/commands/autodev/verify-work.md +24 -0
- package/hooks/autodev-context-monitor.js +66 -0
- package/hooks/autodev-git-guard.js +55 -0
- package/hooks/autodev-phase-boundary.sh +20 -0
- package/hooks/autodev-prompt-guard.js +55 -0
- package/hooks/autodev-read-guard.js +49 -0
- package/hooks/autodev-session-state.sh +22 -0
- package/hooks/autodev-statusline.js +45 -0
- package/hooks/autodev-workflow-guard.js +51 -0
- package/package.json +38 -0
- package/scripts/run-tests.cjs +23 -0
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# autodev
|
|
2
|
+
|
|
3
|
+
Lean Claude Code workflow. No automatic commits. No branches. No worktrees. Git is read-only.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
- `/autodev-new-project`
|
|
8
|
+
Creates `.autodev/PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md`, and `config.json`.
|
|
9
|
+
- `/autodev-plan-phase [phase]`
|
|
10
|
+
Creates or revises one phase plan in `.autodev/phases/NN-name/NN-PLAN.md`.
|
|
11
|
+
- `/autodev-execute-phase [phase]`
|
|
12
|
+
Executes one phase plan sequentially and writes `NN-SUMMARY.md`.
|
|
13
|
+
- `/autodev-verify-work [phase]`
|
|
14
|
+
Records manual verification in `NN-UAT.md`.
|
|
15
|
+
- `/autodev-progress`
|
|
16
|
+
Shows the current project status and next command.
|
|
17
|
+
- `/autodev-help`
|
|
18
|
+
Shows this reference.
|
|
19
|
+
|
|
20
|
+
## Default Flow
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
/autodev-new-project
|
|
24
|
+
/autodev-plan-phase 1
|
|
25
|
+
/autodev-execute-phase 1
|
|
26
|
+
/autodev-verify-work 1
|
|
27
|
+
/autodev-progress
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Git Policy
|
|
31
|
+
|
|
32
|
+
Allowed:
|
|
33
|
+
|
|
34
|
+
- `git status`
|
|
35
|
+
- `git diff`
|
|
36
|
+
- `git log`
|
|
37
|
+
- `git show`
|
|
38
|
+
- `git rev-parse`
|
|
39
|
+
- `git ls-files`
|
|
40
|
+
- `git branch --show-current`
|
|
41
|
+
|
|
42
|
+
Blocked:
|
|
43
|
+
|
|
44
|
+
- `git init`
|
|
45
|
+
- `git add`
|
|
46
|
+
- `git commit`
|
|
47
|
+
- `git checkout`
|
|
48
|
+
- `git switch`
|
|
49
|
+
- `git merge`
|
|
50
|
+
- `git rebase`
|
|
51
|
+
- `git worktree`
|
|
52
|
+
- `git push`
|
|
53
|
+
- `git pull`
|
|
54
|
+
- `git stash`
|
|
55
|
+
- `git reset`
|
|
56
|
+
- `git fetch`
|
|
57
|
+
- `git clone`
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
<purpose>
|
|
2
|
+
Initialize `.autodev/` with the minimum useful project context. Prefer fast clarity over exhaustive ceremonies.
|
|
3
|
+
</purpose>
|
|
4
|
+
|
|
5
|
+
<rules>
|
|
6
|
+
- Do not run `git init`, `git add`, `git commit`, `git checkout`, `git switch`, `git merge`, `git rebase`, `git worktree`, `git push`, `git pull`, `git stash`, `git reset`, `git fetch`, or `git clone`.
|
|
7
|
+
- Git is read-only only.
|
|
8
|
+
- Use concise questioning. Ask only for details that materially change requirements or roadmap.
|
|
9
|
+
</rules>
|
|
10
|
+
|
|
11
|
+
<process>
|
|
12
|
+
1. Run:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
node "$HOME/.claude/autodev/bin/autodev-tools.cjs" init new-project
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
2. If `.autodev/PROJECT.md` already exists, stop and tell the user to use `/autodev-progress`.
|
|
19
|
+
|
|
20
|
+
3. If the current prompt does not provide enough information to write a real roadmap, ask a short set of questions to lock:
|
|
21
|
+
- the product outcome
|
|
22
|
+
- the primary user
|
|
23
|
+
- any hard constraints
|
|
24
|
+
|
|
25
|
+
4. Read the templates from the execution context.
|
|
26
|
+
|
|
27
|
+
5. Create `.autodev/config.json` from the template with these defaults unless the user explicitly asks otherwise:
|
|
28
|
+
- `workflow.research: false`
|
|
29
|
+
- `execution.parallel: false`
|
|
30
|
+
- `git.mode: "read-only"`
|
|
31
|
+
|
|
32
|
+
6. Write `.autodev/PROJECT.md` with:
|
|
33
|
+
- one-line summary
|
|
34
|
+
- problem
|
|
35
|
+
- users
|
|
36
|
+
- success criteria
|
|
37
|
+
- constraints
|
|
38
|
+
- non-goals
|
|
39
|
+
|
|
40
|
+
7. Write `.autodev/REQUIREMENTS.md` with clear must-have requirements and acceptance bullets.
|
|
41
|
+
|
|
42
|
+
8. Write `.autodev/ROADMAP.md` with 3-8 phases using this exact heading format:
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
## Phase N: Name
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Each phase must include:
|
|
49
|
+
- `Status: pending`
|
|
50
|
+
- `Goal: ...`
|
|
51
|
+
- `Deliverables:`
|
|
52
|
+
- `Risks:`
|
|
53
|
+
|
|
54
|
+
9. Write `.autodev/STATE.md` with:
|
|
55
|
+
- `Current Phase: 1`
|
|
56
|
+
- `Current Step: planning`
|
|
57
|
+
- `Status: active`
|
|
58
|
+
- `Next Command: /autodev-plan-phase 1`
|
|
59
|
+
- current ISO timestamp
|
|
60
|
+
|
|
61
|
+
10. End with a short summary and direct the user to `/autodev-plan-phase 1`.
|
|
62
|
+
</process>
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
<purpose>
|
|
2
|
+
Create one practical phase plan. Keep it concrete, small enough to execute, and free of git-write steps.
|
|
3
|
+
</purpose>
|
|
4
|
+
|
|
5
|
+
<rules>
|
|
6
|
+
- One plan file per phase: `NN-PLAN.md`.
|
|
7
|
+
- Prefer direct action over deep orchestration.
|
|
8
|
+
- Optional research is allowed only when the user asks for it or `workflow.research` is true.
|
|
9
|
+
- Never include git write commands in the plan.
|
|
10
|
+
</rules>
|
|
11
|
+
|
|
12
|
+
<process>
|
|
13
|
+
1. Run:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
node "$HOME/.claude/autodev/bin/autodev-tools.cjs" init plan-phase "$ARGUMENTS"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
2. If `.autodev/ROADMAP.md` does not exist, stop and tell the user to run `/autodev-new-project`.
|
|
20
|
+
|
|
21
|
+
3. If no phase is found, tell the user all phases already have plans and show `/autodev-progress`.
|
|
22
|
+
|
|
23
|
+
4. Read:
|
|
24
|
+
- `.autodev/PROJECT.md`
|
|
25
|
+
- `.autodev/REQUIREMENTS.md`
|
|
26
|
+
- `.autodev/ROADMAP.md`
|
|
27
|
+
- `.autodev/STATE.md`
|
|
28
|
+
- the target phase section
|
|
29
|
+
- any existing code relevant to this phase
|
|
30
|
+
|
|
31
|
+
5. If research is enabled or explicitly requested, do targeted read-only research only. Keep the output folded into the plan instead of producing a separate research artifact.
|
|
32
|
+
|
|
33
|
+
6. Create the phase directory if missing:
|
|
34
|
+
|
|
35
|
+
```text
|
|
36
|
+
.autodev/phases/NN-name/
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
7. Write or replace `NN-PLAN.md` from the template. The plan must include:
|
|
40
|
+
- goal
|
|
41
|
+
- concrete implementation steps
|
|
42
|
+
- likely files to touch
|
|
43
|
+
- verification commands
|
|
44
|
+
- manual checks
|
|
45
|
+
- explicit git read-only reminder
|
|
46
|
+
|
|
47
|
+
8. Update `.autodev/STATE.md` so it points to:
|
|
48
|
+
- `Current Phase: N`
|
|
49
|
+
- `Current Step: planned`
|
|
50
|
+
- `Next Command: /autodev-execute-phase N`
|
|
51
|
+
- current ISO timestamp
|
|
52
|
+
|
|
53
|
+
9. End with a short summary and direct the user to `/autodev-execute-phase N`.
|
|
54
|
+
</process>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<purpose>
|
|
2
|
+
Render the current autodev status with no extra ceremony.
|
|
3
|
+
</purpose>
|
|
4
|
+
|
|
5
|
+
<process>
|
|
6
|
+
1. Run:
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
node "$HOME/.claude/autodev/bin/autodev-tools.cjs" progress table
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
2. Output the table directly.
|
|
13
|
+
|
|
14
|
+
3. If a project exists, add one short line after the table with the next recommended command.
|
|
15
|
+
</process>
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<purpose>
|
|
2
|
+
Run lightweight user acceptance testing and keep the next action obvious.
|
|
3
|
+
</purpose>
|
|
4
|
+
|
|
5
|
+
<rules>
|
|
6
|
+
- Verify against what the phase plan and summary claim.
|
|
7
|
+
- Keep the interaction concise and test-oriented.
|
|
8
|
+
- Do not auto-generate a new plan unless a real gap appears.
|
|
9
|
+
</rules>
|
|
10
|
+
|
|
11
|
+
<process>
|
|
12
|
+
1. Run:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
node "$HOME/.claude/autodev/bin/autodev-tools.cjs" init verify-work "$ARGUMENTS"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
2. If no executed phase is found, stop and direct the user to `/autodev-execute-phase`.
|
|
19
|
+
|
|
20
|
+
3. Read:
|
|
21
|
+
- `NN-PLAN.md`
|
|
22
|
+
- `NN-SUMMARY.md`
|
|
23
|
+
- relevant code or UI files
|
|
24
|
+
|
|
25
|
+
4. Present a short manual verification flow. Keep it one check at a time when user input is needed.
|
|
26
|
+
|
|
27
|
+
5. Write or update `NN-UAT.md` from the template with:
|
|
28
|
+
- test cases
|
|
29
|
+
- results
|
|
30
|
+
- bugs or follow-up
|
|
31
|
+
- recommended next step
|
|
32
|
+
|
|
33
|
+
6. Update `.autodev/STATE.md`:
|
|
34
|
+
- if verification passed, move to the next phase and set `Next Command` to `/autodev-plan-phase <next>`
|
|
35
|
+
- if verification failed, keep the same phase active and set `Next Command` to `/autodev-execute-phase N`
|
|
36
|
+
- always refresh the ISO timestamp
|
|
37
|
+
|
|
38
|
+
7. End with the verification result and the next command.
|
|
39
|
+
</process>
|