@contractspec/module.lifecycle-advisor 3.7.5 → 3.7.7
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 +43 -42
- package/dist/browser/index.js +382 -385
- package/dist/i18n/catalogs/index.d.ts +1 -1
- package/dist/i18n/index.d.ts +7 -7
- package/dist/i18n/locale.d.ts +1 -1
- package/dist/index.d.ts +5 -5
- package/dist/index.js +382 -385
- package/dist/node/index.js +382 -385
- package/package.json +7 -7
- package/src/data/library-stage-map.ts +117 -117
- package/src/data/stage-playbooks.ts +265 -265
package/README.md
CHANGED
|
@@ -1,63 +1,64 @@
|
|
|
1
1
|
# @contractspec/module.lifecycle-advisor
|
|
2
2
|
|
|
3
|
-
Website: https://contractspec.io
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
Guidance layer for the ContractSpec lifecycle engine. Converts assessments into recommended actions, library adoption plans, and ceremony payloads.
|
|
7
|
-
|
|
8
|
-
## Exports
|
|
9
|
-
|
|
10
|
-
- `LifecycleRecommendationEngine`
|
|
11
|
-
- `ContractSpecLibraryRecommender`
|
|
12
|
-
- `LifecycleCeremonyDesigner`
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
import {
|
|
18
|
-
LifecycleRecommendationEngine,
|
|
19
|
-
ContractSpecLibraryRecommender,
|
|
20
|
-
LifecycleCeremonyDesigner,
|
|
21
|
-
} from '@contractspec/module.lifecycle-advisor';
|
|
22
|
-
|
|
23
|
-
const recommendationEngine = new LifecycleRecommendationEngine();
|
|
24
|
-
const libraryRecommender = new ContractSpecLibraryRecommender();
|
|
25
|
-
const ceremonyDesigner = new LifecycleCeremonyDesigner();
|
|
26
|
-
|
|
27
|
-
const recommendations = recommendationEngine.generate(assessment);
|
|
28
|
-
const libraries = libraryRecommender.recommend(assessment.stage);
|
|
29
|
-
const ceremony = ceremonyDesigner.design(assessment.stage);
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Data is stored in JSON playbooks so ContractSpec teams can update copy or mappings without redeploying code.*** End Patch
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
3
|
+
Website: https://contractspec.io
|
|
45
4
|
|
|
5
|
+
**AI-powered lifecycle recommendations and guidance.**
|
|
46
6
|
|
|
7
|
+
## What It Provides
|
|
47
8
|
|
|
9
|
+
- **Layer**: module.
|
|
10
|
+
- **Consumers**: bundles (library, contractspec-studio), apps (web-landing, cli).
|
|
11
|
+
- Related ContractSpec packages include `@contractspec/lib.contracts-spec`, `@contractspec/lib.lifecycle`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
|
|
12
|
+
- Related ContractSpec packages include `@contractspec/lib.contracts-spec`, `@contractspec/lib.lifecycle`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
|
|
48
13
|
|
|
14
|
+
## Installation
|
|
49
15
|
|
|
16
|
+
`npm install @contractspec/module.lifecycle-advisor`
|
|
50
17
|
|
|
18
|
+
or
|
|
51
19
|
|
|
20
|
+
`bun add @contractspec/module.lifecycle-advisor`
|
|
52
21
|
|
|
22
|
+
## Usage
|
|
53
23
|
|
|
24
|
+
Import the root entrypoint from `@contractspec/module.lifecycle-advisor`, or choose a documented subpath when you only need one part of the package surface.
|
|
54
25
|
|
|
26
|
+
## Architecture
|
|
55
27
|
|
|
28
|
+
- `src/ceremony` is part of the package's public or composition surface.
|
|
29
|
+
- `src/data/` contains static content, registries, and package-local datasets.
|
|
30
|
+
- `src/i18n` is part of the package's public or composition surface.
|
|
31
|
+
- `src/index.ts` is the root public barrel and package entrypoint.
|
|
32
|
+
- `src/recommendations` is part of the package's public or composition surface.
|
|
56
33
|
|
|
34
|
+
## Public Entry Points
|
|
57
35
|
|
|
36
|
+
- Export `.` resolves through `./src/index.ts`.
|
|
58
37
|
|
|
38
|
+
## Local Commands
|
|
59
39
|
|
|
40
|
+
- `bun run dev` — contractspec-bun-build dev
|
|
41
|
+
- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
|
|
42
|
+
- `bun run test` — bun test
|
|
43
|
+
- `bun run lint` — bun lint:fix
|
|
44
|
+
- `bun run lint:check` — biome check .
|
|
45
|
+
- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
|
|
46
|
+
- `bun run typecheck` — tsc --noEmit
|
|
47
|
+
- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
|
|
48
|
+
- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
|
|
49
|
+
- `bun run clean` — rimraf dist .turbo
|
|
50
|
+
- `bun run build:bundle` — contractspec-bun-build transpile
|
|
51
|
+
- `bun run build:types` — contractspec-bun-build types
|
|
52
|
+
- `bun run prebuild` — contractspec-bun-build prebuild
|
|
60
53
|
|
|
54
|
+
## Recent Updates
|
|
61
55
|
|
|
56
|
+
- Replace eslint+prettier by biomejs to optimize speed.
|
|
57
|
+
- Fix small issues.
|
|
58
|
+
- Add full i18n support across all 10 packages (en/fr/es, 460 keys).
|
|
62
59
|
|
|
60
|
+
## Notes
|
|
63
61
|
|
|
62
|
+
- Depends on `lib.lifecycle` for stage definitions -- never redefine stages here.
|
|
63
|
+
- Recommendation data lives in `src/data/`; keep data files declarative and serializable.
|
|
64
|
+
- Advisory outputs must be deterministic for the same input state.
|