specky-sdd 2.0.0 → 2.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.
Files changed (92) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/README.md +803 -88
  3. package/SECURITY.md +110 -0
  4. package/dist/config.d.ts +12 -0
  5. package/dist/config.d.ts.map +1 -0
  6. package/dist/config.js +66 -0
  7. package/dist/config.js.map +1 -0
  8. package/dist/constants.d.ts +100 -1
  9. package/dist/constants.d.ts.map +1 -1
  10. package/dist/constants.js +112 -1
  11. package/dist/constants.js.map +1 -1
  12. package/dist/index.js +17 -2
  13. package/dist/index.js.map +1 -1
  14. package/dist/schemas/environment.d.ts +12 -37
  15. package/dist/schemas/environment.d.ts.map +1 -1
  16. package/dist/schemas/infrastructure.d.ts +22 -42
  17. package/dist/schemas/infrastructure.d.ts.map +1 -1
  18. package/dist/schemas/input.d.ts +13 -34
  19. package/dist/schemas/input.d.ts.map +1 -1
  20. package/dist/schemas/integration.d.ts +12 -80
  21. package/dist/schemas/integration.d.ts.map +1 -1
  22. package/dist/schemas/pipeline.d.ts +24 -230
  23. package/dist/schemas/pipeline.d.ts.map +1 -1
  24. package/dist/schemas/quality.d.ts +27 -39
  25. package/dist/schemas/quality.d.ts.map +1 -1
  26. package/dist/schemas/quality.js +13 -0
  27. package/dist/schemas/quality.js.map +1 -1
  28. package/dist/schemas/testing.d.ts +23 -0
  29. package/dist/schemas/testing.d.ts.map +1 -0
  30. package/dist/schemas/testing.js +26 -0
  31. package/dist/schemas/testing.js.map +1 -0
  32. package/dist/schemas/transcript.d.ts +18 -40
  33. package/dist/schemas/transcript.d.ts.map +1 -1
  34. package/dist/schemas/utility.d.ts +33 -65
  35. package/dist/schemas/utility.d.ts.map +1 -1
  36. package/dist/schemas/visualization.d.ts +28 -39
  37. package/dist/schemas/visualization.d.ts.map +1 -1
  38. package/dist/services/test-generator.d.ts +61 -0
  39. package/dist/services/test-generator.d.ts.map +1 -0
  40. package/dist/services/test-generator.js +217 -0
  41. package/dist/services/test-generator.js.map +1 -0
  42. package/dist/tools/input.d.ts.map +1 -1
  43. package/dist/tools/input.js +12 -0
  44. package/dist/tools/input.js.map +1 -1
  45. package/dist/tools/integration.d.ts.map +1 -1
  46. package/dist/tools/integration.js +24 -0
  47. package/dist/tools/integration.js.map +1 -1
  48. package/dist/tools/quality.d.ts +3 -2
  49. package/dist/tools/quality.d.ts.map +1 -1
  50. package/dist/tools/quality.js +84 -3
  51. package/dist/tools/quality.js.map +1 -1
  52. package/dist/tools/testing.d.ts +9 -0
  53. package/dist/tools/testing.d.ts.map +1 -0
  54. package/dist/tools/testing.js +130 -0
  55. package/dist/tools/testing.js.map +1 -0
  56. package/dist/tools/utility.d.ts.map +1 -1
  57. package/dist/tools/utility.js +36 -1
  58. package/dist/tools/utility.js.map +1 -1
  59. package/dist/types.d.ts +20 -0
  60. package/dist/types.d.ts.map +1 -1
  61. package/hooks/auto-docs.md +53 -0
  62. package/hooks/auto-test.md +61 -0
  63. package/hooks/changelog.md +74 -0
  64. package/hooks/security-scan.md +72 -0
  65. package/hooks/spec-sync.md +80 -0
  66. package/hooks/srp-validator.md +86 -0
  67. package/package.json +14 -5
  68. package/references/design-patterns.md +434 -0
  69. package/references/ears-notation.md +605 -0
  70. package/references/spec-templates.md +936 -0
  71. package/templates/analysis.md +1 -0
  72. package/templates/api-docs.md +1 -0
  73. package/templates/bugfix.md +1 -0
  74. package/templates/checklist.md +1 -0
  75. package/templates/compliance.md +1 -0
  76. package/templates/constitution.md +1 -0
  77. package/templates/cross-analysis.md +1 -0
  78. package/templates/data-model.md +1 -0
  79. package/templates/design.md +1 -0
  80. package/templates/devcontainer.md +1 -0
  81. package/templates/dockerfile.md +1 -0
  82. package/templates/onboarding.md +1 -0
  83. package/templates/research.md +1 -0
  84. package/templates/runbook.md +1 -0
  85. package/templates/specification.md +1 -0
  86. package/templates/sync-report.md +1 -0
  87. package/templates/tasks.md +3 -2
  88. package/templates/terraform.md +1 -0
  89. package/templates/test-stub.md +34 -0
  90. package/templates/user-stories.md +1 -0
  91. package/templates/verification.md +1 -0
  92. package/templates/work-items.md +1 -0
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # {{project_name}} — Analysis
2
3
 
