speckeeper 0.12.0 → 0.13.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/cli-contract.yaml +87 -119
- package/dist/cli.js +148 -189
- package/dist/cli.js.map +1 -1
- package/dist/{config-api-coyCX1SB.d.ts → config-api-BvCV9_r8.d.ts} +1 -1
- package/dist/dsl/index.d.ts +1 -1
- package/dist/index.d.ts +2 -2
- package/docs/cli-reference.md +12 -20
- package/package.json +5 -5
|
@@ -1100,4 +1100,4 @@ declare function createLintRule<T>(config: {
|
|
|
1100
1100
|
*/
|
|
1101
1101
|
declare function loadSpeckeeperConfig(configPath?: string): Promise<ResolvedSpeckeeperConfig | null>;
|
|
1102
1102
|
|
|
1103
|
-
export { type SpeckeeperConfigInput as $, type ArtifactConfig as A, type BaseModelInstance as B, type CheckContext as C, type DDLValidationMapping as D, type ExportContext as E, type
|
|
1103
|
+
export { type SpeckeeperConfigInput as $, type ArtifactConfig as A, type BaseModelInstance as B, type CheckContext as C, type DDLValidationMapping as D, type ExportContext as E, type ModelLevel as F, RELATION_TYPES as G, type ReferenceDefinition as H, type InferModelType as I, type JsonSchemaExporter as J, ReferenceDefinitionSchema as K, type LintContext as L, type MarkdownExporter as M, type Relation as N, type OpenAPIValidationMapping as O, RelationSchema as P, type RelationValidationError as Q, RELATION_CONSTRAINTS as R, RelationsFieldSchema as S, type RenderContext as T, type Renderer as U, type ResolvedSpeckeeperConfig as V, type SourceConfig as W, type SourceMatch as X, type SourceScanner as Y, type SpecEntry as Z, type SpecModule as _, type CheckError as a, buildRegistryFromConfig as a0, createLintRule as a1, createMarkdownExporter as a2, createMermaidExporter as a3, defineConfig as a4, defineModel as a5, defineSpecs as a6, detectCycles as a7, findModelTypeFromConfig as a8, getLevelIndex as a9, getSpecsFromConfig as aa, inferModelIdFromSpecId as ab, loadSpeckeeperConfig as ac, loadYamlDir as ad, loadYamlSpecs as ae, mergeSpecs as af, validateRelationLevel as ag, CheckErrorSchema as b, type CheckResult$1 as c, type CheckResult as d, CheckResultSchema as e, type CheckWarning as f, CheckWarningSchema as g, type CoverageChecker as h, type CoverageResult as i, type DeepValidationConfig as j, type DeepValidationRule as k, type Exporter as l, type ExternalChecker as m, type LintIssue as n, LintIssueSchema as o, type LintResult as p, type LintRule$1 as q, type LintRule as r, type LookupKeyConfig as s, type MergedDesign as t, type MermaidExporter as u, type MetaModelConfig as v, type MetaModelRegistry as w, Model as x, type ModelDefinition as y, type ModelDefinitionInput as z };
|
package/dist/dsl/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import {
|
|
2
|
+
import { r as LintRule, l as Exporter, h as CoverageChecker, A as ArtifactConfig, X as SourceMatch, Y as SourceScanner, j as DeepValidationConfig, d as CheckResult, W as SourceConfig } from '../config-api-BvCV9_r8.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Core DSL — Base spec schema
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { C as CheckContext,
|
|
3
|
-
export { A as ArtifactConfig, B as BaseModelInstance,
|
|
2
|
+
import { C as CheckContext, c as CheckResult, E as ExportContext, y as ModelDefinition, w as MetaModelRegistry, L as LintContext, q as LintRule, n as LintIssue, W as SourceConfig, Z as SpecEntry } from './config-api-BvCV9_r8.js';
|
|
3
|
+
export { A as ArtifactConfig, B as BaseModelInstance, a as CheckError, b as CheckErrorSchema, d as CheckResult, e as CheckResultSchema, f as CheckWarning, g as CheckWarningSchema, h as CoverageChecker, i as CoverageResult, D as DDLValidationMapping, j as DeepValidationConfig, k as DeepValidationRule, l as Exporter, m as ExternalChecker, I as InferModelType, J as JsonSchemaExporter, o as LintIssueSchema, p as LintResult, r as LintRule, s as LookupKeyConfig, M as MarkdownExporter, t as MergedDesign, u as MermaidExporter, v as MetaModelConfig, x as Model, z as ModelDefinitionInput, F as ModelLevel, O as OpenAPIValidationMapping, R as RELATION_CONSTRAINTS, G as RELATION_TYPES, H as ReferenceDefinition, K as ReferenceDefinitionSchema, N as Relation, P as RelationSchema, Q as RelationValidationError, S as RelationsFieldSchema, T as RenderContext, U as Renderer, V as ResolvedSpeckeeperConfig, X as SourceMatch, Y as SourceScanner, _ as SpecModule, $ as SpeckeeperConfigInput, a0 as buildRegistryFromConfig, a1 as createLintRule, a2 as createMarkdownExporter, a3 as createMermaidExporter, a4 as defineConfig, a5 as defineModel, a6 as defineSpecs, a7 as detectCycles, a8 as findModelTypeFromConfig, a9 as getLevelIndex, aa as getSpecsFromConfig, ab as inferModelIdFromSpecId, ac as loadSpeckeeperConfig, ad as loadYamlDir, ae as loadYamlSpecs, af as mergeSpecs, ag as validateRelationLevel } from './config-api-BvCV9_r8.js';
|
|
4
4
|
|
|
5
5
|
declare const PhaseSchema: z.ZodEnum<["REQ", "HLD", "LLD", "IMPL", "OPS", "CI"]>;
|
|
6
6
|
type Phase = z.infer<typeof PhaseSchema>;
|
package/docs/cli-reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript-first specification validation framework — validate design consistency, external SSOT integrity, and traceability with type-safe TypeScript DSL. Supports design lint, external source checks (OpenAPI, DDL, annotations), drift detection, impact analysis, and scaffolding from Mermaid flowcharts.
|
|
4
4
|
|
|
5
|
-
**Version:** 0.
|
|
5
|
+
**Version:** 0.13.0
|
|
6
6
|
|
|
7
7
|
## Table of Contents
|
|
8
8
|
|
|
@@ -402,7 +402,7 @@ speckeeper scaffold --source arch.md --format yaml
|
|
|
402
402
|
|
|
403
403
|
```yaml
|
|
404
404
|
x-agent:
|
|
405
|
-
|
|
405
|
+
recommended_before_use:
|
|
406
406
|
- Run with --dry-run first to preview generated files
|
|
407
407
|
```
|
|
408
408
|
|
|
@@ -463,7 +463,7 @@ Performs semantic analysis of design specs using LLM to identify quality issues
|
|
|
463
463
|
speckeeper audit-requirements
|
|
464
464
|
```
|
|
465
465
|
```
|
|
466
|
-
speckeeper audit-requirements --adapter gemini --
|
|
466
|
+
speckeeper audit-requirements --adapter gemini --show-prompt
|
|
467
467
|
```
|
|
468
468
|
```
|
|
469
469
|
speckeeper audit-requirements --report-format json --output audit.json
|
|
@@ -476,8 +476,6 @@ speckeeper audit-requirements --report-format json --output audit.json
|
|
|
476
476
|
| `--config` | -c | No | | Path to config file. |
|
|
477
477
|
| `--adapter` | -a | No | | SDK adapter to use for LLM execution. |
|
|
478
478
|
| `--model` | | No | | LLM model override. |
|
|
479
|
-
| `--dry-run` | -n | No | `false` | Output the constructed prompt without calling LLM. |
|
|
480
|
-
| `--show-prompt` | | No | `false` | Display the constructed LLM prompt on stderr. |
|
|
481
479
|
| `--fail-on` | | No | `"error"` | Minimum severity that causes a non-zero exit. |
|
|
482
480
|
| `--output` | -o | No | | Write result to a file instead of stdout. |
|
|
483
481
|
| `--report-format` | | No | `"json"` | Output format for the audit report. |
|
|
@@ -512,8 +510,8 @@ speckeeper audit-requirements --report-format json --output audit.json
|
|
|
512
510
|
|
|
513
511
|
```yaml
|
|
514
512
|
x-agent:
|
|
515
|
-
|
|
516
|
-
- Run with --
|
|
513
|
+
recommended_before_use:
|
|
514
|
+
- Run with --show-prompt first to preview the prompt
|
|
517
515
|
retryableExitCodes:
|
|
518
516
|
- 12
|
|
519
517
|
```
|
|
@@ -542,8 +540,6 @@ speckeeper propose-trace-links --adapter claude --report-format json
|
|
|
542
540
|
| `--config` | -c | No | | Path to config file. |
|
|
543
541
|
| `--adapter` | -a | No | | SDK adapter to use for LLM execution. |
|
|
544
542
|
| `--model` | | No | | LLM model override. |
|
|
545
|
-
| `--dry-run` | -n | No | `false` | Output the constructed prompt without calling LLM. |
|
|
546
|
-
| `--show-prompt` | | No | `false` | Display the constructed LLM prompt on stderr. |
|
|
547
543
|
| `--fail-on` | | No | `"error"` | Minimum severity that causes a non-zero exit. |
|
|
548
544
|
| `--output` | -o | No | | Write result to a file instead of stdout. |
|
|
549
545
|
| `--report-format` | | No | `"json"` | Output format for the report. |
|
|
@@ -578,8 +574,8 @@ speckeeper propose-trace-links --adapter claude --report-format json
|
|
|
578
574
|
|
|
579
575
|
```yaml
|
|
580
576
|
x-agent:
|
|
581
|
-
|
|
582
|
-
- Run with --
|
|
577
|
+
recommended_before_use:
|
|
578
|
+
- Run with --show-prompt first to preview the prompt
|
|
583
579
|
retryableExitCodes:
|
|
584
580
|
- 12
|
|
585
581
|
```
|
|
@@ -607,8 +603,6 @@ speckeeper impact ENT-ORDER --format json | speckeeper explain-impact --adapter
|
|
|
607
603
|
|---|---|---|---|---|
|
|
608
604
|
| `--adapter` | -a | No | | SDK adapter to use for LLM execution. |
|
|
609
605
|
| `--model` | | No | | LLM model override. |
|
|
610
|
-
| `--dry-run` | -n | No | `false` | Output the constructed prompt without calling LLM. |
|
|
611
|
-
| `--show-prompt` | | No | `false` | Display the constructed LLM prompt on stderr. |
|
|
612
606
|
| `--fail-on` | | No | `"error"` | Minimum severity that causes a non-zero exit. |
|
|
613
607
|
| `--output` | -o | No | | Write result to a file instead of stdout. |
|
|
614
608
|
| `--report-format` | | No | `"json"` | Output format for the report. |
|
|
@@ -643,8 +637,8 @@ speckeeper impact ENT-ORDER --format json | speckeeper explain-impact --adapter
|
|
|
643
637
|
|
|
644
638
|
```yaml
|
|
645
639
|
x-agent:
|
|
646
|
-
|
|
647
|
-
- Run with --
|
|
640
|
+
recommended_before_use:
|
|
641
|
+
- Run with --show-prompt first to preview the prompt
|
|
648
642
|
retryableExitCodes:
|
|
649
643
|
- 12
|
|
650
644
|
```
|
|
@@ -666,7 +660,7 @@ speckeeper propose-acceptance-criteria
|
|
|
666
660
|
speckeeper propose-acceptance-criteria FR-001 FR-002
|
|
667
661
|
```
|
|
668
662
|
```
|
|
669
|
-
speckeeper propose-acceptance-criteria --adapter gemini --
|
|
663
|
+
speckeeper propose-acceptance-criteria --adapter gemini --show-prompt
|
|
670
664
|
```
|
|
671
665
|
|
|
672
666
|
#### Arguments
|
|
@@ -682,8 +676,6 @@ speckeeper propose-acceptance-criteria --adapter gemini --dry-run
|
|
|
682
676
|
| `--config` | -c | No | | Path to config file. |
|
|
683
677
|
| `--adapter` | -a | No | | SDK adapter to use for LLM execution. |
|
|
684
678
|
| `--model` | | No | | LLM model override. |
|
|
685
|
-
| `--dry-run` | -n | No | `false` | Output the constructed prompt without calling LLM. |
|
|
686
|
-
| `--show-prompt` | | No | `false` | Display the constructed LLM prompt on stderr. |
|
|
687
679
|
| `--fail-on` | | No | `"error"` | Minimum severity that causes a non-zero exit. |
|
|
688
680
|
| `--output` | -o | No | | Write result to a file instead of stdout. |
|
|
689
681
|
| `--report-format` | | No | `"json"` | Output format for the report. |
|
|
@@ -718,8 +710,8 @@ speckeeper propose-acceptance-criteria --adapter gemini --dry-run
|
|
|
718
710
|
|
|
719
711
|
```yaml
|
|
720
712
|
x-agent:
|
|
721
|
-
|
|
722
|
-
- Run with --
|
|
713
|
+
recommended_before_use:
|
|
714
|
+
- Run with --show-prompt first to preview the prompt
|
|
723
715
|
retryableExitCodes:
|
|
724
716
|
- 12
|
|
725
717
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "speckeeper",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.13.1",
|
|
4
4
|
"description": "TypeScript-first specification validation framework with external SSOT integration",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
"license": "MIT",
|
|
64
64
|
"dependencies": {
|
|
65
65
|
"chalk": "^5.3.0",
|
|
66
|
-
"cli-contracts": "^0.
|
|
66
|
+
"cli-contracts": "^0.30.2",
|
|
67
67
|
"commander": "^12.1.0",
|
|
68
68
|
"embedoc": "^0.10.1",
|
|
69
69
|
"glob": "^10.3.10",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"zod": "^3.22.4"
|
|
74
74
|
},
|
|
75
75
|
"peerDependencies": {
|
|
76
|
-
"agent-contracts-runtime": ">=0.
|
|
76
|
+
"agent-contracts-runtime": ">=0.30.0"
|
|
77
77
|
},
|
|
78
78
|
"peerDependenciesMeta": {
|
|
79
79
|
"agent-contracts-runtime": {
|
|
@@ -87,8 +87,8 @@
|
|
|
87
87
|
"@typescript-eslint/eslint-plugin": "^8.54.0",
|
|
88
88
|
"@typescript-eslint/parser": "^8.54.0",
|
|
89
89
|
"@vitest/coverage-v8": "^1.6.1",
|
|
90
|
-
"agent-contracts": "^0.
|
|
91
|
-
"agent-contracts-runtime": "^0.
|
|
90
|
+
"agent-contracts": "^0.30.1",
|
|
91
|
+
"agent-contracts-runtime": "^0.30.0",
|
|
92
92
|
"eslint": "^9.39.2",
|
|
93
93
|
"tsup": "^8.0.1",
|
|
94
94
|
"typescript": "^5.3.3",
|