specky-sdd 1.0.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.
Files changed (78) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +446 -0
  3. package/dist/constants.d.ts +68 -0
  4. package/dist/constants.d.ts.map +1 -0
  5. package/dist/constants.js +120 -0
  6. package/dist/constants.js.map +1 -0
  7. package/dist/index.d.ts +10 -0
  8. package/dist/index.d.ts.map +1 -0
  9. package/dist/index.js +95 -0
  10. package/dist/index.js.map +1 -0
  11. package/dist/schemas/common.d.ts +8 -0
  12. package/dist/schemas/common.d.ts.map +1 -0
  13. package/dist/schemas/common.js +18 -0
  14. package/dist/schemas/common.js.map +1 -0
  15. package/dist/schemas/pipeline.d.ts +296 -0
  16. package/dist/schemas/pipeline.d.ts.map +1 -0
  17. package/dist/schemas/pipeline.js +132 -0
  18. package/dist/schemas/pipeline.js.map +1 -0
  19. package/dist/schemas/transcript.d.ts +59 -0
  20. package/dist/schemas/transcript.d.ts.map +1 -0
  21. package/dist/schemas/transcript.js +61 -0
  22. package/dist/schemas/transcript.js.map +1 -0
  23. package/dist/schemas/utility.d.ts +92 -0
  24. package/dist/schemas/utility.d.ts.map +1 -0
  25. package/dist/schemas/utility.js +82 -0
  26. package/dist/schemas/utility.js.map +1 -0
  27. package/dist/services/codebase-scanner.d.ts +24 -0
  28. package/dist/services/codebase-scanner.d.ts.map +1 -0
  29. package/dist/services/codebase-scanner.js +185 -0
  30. package/dist/services/codebase-scanner.js.map +1 -0
  31. package/dist/services/ears-validator.d.ts +29 -0
  32. package/dist/services/ears-validator.d.ts.map +1 -0
  33. package/dist/services/ears-validator.js +163 -0
  34. package/dist/services/ears-validator.js.map +1 -0
  35. package/dist/services/file-manager.d.ts +56 -0
  36. package/dist/services/file-manager.d.ts.map +1 -0
  37. package/dist/services/file-manager.js +203 -0
  38. package/dist/services/file-manager.js.map +1 -0
  39. package/dist/services/state-machine.d.ts +46 -0
  40. package/dist/services/state-machine.d.ts.map +1 -0
  41. package/dist/services/state-machine.js +167 -0
  42. package/dist/services/state-machine.js.map +1 -0
  43. package/dist/services/template-engine.d.ts +37 -0
  44. package/dist/services/template-engine.d.ts.map +1 -0
  45. package/dist/services/template-engine.js +111 -0
  46. package/dist/services/template-engine.js.map +1 -0
  47. package/dist/services/transcript-parser.d.ts +61 -0
  48. package/dist/services/transcript-parser.d.ts.map +1 -0
  49. package/dist/services/transcript-parser.js +810 -0
  50. package/dist/services/transcript-parser.js.map +1 -0
  51. package/dist/tools/analysis.d.ts +10 -0
  52. package/dist/tools/analysis.d.ts.map +1 -0
  53. package/dist/tools/analysis.js +95 -0
  54. package/dist/tools/analysis.js.map +1 -0
  55. package/dist/tools/pipeline.d.ts +11 -0
  56. package/dist/tools/pipeline.d.ts.map +1 -0
  57. package/dist/tools/pipeline.js +583 -0
  58. package/dist/tools/pipeline.js.map +1 -0
  59. package/dist/tools/transcript.d.ts +14 -0
  60. package/dist/tools/transcript.d.ts.map +1 -0
  61. package/dist/tools/transcript.js +813 -0
  62. package/dist/tools/transcript.js.map +1 -0
  63. package/dist/tools/utility.d.ts +10 -0
  64. package/dist/tools/utility.d.ts.map +1 -0
  65. package/dist/tools/utility.js +239 -0
  66. package/dist/tools/utility.js.map +1 -0
  67. package/dist/types.d.ts +161 -0
  68. package/dist/types.d.ts.map +1 -0
  69. package/dist/types.js +6 -0
  70. package/dist/types.js.map +1 -0
  71. package/package.json +53 -0
  72. package/templates/analysis.md +54 -0
  73. package/templates/bugfix.md +45 -0
  74. package/templates/constitution.md +56 -0
  75. package/templates/design.md +47 -0
  76. package/templates/specification.md +49 -0
  77. package/templates/sync-report.md +43 -0
  78. package/templates/tasks.md +38 -0
