@specferret/core 0.1.1 → 0.1.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.
- package/README.md +47 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,20 @@
|
|
|
1
1
|
# @specferret/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Core engine for SpecFerret contract extraction, validation, graph reconciliation, and drift analysis.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@specferret/core)
|
|
6
|
+
[](../../LICENSE)
|
|
7
|
+
|
|
8
|
+
## What this package is for
|
|
9
|
+
|
|
10
|
+
`@specferret/core` is the runtime library behind the CLI. Use it when you want to embed SpecFerret behavior in scripts, custom tooling, or internal workflows.
|
|
11
|
+
|
|
12
|
+
It includes:
|
|
13
|
+
|
|
14
|
+
- Store implementations (`sqlite`, `postgres`)
|
|
15
|
+
- Frontmatter extraction and schema validation
|
|
16
|
+
- Reconciler logic for direct/transitive impact
|
|
17
|
+
- Context graph generation utilities
|
|
4
18
|
|
|
5
19
|
## Install
|
|
6
20
|
|
|
@@ -8,18 +22,41 @@ SpecFerret core engine for contract extraction, validation, storage, and reconci
|
|
|
8
22
|
npm i @specferret/core
|
|
9
23
|
```
|
|
10
24
|
|
|
11
|
-
## Runtime
|
|
25
|
+
## Runtime requirements
|
|
12
26
|
|
|
13
|
-
|
|
27
|
+
- Bun 1.0+
|
|
14
28
|
|
|
15
|
-
|
|
29
|
+
SpecFerret core is Bun-first and uses Bun-compatible runtime behavior.
|
|
16
30
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
31
|
+
## Typical consumers
|
|
32
|
+
|
|
33
|
+
- Internal platform tooling that needs drift checks in-process
|
|
34
|
+
- CI wrappers that need machine-readable drift metadata
|
|
35
|
+
- Custom developer workflows on top of SpecFerret reconciliation data
|
|
36
|
+
|
|
37
|
+
## Validation status
|
|
38
|
+
|
|
39
|
+
Core behavior is validated through the Sprint 5 external branch-matrix harness (spec-kit + BMAD), including explicit assertions for:
|
|
40
|
+
|
|
41
|
+
- S40 transitive depth thresholds
|
|
42
|
+
- S41 review proof artifacts
|
|
43
|
+
- S42 extract determinism
|
|
44
|
+
|
|
45
|
+
Latest green runs:
|
|
46
|
+
|
|
47
|
+
- spec-kit: https://github.com/BenGardiner123/spec-ferret-validation-spec-kit/actions/runs/23962649755
|
|
48
|
+
- BMAD: https://github.com/BenGardiner123/specferret-validation-bmad/actions/runs/23962652352
|
|
49
|
+
|
|
50
|
+
## Looking for the CLI?
|
|
51
|
+
|
|
52
|
+
Install `@specferret/cli` if you want the end-user command interface:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
bun install -g @specferret/cli
|
|
56
|
+
```
|
|
21
57
|
|
|
22
|
-
##
|
|
58
|
+
## Links
|
|
23
59
|
|
|
24
60
|
- Source: https://github.com/BenGardiner123/spec-ferret
|
|
25
|
-
-
|
|
61
|
+
- Docs: https://specferret.dev
|
|
62
|
+
- CLI package: https://www.npmjs.com/package/@specferret/cli
|