@teurons/vds 0.0.5 → 0.0.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 +28 -6
- package/dist/CHANGELOG.md +114 -0
- package/dist/vds.js +44670 -136
- package/dist/vds_mapper.wasm +0 -0
- package/package.json +4 -5
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Copy this prompt into Claude Code, Codex or any coding agent, run from the root
|
|
|
13
13
|
```text
|
|
14
14
|
Set up VDS in this project.
|
|
15
15
|
|
|
16
|
-
1. Run `npx -y @teurons/vds init vds-workspace`. It creates the
|
|
16
|
+
1. Run `npx -y @teurons/vds@latest init vds-workspace`. It creates the
|
|
17
17
|
capabilities, flows and scenarios folders, a VDS.md guide and a .vds.json.
|
|
18
18
|
If it says a workspace already exists, stop and tell me what it found.
|
|
19
19
|
2. Add `"vds": "vds"` to package.json scripts and @teurons/vds to
|
|
@@ -25,16 +25,38 @@ Set up VDS in this project.
|
|
|
25
25
|
vds-workspace/VDS.md before changing it; run `vds index vds-workspace`
|
|
26
26
|
first and `vds check vds-workspace` before finishing.
|
|
27
27
|
5. Run `npx @teurons/vds check vds-workspace` and confirm it prints valid.
|
|
28
|
+
Then tell me to run `npx @teurons/vds run local` to open the studio, and
|
|
29
|
+
offer to connect yourself to its MCP at the address it prints.
|
|
28
30
|
6. Tell me what you created and changed, file by file.
|
|
29
31
|
```
|
|
30
32
|
|
|
33
|
+
## Upgrade with your AI agent
|
|
34
|
+
|
|
35
|
+
Copy this prompt into your coding agent, run from the root of your project:
|
|
36
|
+
|
|
37
|
+
```text
|
|
38
|
+
Upgrade VDS in this project.
|
|
39
|
+
|
|
40
|
+
1. Run `npx -y @teurons/vds@latest update`. It installs the newest vds,
|
|
41
|
+
migrates the workspace, refreshes VDS.md and prints the changelog for
|
|
42
|
+
every version it crossed.
|
|
43
|
+
2. Do every agent step it printed, in order, oldest version first.
|
|
44
|
+
3. Read vds-workspace/VDS.md again.
|
|
45
|
+
4. Run `npx @teurons/vds check vds-workspace` and confirm it prints valid.
|
|
46
|
+
5. Tell me which versions you crossed and which files changed.
|
|
47
|
+
```
|
|
48
|
+
|
|
31
49
|
## Commands
|
|
32
50
|
|
|
33
51
|
```sh
|
|
34
|
-
npx @teurons/vds init [folder]
|
|
35
|
-
npx @teurons/vds check [folder]
|
|
36
|
-
npx @teurons/vds index [folder]
|
|
37
|
-
npx @teurons/vds
|
|
52
|
+
npx @teurons/vds init [folder] # start a workspace (never overwrites one)
|
|
53
|
+
npx @teurons/vds check [folder] # print every problem; exit 1 if any
|
|
54
|
+
npx @teurons/vds index [folder] # print the index: every flow and rule, one line each
|
|
55
|
+
npx @teurons/vds run local [folder] # the studio on localhost, with an MCP for your AI app at /mcp
|
|
56
|
+
npx @teurons/vds built <flow> [folder] # mark a flow's current version built, with who and when
|
|
57
|
+
npx @teurons/vds evidence <report> [folder] # record a test run (JUnit XML or Vitest JSON) as evidence
|
|
58
|
+
npx @teurons/vds changelog [--since x.y.z] # print the changelog, or only the versions after x.y.z
|
|
59
|
+
npx @teurons/vds update [folder] # install the newest vds, migrate the workspace, refresh VDS.md, print what changed
|
|
38
60
|
```
|
|
39
61
|
|
|
40
62
|
`folder` defaults to the current folder, or to `vds-workspace` inside it when the current folder
|
|
@@ -45,7 +67,7 @@ is not a workspace itself. So from your project root, `vds check` checks `vds-wo
|
|
|
45
67
|
```text
|
|
46
68
|
vds-workspace/
|
|
47
69
|
VDS.md how agents and people work on this spec
|
|
48
|
-
.vds.json local settings: the port the local studio
|
|
70
|
+
.vds.json local settings: the port the local studio uses
|
|
49
71
|
capabilities/<CODE>.yaml rules, each one EARS statement with an id like ONB-01
|
|
50
72
|
flows/<id>.yaml versioned flows whose steps point at rule ids
|
|
51
73
|
scenarios/<RULE-ID>.feature Gherkin scenarios, one file per rule
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
Every release of `@teurons/vds`, newest first.
|
|
4
|
+
|
|
5
|
+
Each release has two parts:
|
|
6
|
+
|
|
7
|
+
- **What changed**, written for people.
|
|
8
|
+
- **Agent steps**, written for the AI agent that maintains a workspace.
|
|
9
|
+
They list what to do after upgrading to this version.
|
|
10
|
+
`vds update` prints both parts for every version between the one you had
|
|
11
|
+
and the one it installed.
|
|
12
|
+
"None" means there is nothing to do.
|
|
13
|
+
|
|
14
|
+
## 0.0.7 (2026-11-02)
|
|
15
|
+
|
|
16
|
+
### What changed
|
|
17
|
+
|
|
18
|
+
- `vds evidence <report>` records a test run (JUnit XML or Vitest JSON) as evidence for the scenarios
|
|
19
|
+
whose ids appear in test names. The studio ticks the steps that have passing evidence.
|
|
20
|
+
- Flows have versions. When a rule a flow depends on changes, the flow's version changes with it.
|
|
21
|
+
`vds built <flow>` marks a flow's current version built, with who and when. The studio shows a
|
|
22
|
+
compare view between versions, with the flows a rule change touched listed first.
|
|
23
|
+
- `vds update` now prints the changelog for every version it crosses, with the agent steps marked,
|
|
24
|
+
and runs code migrations for any version that changes the workspace format, printing each file it
|
|
25
|
+
moves or rewrites. `vds changelog [--since x.y.z]` prints the changelog on demand. Releases are
|
|
26
|
+
versioned and their changelog entries are written with Changesets.
|
|
27
|
+
|
|
28
|
+
### Agent steps
|
|
29
|
+
|
|
30
|
+
- Name each test after its scenario id, for example `CLI-07-01 older version installed`.
|
|
31
|
+
- After upgrading, run your test suite with a JUnit or Vitest JSON reporter and record it with `vds evidence <report-file>`.
|
|
32
|
+
- Run `vds built <flow>` for each flow you have already built, so changes after this point show up as impact.
|
|
33
|
+
- Run `npx -y @teurons/vds@latest update` and do every agent step it prints, oldest version first.
|
|
34
|
+
|
|
35
|
+
## 0.0.6 (2026-11-03)
|
|
36
|
+
|
|
37
|
+
### What changed
|
|
38
|
+
|
|
39
|
+
- `vds run local` starts the studio on your machine, on the port in
|
|
40
|
+
`.vds.json`, or the next free port if that one is taken.
|
|
41
|
+
- The studio shows the flows, each flow page, its steps and rules, and the
|
|
42
|
+
product-wide rules. It redraws within a second of a file changing, and it
|
|
43
|
+
shows the checker's problems on every page without stopping.
|
|
44
|
+
- An MCP at `http://localhost:<port>/mcp` lets your AI app read and write the
|
|
45
|
+
workspace. The checker runs on every write and refuses a write that adds a
|
|
46
|
+
problem, naming each one.
|
|
47
|
+
- Plain lines drop every "SHALL", including one after a comma.
|
|
48
|
+
- `vds init` prints the command and the address for the studio.
|
|
49
|
+
|
|
50
|
+
### Agent steps
|
|
51
|
+
|
|
52
|
+
- Offer to connect yourself to the local MCP at the address `vds run local`
|
|
53
|
+
prints. Once connected, write through `vds_write` and `vds_delete` rather
|
|
54
|
+
than editing spec files directly, so the checker guards each change.
|
|
55
|
+
|
|
56
|
+
## 0.0.5 (2026-11-03)
|
|
57
|
+
|
|
58
|
+
### What changed
|
|
59
|
+
|
|
60
|
+
- `vds check`, `vds index` and `vds update` with no folder named use the
|
|
61
|
+
current folder if it is a workspace, else its `vds-workspace` folder.
|
|
62
|
+
|
|
63
|
+
### Agent steps
|
|
64
|
+
|
|
65
|
+
- In the project's AGENTS.md or CLAUDE.md, `vds check vds-workspace` can
|
|
66
|
+
become `vds check` when run from the project root. Optional.
|
|
67
|
+
|
|
68
|
+
## 0.0.4 (2026-11-03)
|
|
69
|
+
|
|
70
|
+
### What changed
|
|
71
|
+
|
|
72
|
+
- `vds update` installs the newest version and refreshes VDS.md.
|
|
73
|
+
- VDS.md now starts with a line naming the version that wrote it.
|
|
74
|
+
|
|
75
|
+
### Agent steps
|
|
76
|
+
|
|
77
|
+
- Run `npx @teurons/vds@latest update` once. It adds the version line to
|
|
78
|
+
VDS.md. Read the new VDS.md afterwards.
|
|
79
|
+
|
|
80
|
+
## 0.0.3 (2026-11-03)
|
|
81
|
+
|
|
82
|
+
### What changed
|
|
83
|
+
|
|
84
|
+
- Every release is published as `latest`, so a plain `npx @teurons/vds`
|
|
85
|
+
gets the newest version.
|
|
86
|
+
- The README carries a set-up prompt for AI agents.
|
|
87
|
+
|
|
88
|
+
### Agent steps
|
|
89
|
+
|
|
90
|
+
None.
|
|
91
|
+
|
|
92
|
+
## 0.0.2 (2026-11-03)
|
|
93
|
+
|
|
94
|
+
### What changed
|
|
95
|
+
|
|
96
|
+
- `vds init` starts a workspace: capabilities, flows and scenarios folders,
|
|
97
|
+
a VDS.md guide for agents, and a `.vds.json` holding the studio port. It
|
|
98
|
+
never overwrites an existing workspace.
|
|
99
|
+
- The published package no longer carries paths from the build machine.
|
|
100
|
+
|
|
101
|
+
### Agent steps
|
|
102
|
+
|
|
103
|
+
None.
|
|
104
|
+
|
|
105
|
+
## 0.0.1 (2026-11-02)
|
|
106
|
+
|
|
107
|
+
### What changed
|
|
108
|
+
|
|
109
|
+
- `vds check` checks every capability, flow and scenario in a folder.
|
|
110
|
+
- `vds index` prints the workspace's index, one line per flow and rule.
|
|
111
|
+
|
|
112
|
+
### Agent steps
|
|
113
|
+
|
|
114
|
+
None.
|