3
4
  > Traceability matrix, coverage report, gap analysis, and quality gate decision.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # API Documentation: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Bugfix Spec: {{bug_title}}
2
3
 
3
4
  > Structured specification for bug investigation and resolution.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Quality Checklist: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Compliance Report: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # {{project_name}} — Constitution
2
3
 
3
4
  > The foundational charter for the **{{project_name}}** project, establishing principles, constraints, and success criteria.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Cross-Artifact Analysis: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Data Model: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # {{project_name}} — Design
2
3
 
3
4
  > Architecture, diagrams, ADRs, and API contracts.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Dev Container: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Container Configuration: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Developer Onboarding: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Research: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Operational Runbook: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # {{project_name}} — Specification
2
3
 
3
4
  > All requirements use **EARS notation** (Easy Approach to Requirements Syntax). Each requirement is testable, unambiguous, and traceable to the Constitution's success criteria.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Sync Report: {{project_name}}
2
3
 
3
4
  > Drift analysis between specification and implementation.
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # {{project_name}} — Tasks
2
3
 
3
4
  > Sequenced implementation tasks with pre-implementation gates, `[P]` parallel markers, effort estimates, and requirement traceability.
@@ -18,7 +19,7 @@ Before writing any code, the following gates must pass:
18
19
 
19
20
  | ID | Task | [P] | Effort | Depends On | Traces To |
20
21
  |----|------|-----|--------|------------|-----------|
21
- {{task_table}}
22
+ | {{task_table}} | | | | | |
22
23
 
23
24
  ---
24
25
 
@@ -34,5 +35,5 @@ Before writing any code, the following gates must pass:
34
35
 
35
36
  | Phase | Tasks | Parallel | Effort |
36
37
  |-------|-------|----------|--------|
37
- {{effort_summary}}
38
+ | {{effort_summary}} | | | |
38
39
  | **Total** | **{{total_tasks}}** | **{{parallel_tasks}}** | **{{total_effort}}** |
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Infrastructure as Code: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -0,0 +1,34 @@
1
+ # Test Stubs — {{feature_name}}
2
+
3
+ > Auto-generated by Specky SDD from acceptance criteria in SPECIFICATION.md and TASKS.md.
4
+
5
+ ---
6
+
7
+ ## Framework: {{framework}}
8
+
9
+ ## Traceability
10
+
11
+ | Test ID | Requirement | Description |
12
+ |---------|-------------|-------------|
13
+ {{#each stubs}}
14
+ | {{id}} | {{requirement_id}} | {{description}} |
15
+ {{/each}}
16
+
17
+ ## Generated File
18
+
19
+ - **Output:** `{{output_file}}`
20
+ - **Total Tests:** {{total_tests}}
21
+ - **Framework:** {{framework}}
22
+
23
+ ## Next Steps
24
+
25
+ 1. Open the generated test file at `{{output_file}}`
26
+ 2. Replace each `TODO: implement test` placeholder with real assertions
27
+ 3. Run your test suite to verify all stubs execute
28
+ 4. Map each passing test back to its requirement ID for traceability
29
+
30
+ ## Notes
31
+
32
+ - Each test stub traces to an acceptance criterion from SPECIFICATION.md
33
+ - Test IDs (TC-001, TC-002, ...) map to requirement IDs (REQ-001, REQ-002, ...)
34
+ - Stubs are intentionally minimal — add setup, teardown, and assertions as needed
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # User Stories: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Task Verification Report: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}
@@ -1,3 +1,4 @@
1
+ <!-- markdownlint-disable -->
1
2
  # Work Items Export: {{title}}
2
3
 
3
4
  **Feature**: {{feature_id}}