@descent-vtt/spec-harness 0.9.0 → 0.10.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.
@@ -7,6 +7,22 @@ description: Split a goal too large for one round into briefs - each a small, se
7
7
 
8
8
  You decide what the pieces are; the tools decide whether the plan holds.
9
9
 
10
+ ## Before any command
11
+
12
+ Run every command below as written, from the repository's root. Each gives
13
+ `npx` the package's full name behind `--no-install`, so it runs the tool this
14
+ project installed and fetches nothing.
15
+
16
+ If one stops with `npx canceled due to missing packages`, the project's
17
+ dependencies are not installed in this work tree - a fresh clone, a new
18
+ worktree - or you are not at its root. Install them there, as with `npm ci`,
19
+ and run the command again; if that fails, stop and tell the person.
20
+
21
+ Never work around it by dropping `--no-install` or the `@descent-vtt/` in
22
+ front of the name. Without the scope the names are not these tools: on npm
23
+ `spec-harness` is another publisher's package, and `npx` would fetch it and
24
+ run it.
25
+
10
26
  ## 1. Cut along files and decisions
11
27
 
12
28
  - One brief, one outcome a reviewer can judge on its own. Prefer rounds that
@@ -21,8 +37,8 @@ You decide what the pieces are; the tools decide whether the plan holds.
21
37
  ## 2. Let the tools place the waves
22
38
 
23
39
  ```bash
24
- npx spec-brief schedule --format json # if this version has it
25
- npx spec-brief matrix --all-waves # otherwise: which pairs collide
40
+ npx --no-install @descent-vtt/spec-brief schedule --format json # if this version has it
41
+ npx --no-install @descent-vtt/spec-brief matrix --all-waves # otherwise: which pairs collide
26
42
  ```
27
43
 
28
44
  A wave may run in parallel only if no two of its briefs can name the same
@@ -32,7 +48,7 @@ narrowing a scope, by adding a `dependsOn`, or by moving a brief to a later
32
48
  wave - never by leaving it for merge time.
33
49
 
34
50
  ```bash
35
- npx spec-brief lint --format json # no cycles, waves in dependency order
51
+ npx --no-install @descent-vtt/spec-brief lint --format json # no cycles, waves in dependency order
36
52
  ```
37
53
 
38
54
  ## 3. Present the plan