@captain_z/zsk 1.7.0 → 1.8.1
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/dist/bin.js +16 -11
- package/dist/bin.js.map +1 -1
- package/dist/commands/check.js +32 -12
- package/dist/commands/check.js.map +1 -1
- package/dist/commands/config.js +2 -2
- package/dist/commands/config.js.map +1 -1
- package/dist/commands/demo.js +2 -2
- package/dist/commands/demo.js.map +1 -1
- package/dist/commands/doctor.d.ts +4 -0
- package/dist/commands/doctor.js +102 -0
- package/dist/commands/doctor.js.map +1 -0
- package/dist/commands/issue.d.ts +2 -1
- package/dist/commands/issue.js +72 -27
- package/dist/commands/issue.js.map +1 -1
- package/dist/commands/module.js +32 -0
- package/dist/commands/module.js.map +1 -1
- package/dist/commands/prep.js +97 -3
- package/dist/commands/prep.js.map +1 -1
- package/dist/commands/project-init.js +23 -21
- package/dist/commands/project-init.js.map +1 -1
- package/dist/core/config.d.ts +1 -0
- package/dist/core/config.js +40 -14
- package/dist/core/config.js.map +1 -1
- package/dist/core/raw-manifest.d.ts +10 -0
- package/dist/core/raw-manifest.js +48 -1
- package/dist/core/raw-manifest.js.map +1 -1
- package/dist/core/workspace-layout.d.ts +2 -3
- package/dist/core/workspace-layout.js +21 -20
- package/dist/core/workspace-layout.js.map +1 -1
- package/package.json +2 -2
- package/schemas/zsk-config.schema.json +122 -13
- package/templates/issue/default/issue.md +5 -1
- package/templates/module/frontend-module/design.md +22 -0
- package/templates/module/frontend-module/proposal.md +26 -1
- package/templates/module/frontend-module/spec.md +13 -0
- package/templates/module/frontend-module/tasks.md +13 -0
- package/templates/project-init/.zsk/config.yaml +20 -18
- package/templates/project-init/.zsk/docs/PROJECT-CONFIG.md +34 -11
- package/templates/project-init/.zsk/docs/SYSTEM-SPEC.md +37 -5
- package/templates/project-init/.zsk/modules/index.md +7 -0
- package/templates/project-init/.zsk/raws/backend/index.md +3 -0
- package/templates/project-init/.zsk/raws/index.md +7 -0
- package/templates/project-init/.zsk/raws/jira/index.md +3 -0
- package/templates/project-init/.zsk/raws/manifest.json +4 -0
- package/templates/project-init/.zsk/raws/manual/index.md +3 -0
- package/templates/project-init/.zsk/raws/product/index.md +3 -0
- package/templates/project-init/.zsk/raws/qa/index.md +3 -0
- package/templates/project-init/.zsk/raws/ue/index.md +3 -0
- package/templates/project-init/.zsk/evidence/.gitkeep +0 -1
- package/templates/project-init/.zsk/issues/README.md +0 -58
- package/templates/project-init/.zsk/issues/_taxonomy.md +0 -35
- package/templates/project-init/.zsk/issues/index.md +0 -7
- package/templates/project-init/.zsk/modules/.gitkeep +0 -1
- package/templates/project-init/.zsk/plans/.gitkeep +0 -1
- package/templates/project-init/.zsk/playwright/.gitkeep +0 -1
- package/templates/project-init/.zsk/resources/.gitkeep +0 -1
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# .zsk/issues - Local Verification And Bug Evidence
|
|
2
|
-
|
|
3
|
-
This is the default issue root configured by `.zsk/config.yaml` `paths.issues`. It stores local review findings, bug reports, screenshots, logs, reproduction evidence, and verification records created during project work.
|
|
4
|
-
|
|
5
|
-
Every actionable finding from demo, smoke, review, formal test, verify, or acceptance should be persisted here or under the configured `paths.issues` root. Chat-only findings are not durable tracking.
|
|
6
|
-
|
|
7
|
-
## Directory Contract
|
|
8
|
-
|
|
9
|
-
```text
|
|
10
|
-
.zsk/issues/
|
|
11
|
-
├── README.md
|
|
12
|
-
├── _taxonomy.md
|
|
13
|
-
├── index.md # global module issue totals
|
|
14
|
-
└── {area-or-module}/
|
|
15
|
-
├── index.md # module issue index and status table
|
|
16
|
-
├── BUG-0001-short-slug/
|
|
17
|
-
│ ├── issue.md # required issue body
|
|
18
|
-
│ ├── analysis.md # optional root-cause notes
|
|
19
|
-
│ ├── reproduction.md # optional detailed repro script
|
|
20
|
-
│ ├── assets/ # screenshots, videos, HAR, exported state
|
|
21
|
-
│ │ └── index.md
|
|
22
|
-
│ └── debug-logs/ # console, test, network, investigation logs
|
|
23
|
-
│ └── index.md
|
|
24
|
-
├── demo/ # optional stage view / evidence bucket
|
|
25
|
-
│ └── index.md
|
|
26
|
-
├── _evidence/ # shared evidence referenced by multiple issues/docs
|
|
27
|
-
└── _debug-logs/ # untriaged or cross-issue historical logs only
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
Use `zsk issue create -m <module-id>` to generate issue folders from the packaged template. `zsk init` does not write `_templates/` into the project.
|
|
31
|
-
|
|
32
|
-
`zsk issue update -m <module-id> --id <issue-dir> --status <status>` updates the concrete issue and refreshes:
|
|
33
|
-
|
|
34
|
-
- `.zsk/issues/{module}/index.md` - all issues and statuses for one module.
|
|
35
|
-
- `.zsk/issues/index.md` - module totals across the project.
|
|
36
|
-
|
|
37
|
-
## Bug Directory Rules
|
|
38
|
-
|
|
39
|
-
- Keep one confirmed bug per `BUG-xxxx-short-slug/` directory.
|
|
40
|
-
- Put the issue body in `issue.md`.
|
|
41
|
-
- Put screenshots, recordings, HAR files, JSON payloads, exported browser state, and reproduction artifacts that belong to one bug under that bug's `assets/`.
|
|
42
|
-
- Put console output, test output, debug logs, and investigation notes that belong to one bug under that bug's `debug-logs/`.
|
|
43
|
-
- Use `analysis.md` only when root-cause reasoning is long enough that it would obscure the issue body.
|
|
44
|
-
- If two symptoms share one root cause, keep one bug directory and list all symptoms as evidence inside it.
|
|
45
|
-
|
|
46
|
-
## Closure And Documentation Feedback
|
|
47
|
-
|
|
48
|
-
- Record the affected PRD/SRS, spec, design, task, test case, and evidence links in the issue.
|
|
49
|
-
- After the fix is verified and confirmed by the user/product owner, update the relevant `.zsk/modules/{module}/spec.md`, `.zsk/modules/{module}/design.md`, `.zsk/modules/{module}/tasks.md`, or `.zsk/docs/SYSTEM-SPEC.md` for gaps or vague behavior exposed by the issue.
|
|
50
|
-
- Close the issue only after it links verification evidence, confirmation, documentation feedback update or no-update rationale, and regression guard.
|
|
51
|
-
|
|
52
|
-
## Relationship To Other Project Directories
|
|
53
|
-
|
|
54
|
-
| Directory | Purpose | May contain local screenshots/logs? |
|
|
55
|
-
|---|---|---|
|
|
56
|
-
| `.zsk/resources/` | Upstream facts, mirrored snapshots, original external test cases | No |
|
|
57
|
-
| `.zsk/modules/{module}/` | Human-authored module proposal/spec/design/tasks | No |
|
|
58
|
-
| `.zsk/issues/{module}/` | Local defects, verification evidence, debug logs, issue-quality records | Yes |
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
# Issue Taxonomy
|
|
2
|
-
|
|
3
|
-
Managed issue records belong under `.zsk/issues/` or the configured `.zsk/config.yaml#paths.issues` root.
|
|
4
|
-
|
|
5
|
-
Each module has a module index at `.zsk/issues/{module}/index.md`. The issue root has a global index at `.zsk/issues/index.md` with module totals. `zsk issue create` and `zsk issue update` refresh both indexes.
|
|
6
|
-
|
|
7
|
-
| Type | Concrete Issue Directory | Prefix |
|
|
8
|
-
| --- | --- | --- |
|
|
9
|
-
| Demo Issue | `.zsk/issues/{module}/{prefix}-0001-slug/` | `DEMO` |
|
|
10
|
-
| Smoke Issue | `.zsk/issues/{module}/{prefix}-0001-slug/` | `SMOKE` |
|
|
11
|
-
| Review Issue | `.zsk/issues/{module}/{prefix}-0001-slug/` | `REV` |
|
|
12
|
-
| Defect | `.zsk/issues/{module}/{prefix}-0001-slug/` | `DEFECT` |
|
|
13
|
-
| Verify Issue | `.zsk/issues/{module}/{prefix}-0001-slug/` | `VER` |
|
|
14
|
-
| Acceptance Issue | `.zsk/issues/{module}/{prefix}-0001-slug/` | `ACC` |
|
|
15
|
-
|
|
16
|
-
Stage directories such as `.zsk/issues/{module}/demo/index.md` may exist as stage views or evidence buckets. The authoritative status indexes are `.zsk/issues/{module}/index.md` and `.zsk/issues/index.md`.
|
|
17
|
-
|
|
18
|
-
`.zsk/resources/issues/` is reserved for imported external issue feeds or compatibility inputs.
|
|
19
|
-
|
|
20
|
-
## Required Intake
|
|
21
|
-
|
|
22
|
-
Every actionable issue should include:
|
|
23
|
-
|
|
24
|
-
- reproduction steps or triggering command;
|
|
25
|
-
- actual/current behavior;
|
|
26
|
-
- expected behavior;
|
|
27
|
-
- severity and rationale;
|
|
28
|
-
- environment/version/data source;
|
|
29
|
-
- evidence links;
|
|
30
|
-
- root-cause hypothesis and confidence;
|
|
31
|
-
- fix route;
|
|
32
|
-
- Documentation Feedback target or no-update rationale;
|
|
33
|
-
- regression guard;
|
|
34
|
-
- verification evidence and user/product confirmation before closing behavior-changing issues;
|
|
35
|
-
- updated module index and global issue index.
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|