@@ -0,0 +1,45 @@
1
+ # Bugfix Spec: {{bug_title}}
2
+
3
+ > Structured specification for bug investigation and resolution.
4
+
5
+ ---
6
+
7
+ ## 1. Current Behavior
8
+
9
+ {{current_behavior}}
10
+
11
+ ---
12
+
13
+ ## 2. Expected Behavior
14
+
15
+ {{expected_behavior}}
16
+
17
+ ---
18
+
19
+ ## 3. Unchanged Behavior
20
+
21
+ The following behaviors must remain unchanged after the fix:
22
+
23
+ {{#each unchanged_behavior}}
24
+ - {{this}}
25
+ {{/each}}
26
+
27
+ ---
28
+
29
+ ## 4. Root Cause Analysis
30
+
31
+ {{root_cause}}
32
+
33
+ ---
34
+
35
+ ## 5. Test Plan
36
+
37
+ {{test_plan}}
38
+
39
+ ---
40
+
41
+ ## Metadata
42
+
43
+ - **Reported:** {{date}}
44
+ - **Severity:** {{severity}}
45
+ - **Related Requirements:** {{related_requirements}}
@@ -0,0 +1,56 @@
1
+ # {{project_name}} — Constitution
2
+
3
+ > The foundational charter for the **{{project_name}}** project, establishing principles, constraints, and success criteria.
4
+
5
+ ---
6
+
7
+ ## Article 1: Project Identity
8
+
9
+ - **Name:** {{project_name}}
10
+ - **Description:** {{description}}
11
+ - **Creator:** {{author}}
12
+ - **License:** {{license}}
13
+
14
+ ---
15
+
16
+ ## Article 2: Principles
17
+
18
+ {{#each principles}}
19
+ - {{this}}
20
+ {{/each}}
21
+
22
+ ---
23
+
24
+ ## Article 3: Constraints
25
+
26
+ {{#each constraints}}
27
+ - {{this}}
28
+ {{/each}}
29
+
30
+ ---
31
+
32
+ ## Article 4: Success Criteria
33
+
34
+ | ID | Criterion | Measure |
35
+ |----|-----------|---------|
36
+ | SC-001 | Project compiles without errors | `npm run build` exits 0 |
37
+ | SC-002 | All requirements traceable | Every REQ has design + task mapping |
38
+ | SC-003 | Quality gates pass | Analysis gate returns APPROVE |
39
+
40
+ ---
41
+
42
+ ## Article 5: Scope
43
+
44
+ ### In Scope
45
+ - {{scope_in}}
46
+
47
+ ### Out of Scope
48
+ - {{scope_out}}
49
+
50
+ ---
51
+
52
+ ## Amendment Log
53
+
54
+ | # | Date | Author | Rationale | Articles Affected |
55
+ |---|------|--------|-----------|-------------------|
56
+ | — | — | — | Initial version | All |
@@ -0,0 +1,47 @@
1
+ # {{project_name}} — Design
2
+
3
+ > Architecture, diagrams, ADRs, and API contracts.
4
+
5
+ ---
6
+
7
+ ## 1. Architecture Overview
8
+
9
+ {{architecture_overview}}
10
+
11
+ ---
12
+
13
+ ## 2. System Diagrams
14
+
15
+ {{#each diagrams}}
16
+ ### {{this}}
17
+ {{/each}}
18
+
19
+ ---
20
+
21
+ ## 3. Architecture Decision Records
22
+
23
+ {{#each adrs}}
24
+ ### {{this}}
25
+ {{/each}}
26
+
27
+ ---
28
+
29
+ ## 4. API Contracts
30
+
31
+ {{api_contracts}}
32
+
33
+ ---
34
+
35
+ ## 5. Data Models
36
+
37
+ {{data_models}}
38
+
39
+ ---
40
+
41
+ ## 6. Error Handling Strategy
42
+
43
+ {{error_handling}}
44
+
45
+ ---
46
+
47
+ **Covers:** {{requirement_references}}
@@ -0,0 +1,49 @@
1
+ # {{project_name}} — Specification
2
+
3
+ > All requirements use **EARS notation** (Easy Approach to Requirements Syntax). Each requirement is testable, unambiguous, and traceable to the Constitution's success criteria.
4
+
5
+ ---
6
+
7
+ ## Table of Contents
8
+
9
+ - [1. Core Requirements](#1-core-requirements)
10
+ - [2. Functional Requirements](#2-functional-requirements)
11
+ - [3. Non-Functional Requirements](#3-non-functional-requirements)
12
+ - [Acceptance Criteria Summary](#acceptance-criteria-summary)
13
+
14
+ ---
15
+
16
+ ## 1. Core Requirements
17
+
18
+ {{requirements_core}}
19
+
20
+ ---
21
+
22
+ ## 2. Functional Requirements
23
+
24
+ {{requirements_functional}}
25
+
26
+ ---
27
+
28
+ ## 3. Non-Functional Requirements
29
+
30
+ {{requirements_nonfunctional}}
31
+
32
+ ---
33
+
34
+ ## Acceptance Criteria Summary
35
+
36
+ | ID | Requirement | Test Method |
37
+ |----|-------------|-------------|
38
+ {{acceptance_criteria_table}}
39
+
40
+ ---
41
+
42
+ ## Self-Assessment
43
+
44
+ | Criterion | Score | Notes |
45
+ |-----------|-------|-------|
46
+ | EARS notation compliance | {{ears_compliance}} | |
47
+ | Testability | {{testability_score}} | Every requirement has acceptance criteria |
48
+ | Traceability | {{traceability_score}} | Every requirement traces to Constitution |
49
+ | Uniqueness of IDs | {{uniqueness_score}} | No duplicate requirement IDs |
@@ -0,0 +1,43 @@
1
+ # Sync Report: {{project_name}}
2
+
3
+ > Drift analysis between specification and implementation.
4
+
5
+ ---
6
+
7
+ ## Summary
8
+
9
+ - **In Sync:** {{in_sync}}
10
+ - **Last Checked:** {{last_checked}}
11
+ - **Drift Items:** {{drift_count}}
12
+
13
+ ---
14
+
15
+ ## Requirements Coverage
16
+
17
+ | Requirement | Implementation | Status |
18
+ |-------------|---------------|--------|
19
+ {{coverage_table}}
20
+
21
+ ---
22
+
23
+ ## Drift Items
24
+
25
+ {{#each drift_items}}
26
+ - {{this}}
27
+ {{/each}}
28
+
29
+ ---
30
+
31
+ ## Orphan Code
32
+
33
+ Files not traced to any requirement:
34
+
35
+ {{#each orphan_files}}
36
+ - {{this}}
37
+ {{/each}}
38
+
39
+ ---
40
+
41
+ ## Recommendation
42
+
43
+ {{recommendation}}
@@ -0,0 +1,38 @@
1
+ # {{project_name}} — Tasks
2
+
3
+ > Sequenced implementation tasks with pre-implementation gates, `[P]` parallel markers, effort estimates, and requirement traceability.
4
+
5
+ ---
6
+
7
+ ## Pre-Implementation Gates
8
+
9
+ Before writing any code, the following gates must pass:
10
+
11
+ {{#each gates}}
12
+ - [ ] {{this}}
13
+ {{/each}}
14
+
15
+ ---
16
+
17
+ ## Task Breakdown
18
+
19
+ | ID | Task | [P] | Effort | Depends On | Traces To |
20
+ |----|------|-----|--------|------------|-----------|
21
+ {{task_table}}
22
+
23
+ ---
24
+
25
+ ## Dependency Graph
26
+
27
+ ```
28
+ {{dependency_graph}}
29
+ ```
30
+
31
+ ---
32
+
33
+ ## Effort Summary
34
+
35
+ | Phase | Tasks | Parallel | Effort |
36
+ |-------|-------|----------|--------|
37
+ {{effort_summary}}
38
+ | **Total** | **{{total_tasks}}** | **{{parallel_tasks}}** | **{{total_effort}}** |