@printpractical/cruze 0.0.8 → 0.0.10

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.
Files changed (152) hide show
  1. package/README.md +17 -13
  2. package/dist/adapters/inbound/cli/cli_context.js +6 -0
  3. package/dist/adapters/inbound/cli/commands/code.js +2 -1
  4. package/dist/adapters/inbound/cli/commands/diff.js +23 -0
  5. package/dist/adapters/inbound/cli/commands/documents.js +1 -1
  6. package/dist/adapters/inbound/cli/commands/show.js +72 -3
  7. package/dist/adapters/inbound/cli/commands/status.js +7 -3
  8. package/dist/adapters/inbound/cli/commands.js +9 -3
  9. package/dist/adapters/inbound/cli/parse_command.js +8 -0
  10. package/dist/adapters/outbound/git_repository.js +49 -7
  11. package/dist/adapters/outbound/project_root.js +13 -0
  12. package/dist/app/ports/repository.js +4 -0
  13. package/dist/app/use_cases/approve_artifact.js +18 -10
  14. package/dist/app/use_cases/check_code.js +5 -3
  15. package/dist/app/use_cases/journal_events.js +6 -2
  16. package/dist/app/use_cases/new_project_doc.js +10 -2
  17. package/dist/app/use_cases/project_status.js +4 -1
  18. package/dist/app/use_cases/run_review.js +10 -2
  19. package/dist/app/use_cases/show_elements.js +18 -0
  20. package/dist/app/use_cases/show_notes.js +11 -0
  21. package/dist/app/use_cases/show_scope.js +17 -1
  22. package/dist/app/use_cases/upstream_diff.js +55 -0
  23. package/dist/domain/approvals/rebase.js +39 -0
  24. package/dist/domain/approvals/upstream_text.js +36 -0
  25. package/dist/domain/check/budget_text.js +43 -6
  26. package/dist/domain/check/check_source.js +20 -3
  27. package/dist/domain/check/decision_comments.js +38 -0
  28. package/dist/domain/config.js +12 -0
  29. package/dist/domain/decision_citations.js +62 -0
  30. package/dist/domain/edits/agents_file.js +15 -1
  31. package/dist/domain/ids.js +3 -1
  32. package/dist/domain/journal.js +16 -3
  33. package/dist/domain/land/merge_plan.js +7 -2
  34. package/dist/domain/line_diff.js +56 -0
  35. package/dist/domain/project/element_lookup.js +124 -0
  36. package/dist/domain/project/living_model.js +2 -1
  37. package/dist/domain/project/notes.js +74 -0
  38. package/dist/domain/project/scope_view.js +20 -4
  39. package/dist/domain/skill_budget.js +36 -0
  40. package/dist/domain/status/next_step.js +52 -7
  41. package/dist/domain/status/pending_rethink.js +22 -0
  42. package/dist/domain/status/verification.js +12 -0
  43. package/dist/domain/status/work_status.js +17 -2
  44. package/dist/domain/validation/decision_rules.js +76 -0
  45. package/dist/domain/validation/delta_rules.js +2 -0
  46. package/dist/domain/validation/future_rules.js +40 -0
  47. package/dist/domain/validation/living_rules.js +2 -0
  48. package/dist/domain/validation/plan_rules.js +1 -1
  49. package/dist/domain/validation/validate_project.js +4 -0
  50. package/dist/domain/validation/vision_rules.js +41 -0
  51. package/dist/domain/versions/rule_versions.js +3 -0
  52. package/dist/main.js +8 -4
  53. package/package.json +1 -1
  54. package/skills/architect/SKILL.md +6 -2
  55. package/skills/architect/feature.md +6 -4
  56. package/skills/architect/project.md +2 -2
  57. package/skills/behavioural-testing/SKILL.md +3 -2
  58. package/skills/behavioural-testing/fakes.md +3 -3
  59. package/skills/build/SKILL.md +3 -2
  60. package/skills/envision/SKILL.md +3 -2
  61. package/skills/envision/feature.md +3 -1
  62. package/skills/envision/intake.md +28 -0
  63. package/skills/envision/possibilities.md +13 -0
  64. package/skills/envision/project.md +5 -3
  65. package/skills/explore/SKILL.md +2 -2
  66. package/skills/formats/SKILL.md +13 -2
  67. package/skills/formats/reference/architecture.md +8 -4
  68. package/skills/formats/reference/config.md +9 -4
  69. package/skills/formats/reference/durable-docs.md +4 -1
  70. package/skills/formats/reference/work-items.md +1 -1
  71. package/skills/formats/templates/vision.md +12 -0
  72. package/skills/grilling/SKILL.md +10 -0
  73. package/skills/hexagonal-design/SKILL.md +2 -2
  74. package/skills/hexagonal-design/languages/rust.md +2 -1
  75. package/skills/hexagonal-design/runtime.md +1 -0
  76. package/skills/land/SKILL.md +6 -2
  77. package/skills/plan/SKILL.md +15 -5
  78. package/skills/plan/tasks.md +4 -4
  79. package/skills/realign/SKILL.md +5 -3
  80. package/skills/realign/notes/0.0.10.md +131 -0
  81. package/skills/realign/notes/0.0.2.md +1 -1
  82. package/skills/realign/notes/0.0.6.md +1 -1
  83. package/skills/realign/notes/0.0.8.md +2 -2
  84. package/skills/realign/notes/0.0.9.md +59 -0
  85. package/skills/realign/notes.md +2 -0
  86. package/skills/research/SKILL.md +3 -2
  87. package/skills/rethink/SKILL.md +6 -4
  88. package/skills/rethink/levels.md +8 -8
  89. package/skills/roadmap/SKILL.md +2 -1
  90. package/skills/roles/SKILL.md +4 -4
  91. package/skills/roles/auditor.md +1 -1
  92. package/skills/roles/code-reviewer.md +5 -4
  93. package/skills/roles/design-reviewer.md +5 -29
  94. package/skills/roles/design-rubric.md +40 -0
  95. package/skills/roles/plan-rubric.md +11 -0
  96. package/skills/roles/surveyor.md +3 -2
  97. package/skills/roles/verifier.md +2 -0
  98. package/skills/triage/SKILL.md +1 -1
  99. package/skills/verify/SKILL.md +3 -3
  100. package/src/adapters/inbound/cli/cli_context.ts +6 -0
  101. package/src/adapters/inbound/cli/commands/code.ts +2 -1
  102. package/src/adapters/inbound/cli/commands/diff.ts +23 -0
  103. package/src/adapters/inbound/cli/commands/documents.ts +1 -1
  104. package/src/adapters/inbound/cli/commands/show.ts +72 -3
  105. package/src/adapters/inbound/cli/commands/status.ts +7 -3
  106. package/src/adapters/inbound/cli/commands.ts +9 -3
  107. package/src/adapters/inbound/cli/parse_command.ts +8 -0
  108. package/src/adapters/outbound/git_repository.ts +49 -7
  109. package/src/adapters/outbound/project_root.ts +13 -0
  110. package/src/app/ports/repository.ts +4 -0
  111. package/src/app/use_cases/approve_artifact.ts +18 -10
  112. package/src/app/use_cases/check_code.ts +5 -3
  113. package/src/app/use_cases/journal_events.ts +6 -2
  114. package/src/app/use_cases/new_project_doc.ts +10 -2
  115. package/src/app/use_cases/project_status.ts +4 -1
  116. package/src/app/use_cases/run_review.ts +10 -2
  117. package/src/app/use_cases/show_elements.ts +18 -0
  118. package/src/app/use_cases/show_notes.ts +11 -0
  119. package/src/app/use_cases/show_scope.ts +17 -1
  120. package/src/app/use_cases/upstream_diff.ts +55 -0
  121. package/src/domain/approvals/rebase.ts +39 -0
  122. package/src/domain/approvals/upstream_text.ts +36 -0
  123. package/src/domain/check/budget_text.ts +43 -6
  124. package/src/domain/check/check_source.ts +20 -3
  125. package/src/domain/check/decision_comments.ts +38 -0
  126. package/src/domain/config.ts +12 -0
  127. package/src/domain/decision_citations.ts +62 -0
  128. package/src/domain/edits/agents_file.ts +15 -1
  129. package/src/domain/ids.ts +3 -1
  130. package/src/domain/journal.ts +16 -3
  131. package/src/domain/land/merge_plan.ts +7 -2
  132. package/src/domain/line_diff.ts +56 -0
  133. package/src/domain/project/element_lookup.ts +124 -0
  134. package/src/domain/project/living_model.ts +2 -1
  135. package/src/domain/project/notes.ts +74 -0
  136. package/src/domain/project/scope_view.ts +20 -4
  137. package/src/domain/skill_budget.ts +36 -0
  138. package/src/domain/status/next_step.ts +52 -7
  139. package/src/domain/status/pending_rethink.ts +22 -0
  140. package/src/domain/status/verification.ts +12 -0
  141. package/src/domain/status/work_status.ts +17 -2
  142. package/src/domain/validation/decision_rules.ts +76 -0
  143. package/src/domain/validation/delta_rules.ts +2 -0
  144. package/src/domain/validation/future_rules.ts +40 -0
  145. package/src/domain/validation/living_rules.ts +2 -0
  146. package/src/domain/validation/plan_rules.ts +1 -1
  147. package/src/domain/validation/validate_project.ts +4 -0
  148. package/src/domain/validation/vision_rules.ts +41 -0
  149. package/src/domain/versions/rule_versions.ts +3 -0
  150. package/src/main.ts +8 -4
  151. package/templates/init/AGENTS.md +1 -1
  152. package/templates/init/config.yaml +5 -4
@@ -0,0 +1,39 @@
1
+ import { elementHash } from "../hashing.ts";
2
+ import type { MarkdownDoc } from "../markdown.ts";
3
+ import { readDelta } from "../project/deltas.ts";
4
+ import { approvalFolder, type ProjectView } from "../project/project_view.ts";
5
+ import type { WorkItem } from "../project/work_items.ts";
6
+ import { latestApproval } from "./records.ts";
7
+
8
+ /**
9
+ * Delta elements a feature or standalone change merged and hasn't changed since. The merge did
10
+ * their job, so the living text is the one to keep: an edit there by a rethink, a realign or
11
+ * another land asks nothing of the delta. One project's delta went stale this way, and every
12
+ * later edit of an element its first change had merged forced a rebase of text with no work left in it.
13
+ */
14
+ export function settledIds(doc: MarkdownDoc, merged: Record<string, string>): Set<string> {
15
+ const settled = new Set<string>();
16
+ for (const entry of readDelta(doc).entries) {
17
+ for (const element of [entry.element, ...entry.scenarios]) {
18
+ if (merged[element.id] === elementHash(doc, element)) settled.add(element.id);
19
+ }
20
+ }
21
+ return settled;
22
+ }
23
+
24
+ /**
25
+ * Elements the work's delta still changes whose living text moved since its last approval:
26
+ * approving the delta as it stands would overwrite that edit. A change's own approval pins no delta.
27
+ */
28
+ export function rebaseNeeded(view: ProjectView, item: WorkItem): string[] {
29
+ if (item.kind === "change") return [];
30
+ const file = view.approvals.get(approvalFolder(view, item.path));
31
+ const previous = file === undefined ? undefined : latestApproval(file, item.path);
32
+ if (previous === undefined) return [];
33
+ const settled = settledIds(item.doc, file?.merged ?? {});
34
+ return [...readDelta(item.doc).ids].filter((id) => {
35
+ const living = view.living.elements.get(id);
36
+ const before = previous.upstream[id];
37
+ return !settled.has(id) && living !== undefined && before !== undefined && before !== elementHash(living.doc, living.element);
38
+ });
39
+ }
@@ -0,0 +1,36 @@
1
+ import { isStatusLine } from "../elements.ts";
2
+ import { designHash, elementHash } from "../hashing.ts";
3
+ import { parseMarkdown, type MarkdownDoc } from "../markdown.ts";
4
+ import { buildLivingModel } from "../project/living_model.ts";
5
+ import type { ProjectView } from "../project/project_view.ts";
6
+
7
+ /** The document that holds an upstream key now: an element's living document, or the path of a `doc:` key. */
8
+ export function upstreamPath(view: ProjectView, key: string): string | undefined {
9
+ if (key.startsWith("doc:")) return view.snapshot.has(key.slice("doc:".length)) ? key.slice("doc:".length) : undefined;
10
+ return view.living.elements.get(key)?.path;
11
+ }
12
+
13
+ /**
14
+ * The design lines behind an upstream key in one version of the document at `path`, without the
15
+ * managed blocks and status lines no hash covers. With `pinned`, only when they hash as pinned.
16
+ */
17
+ export function upstreamLines(key: string, path: string, text: string, pinned?: string): string[] | undefined {
18
+ if (key.startsWith("doc:")) {
19
+ const doc = parseMarkdown(text);
20
+ if (pinned !== undefined && designHash(doc) !== pinned) return undefined;
21
+ return designLines(doc, 0, doc.lines.length);
22
+ }
23
+ const living = buildLivingModel(new Map([[path, text]])).elements.get(key);
24
+ if (living === undefined) return undefined;
25
+ if (pinned !== undefined && elementHash(living.doc, living.element) !== pinned) return undefined;
26
+ return designLines(living.doc, living.element.start, living.element.end);
27
+ }
28
+
29
+ function designLines(doc: MarkdownDoc, start: number, end: number): string[] {
30
+ const lines: string[] = [];
31
+ for (let i = start; i < end; i++) {
32
+ const line = doc.lines[i] ?? "";
33
+ if (!doc.inManaged[i] && (doc.inFence[i] || !isStatusLine(line))) lines.push(line);
34
+ }
35
+ return lines;
36
+ }
@@ -1,24 +1,61 @@
1
1
  /**
2
2
  * The part of a source file its budgets measure. Budgets apply to source, not tests, so a Rust
3
- * file's `#[cfg(test)]` modules are left out: rustfmt closes a top-level module with `}` in column 0.
3
+ * file's test-only modules are left out: rustfmt closes a top-level module with `}` in column 0.
4
+ * A module is test-only when its `cfg` needs `test`, as `#[cfg(test)]` or
5
+ * `#[cfg(all(test, feature = "schema"))]` do; other attributes may sit between the two.
4
6
  */
5
7
  export function budgetedText(path: string, text: string): string {
6
8
  if (!path.endsWith(".rs")) return text;
7
9
  const lines = text.split("\n");
8
10
  const kept: string[] = [];
9
11
  for (let i = 0; i < lines.length; i++) {
10
- const item = lines[i + 1] ?? "";
11
- if (lines[i]?.trim() !== "#[cfg(test)]" || !/^(?:pub(?:\([^)]*\))?\s+)?mod\s+\w+\s*[{;]/.test(item)) {
12
+ const start = testModuleStart(lines, i);
13
+ if (start === null) {
12
14
  kept.push(lines[i] ?? "");
13
15
  continue;
14
16
  }
15
- if (item.trimEnd().endsWith(";")) {
16
- i += 1;
17
+ if ((lines[start] ?? "").trimEnd().endsWith(";")) {
18
+ i = start;
17
19
  continue;
18
20
  }
19
- let end = i + 2;
21
+ let end = start + 1;
20
22
  while (end < lines.length && lines[end] !== "}") end++;
21
23
  i = end;
22
24
  }
23
25
  return kept.join("\n");
24
26
  }
27
+
28
+ /** The line of the `mod` a test-only `cfg` at `index` gates, or null when it gates no module. */
29
+ function testModuleStart(lines: string[], index: number): number | null {
30
+ if (!needsTest(lines[index]?.trim() ?? "")) return null;
31
+ let next = index + 1;
32
+ while (/^\s*#\[/.test(lines[next] ?? "")) next++;
33
+ return /^(?:pub(?:\([^)]*\))?\s+)?mod\s+\w+\s*[{;]/.test(lines[next] ?? "") ? next : null;
34
+ }
35
+
36
+ function needsTest(attribute: string): boolean {
37
+ const predicate = /^#\[cfg\((.*)\)\]$/.exec(attribute)?.[1]?.trim();
38
+ if (predicate === undefined) return false;
39
+ if (predicate === "test") return true;
40
+ const all = /^all\((.*)\)$/.exec(predicate)?.[1];
41
+ return all !== undefined && topLevelArguments(all).includes("test");
42
+ }
43
+
44
+ /** Splits `a, b(c, d), e` at its top-level commas. */
45
+ function topLevelArguments(text: string): string[] {
46
+ const parts: string[] = [];
47
+ let depth = 0;
48
+ let current = "";
49
+ for (const char of text) {
50
+ if (char === "," && depth === 0) {
51
+ parts.push(current.trim());
52
+ current = "";
53
+ continue;
54
+ }
55
+ if (char === "(") depth++;
56
+ if (char === ")") depth--;
57
+ current += char;
58
+ }
59
+ parts.push(current.trim());
60
+ return parts;
61
+ }
@@ -1,13 +1,14 @@
1
1
  import type { CruzeConfig, Layer } from "../config.ts";
2
2
  import { matchesAny } from "../glob.ts";
3
3
  import { budgetedText } from "./budget_text.ts";
4
+ import { decisionCitationsInComments } from "./decision_comments.ts";
4
5
  import { importsOf, resolveImport } from "./imports.ts";
5
6
  import { countTypes } from "./type_count.ts";
6
7
 
7
8
  export interface CheckFinding {
8
9
  path: string;
9
10
  line?: number;
10
- rule: "layer" | "max-lines" | "max-types" | "outside-module-map" | "no-layer" | "test-placement";
11
+ rule: "layer" | "max-lines" | "max-types" | "outside-module-map" | "no-layer" | "test-placement" | "decision-citation";
11
12
  message: string;
12
13
  /** Layer violations always fail; the rest fail in CI unless excepted. */
13
14
  severity: "error" | "warning";
@@ -21,6 +22,8 @@ export interface CheckInput {
21
22
  sources: ReadonlyMap<string, string>;
22
23
  /** Paths of the MOD elements in the architecture; files outside all of them are flagged. */
23
24
  modulePaths: string[];
25
+ /** Test files outside config.source, by path: only their comments are checked. */
26
+ tests?: ReadonlyMap<string, string>;
24
27
  /** Check only these files, when given; imports still resolve against every source. */
25
28
  only?: string[];
26
29
  }
@@ -55,11 +58,11 @@ export function checkSource(input: CheckInput): CheckFinding[] {
55
58
  const lines = budgeted.split("\n").length - (budgeted.endsWith("\n") ? 1 : 0);
56
59
  if (!excepted && lines > config.check.maxLines) {
57
60
  const measured = budgeted === text ? "" : ", not counting its inline tests";
58
- findings.push({ path, rule: "max-lines", severity: "warning", message: `${lines} lines${measured}, over the budget of ${config.check.maxLines}; split it by responsibility` });
61
+ findings.push({ path, rule: "max-lines", severity: "warning", message: `${lines} lines${measured}, over the budget of ${config.check.maxLines}; split it if it holds a second responsibility, or list it under check.exceptions` });
59
62
  }
60
63
  const types = countTypes(path, budgeted);
61
64
  if (!excepted && types !== null && types > config.check.maxTypes) {
62
- findings.push({ path, rule: "max-types", severity: "warning", message: `${types} top-level types, over the budget of ${config.check.maxTypes}` });
65
+ findings.push({ path, rule: "max-types", severity: "warning", message: `${types} top-level types, over the budget of ${config.check.maxTypes}; split it if it holds a second responsibility, or list it under check.exceptions` });
63
66
  }
64
67
  if (!excepted && isRustTestFileInSource(path)) {
65
68
  findings.push({ path, rule: "test-placement", severity: "warning", message: "Rust tests that leave their inline module go in the crate's tests/ directory, not under src/" });
@@ -67,10 +70,24 @@ export function checkSource(input: CheckInput): CheckFinding[] {
67
70
  if (modulePaths.length > 0 && !insideModuleMap(path, modulePaths)) {
68
71
  findings.push({ path, rule: "outside-module-map", severity: "warning", message: "the file is outside every module in the architecture's module map" });
69
72
  }
73
+ findings.push(...decisionFindings(path, text));
74
+ }
75
+ for (const [path, text] of input.tests ?? []) {
76
+ if (!sources.has(path) && (input.only === undefined || input.only.includes(path))) findings.push(...decisionFindings(path, text));
70
77
  }
71
78
  return findings;
72
79
  }
73
80
 
81
+ function decisionFindings(path: string, text: string): CheckFinding[] {
82
+ return decisionCitationsInComments(path, text).map((citation) => ({
83
+ path,
84
+ line: citation.line + 1,
85
+ rule: "decision-citation",
86
+ severity: "warning",
87
+ message: `the comment cites ${citation.text}, a decision number a reader of the code can't follow; say what was decided, or cite the element or ADR that holds it`,
88
+ }));
89
+ }
90
+
74
91
  /** Whether a module's Path covers the file: a directory path ending in `/` covers everything under it, any other names one file. */
75
92
  export function insideModuleMap(path: string, modulePaths: string[]): boolean {
76
93
  return modulePaths.some((module) => (module.endsWith("/") ? path.startsWith(module) : path === module));
@@ -0,0 +1,38 @@
1
+ import { findDecisionCitations, type DecisionCitation } from "../decision_citations.ts";
2
+
3
+ const HASH_COMMENTS = new Set(["py", "rb", "sh", "bash", "zsh", "pl", "r", "ex", "exs", "jl", "nim", "cr", "ps1"]);
4
+ const DASH_COMMENTS = new Set(["sql", "lua", "hs", "elm", "ada"]);
5
+
6
+ /**
7
+ * Decisions a source file's comments cite by number, such as `(D22)` or `(events D23)`. Each work
8
+ * item numbers its decisions from D1 and is archived when it finishes, so a number in code points
9
+ * at nothing a reader can find.
10
+ */
11
+ export function decisionCitationsInComments(path: string, text: string): DecisionCitation[] {
12
+ const comments = commentText(path, text.split("\n"));
13
+ return findDecisionCitations(comments, new Set());
14
+ }
15
+
16
+ /** Each line with everything but its comment blanked, so a citation's line number stays right. */
17
+ function commentText(path: string, lines: string[]): string[] {
18
+ const extension = path.slice(path.lastIndexOf(".") + 1).toLowerCase();
19
+ if (HASH_COMMENTS.has(extension)) return lines.map((line) => after(line, /(^|\s)#/));
20
+ if (DASH_COMMENTS.has(extension)) return lines.map((line) => after(line, /--/));
21
+ let inBlock = false;
22
+ return lines.map((line) => {
23
+ if (inBlock) {
24
+ if (line.includes("*/")) inBlock = false;
25
+ return line;
26
+ }
27
+ const open = line.indexOf("/*");
28
+ if (open !== -1 && !line.includes("*/", open + 2)) inBlock = true;
29
+ const slash = line.indexOf("//");
30
+ const start = [open, slash].filter((at) => at !== -1).sort((a, b) => a - b)[0];
31
+ return start === undefined ? "" : line.slice(start);
32
+ });
33
+ }
34
+
35
+ function after(line: string, marker: RegExp): string {
36
+ const match = marker.exec(line);
37
+ return match === null ? "" : line.slice(match.index);
38
+ }
@@ -26,6 +26,8 @@ export interface CruzeConfig {
26
26
  review: { command?: string[]; decide: ReviewDecide };
27
27
  /** The size band of a change, so each one is worth its own plan, review and verify. */
28
28
  changes: ChangeLimits;
29
+ /** External documents the design must comply with, such as a protocol specification, each with what it governs. */
30
+ references: Array<{ path: string; use: string }>;
29
31
  }
30
32
 
31
33
  /** Which review findings the user decides: only the exceptions, or every one. */
@@ -132,6 +134,15 @@ export function parseConfig(text: string): ConfigResult {
132
134
  }),
133
135
  };
134
136
 
137
+ const references = (Array.isArray(root["references"]) ? root["references"] : root["references"] === undefined ? [] : [null]).flatMap((entry: unknown, i: number) => {
138
+ const record = asRecord(entry);
139
+ if (typeof record?.["path"] !== "string" || record["path"].trim() === "" || typeof record["use"] !== "string" || record["use"].trim() === "") {
140
+ problems.push(`references[${i}] needs a path and a non-empty use`);
141
+ return [];
142
+ }
143
+ return [{ path: record["path"], use: record["use"] }];
144
+ });
145
+
135
146
  const config: CruzeConfig = {
136
147
  version: 1,
137
148
  ...(typeof cruze === "string" && cruze.trim() !== "" ? { cruze } : {}),
@@ -148,6 +159,7 @@ export function parseConfig(text: string): ConfigResult {
148
159
  decide: decide === "all" ? "all" : "exceptions",
149
160
  },
150
161
  changes,
162
+ references,
151
163
  };
152
164
  return { config, problems };
153
165
  }
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Settled decisions are numbered `D<n>` within the document that records them: the architecture's
3
+ * `## Decisions`, or one feature or change, which is archived when it finishes. A number cited
4
+ * anywhere else either dangles or silently means another document's decision.
5
+ */
6
+
7
+ /** One citation of decisions by number, such as `D5`, `D5, D19` or `events D17`. */
8
+ export interface DecisionCitation {
9
+ /** 0-based line. */
10
+ line: number;
11
+ text: string;
12
+ numbers: number[];
13
+ /** The work item named with it, as in `events D17` or `D1 of 02-links`. */
14
+ qualifier?: string;
15
+ }
16
+
17
+ const SLUG = "[a-z0-9]+(?:-[a-z0-9]+)*";
18
+ const CITATION = new RegExp(`(?:(?<![\\w-])(${SLUG})\\s+)?(?<![\\w-])(D\\d+(?:\\s*(?:,|and)\\s*D\\d+)*)(?![\\w-])(?:\\s+of\\s+(${SLUG}))?`, "g");
19
+ const DEFINITION = /^\s*- D(\d+):/;
20
+
21
+ /**
22
+ * Every citation of decisions by number in the lines given, skipping the `- D<n>:` that defines one
23
+ * and anything inside backticks. `slugs` are the work items a citation may name.
24
+ */
25
+ export function findDecisionCitations(lines: readonly string[], slugs: ReadonlySet<string>, skip: (line: number) => boolean = () => false): DecisionCitation[] {
26
+ const citations: DecisionCitation[] = [];
27
+ lines.forEach((raw, line) => {
28
+ if (skip(line)) return;
29
+ const text = raw.replace(DEFINITION, (m) => " ".repeat(m.length)).replace(/`[^`]*`/g, (m) => " ".repeat(m.length));
30
+ for (const match of text.matchAll(CITATION)) {
31
+ const before = match[1] !== undefined && slugs.has(match[1]) ? match[1] : undefined;
32
+ const after = match[3] !== undefined && slugs.has(match[3]) ? match[3] : undefined;
33
+ const numbers = [...(match[2] ?? "").matchAll(/D(\d+)/g)].map((m) => Number(m[1]));
34
+ const qualifier = before ?? after;
35
+ const cited = qualifier === undefined ? (match[2] ?? "") : (match[0] ?? "").trim();
36
+ citations.push(qualifier === undefined ? { line, text: cited, numbers } : { line, text: cited, numbers, qualifier });
37
+ }
38
+ });
39
+ return citations;
40
+ }
41
+
42
+ /** The decisions a `## Decisions` section, or any lines, define as `- D<n>: ...`. */
43
+ export function definedDecisions(lines: readonly string[]): Set<number> {
44
+ return new Set(lines.flatMap((line) => {
45
+ const match = DEFINITION.exec(line);
46
+ return match?.[1] === undefined ? [] : [Number(match[1])];
47
+ }));
48
+ }
49
+
50
+ /**
51
+ * The names a citation may give a work item: a feature's slug with and without its date, and a
52
+ * change's folder name, such as `events`, `2026-10-08-events` and `02-links`.
53
+ */
54
+ export function workItemSlugs(folderNames: Iterable<string>): Set<string> {
55
+ const slugs = new Set<string>();
56
+ for (const name of folderNames) {
57
+ slugs.add(name);
58
+ const undated = name.replace(/^\d{4}-\d{2}-\d{2}-/, "");
59
+ if (undated !== "") slugs.add(undated);
60
+ }
61
+ return slugs;
62
+ }
@@ -1,4 +1,5 @@
1
1
  import { factsOf, statusOf } from "../elements.ts";
2
+ import { findSection, parseMarkdown } from "../markdown.ts";
2
3
  import type { ProjectView } from "../project/project_view.ts";
3
4
 
4
5
  /**
@@ -19,9 +20,22 @@ export function renderAgentsFile(text: string, view: ProjectView): string {
19
20
  return next;
20
21
  }
21
22
 
23
+ /** The lines under `## Known pitfalls`, one per pitfall, which the feedback export carries back to Cruze. */
24
+ export function knownPitfalls(text: string): string[] {
25
+ const doc = parseMarkdown(text);
26
+ const range = findSection(doc, "Known pitfalls");
27
+ if (range === null) return [];
28
+ return doc.lines.slice(range.start, range.end).filter((line) => line.startsWith("- ")).map((line) => line.slice(2).trim());
29
+ }
30
+
31
+ /**
32
+ * The modules whose code exists: those built, and those a land built before a rethink set them
33
+ * back to `planned` for a change to rebuild, since their directories are still there.
34
+ */
22
35
  function builtModules(view: ProjectView): string[] {
36
+ const everBuilt = new Set(view.journal.filter((e) => e.event === "land").flatMap((e) => (Array.isArray(e["built"]) ? (e["built"] as unknown[]).map(String) : [])));
23
37
  return [...view.living.elements.values()]
24
- .filter(({ element, doc }) => element.kind === "MOD" && statusOf(doc, element) === "built")
38
+ .filter(({ element, doc }) => element.kind === "MOD" && (statusOf(doc, element) === "built" || everBuilt.has(element.id)))
25
39
  .map(({ element, doc }) => {
26
40
  const facts = factsOf(doc, element);
27
41
  const paths = (facts.get("Path") ?? []).flatMap((value) => [...value.matchAll(/`([^`]+)`/g)].map((m) => `\`${m[1] ?? ""}\``));
package/src/domain/ids.ts CHANGED
@@ -1,8 +1,10 @@
1
1
  /** Element IDs: `<KIND>-<name>` or `<KIND>-<scope>.<name>`, named and never reused. */
2
2
 
3
- export const KINDS = ["GOAL", "CTX", "ENT", "UC", "PORT", "ADP", "FLOW", "MOD", "RULE", "VIEW", "XC", "REQ", "SCN", "ADR"] as const;
3
+ export const KINDS = ["GOAL", "PRINCIPLE", "LATER", "CTX", "ENT", "UC", "PORT", "ADP", "FLOW", "MOD", "RULE", "VIEW", "XC", "REQ", "SCN", "ADR"] as const;
4
4
  export type Kind = (typeof KINDS)[number];
5
5
 
6
+ /** Kinds of the vision's row elements: goals, the principles every design follows, and what must stay possible later. */
7
+ export const VISION_KINDS: readonly Kind[] = ["GOAL", "PRINCIPLE", "LATER"];
6
8
  /** Kinds that describe code, and so carry a managed planned/built status. */
7
9
  export const CODE_KINDS: readonly Kind[] = ["ENT", "UC", "PORT", "ADP", "FLOW", "MOD"];
8
10
  /** Kinds whose elements carry a managed status: code kinds and scenarios. */
@@ -16,6 +16,7 @@ export const RECORDED_EVENTS: Record<string, string[]> = {
16
16
  bug: ["summary", "cause"],
17
17
  verification: ["result", "summary"],
18
18
  checks: ["commit"],
19
+ lesson: ["summary", "instead", "step"],
19
20
  };
20
21
 
21
22
  /** Fields an event may carry beyond its required ones, checked when present. A defect rethink must say which step missed it. */
@@ -23,6 +24,7 @@ const OPTIONAL_FIELDS: Record<string, string[]> = {
23
24
  rethink: ["missed_by"],
24
25
  review: ["nits", "checked_by"],
25
26
  disposition: ["decided"],
27
+ verification: ["back_to"],
26
28
  };
27
29
 
28
30
  /** The workflow steps and checks that find or miss a problem, so a retro can count them. */
@@ -31,15 +33,26 @@ export const STEPS = ["envision", "architect", "research", "design-review", "wal
31
33
  export const FIELD_VALUES: Record<string, string[]> = {
32
34
  level: ["task", "change", "feature", "architecture", "vision"],
33
35
  kind: ["defect", "discovery"],
34
- disposition: ["fixed", "waived", "deferred", "rejected"],
36
+ disposition: ["fixed", "waived", "deferred", "rejected", "rethink"],
35
37
  decided: ["agent", "user"],
36
38
  review: ["design", "plan", "code", "realign", "improve"],
37
39
  result: ["accepted", "sent-back"],
40
+ back_to: ["build", "rethink"],
38
41
  checked_by: ["agent", "reviewer"],
39
42
  found_by: STEPS,
40
43
  missed_by: STEPS,
44
+ step: STEPS,
41
45
  };
42
46
 
47
+ /** A defect rethink must say which step missed it, and a sent-back verification where the change goes back to. */
48
+ function conditionallyRequired(event: string, fields: Record<string, string>): string[] {
49
+ if (event === "rethink" && fields["kind"] === "defect") return ["missed_by"];
50
+ if (event === "verification" && fields["result"] === "sent-back") return ["back_to"];
51
+ return [];
52
+ }
53
+
54
+ const CONDITION_NOTES: Record<string, string> = { missed_by: " for a defect", back_to: " when the change is sent back" };
55
+
43
56
  /** Fields recorded as numbers rather than text. */
44
57
  const COUNT_FIELDS = ["round", "blockers", "concerns", "nits"];
45
58
 
@@ -71,8 +84,8 @@ export function serializeEntry(entry: JournalEntry): string {
71
84
  export function recordedEventProblems(event: string, fields: Record<string, string>): string[] {
72
85
  const required = RECORDED_EVENTS[event];
73
86
  if (required === undefined) return [`unknown event "${event}"; recordable events: ${Object.keys(RECORDED_EVENTS).join(", ")}`];
74
- const needed = event === "rethink" && fields["kind"] === "defect" ? [...required, "missed_by"] : required;
75
- const problems = needed.filter((field) => (fields[field] ?? "").trim() === "").map((field) => `${event} needs ${field}${field === "missed_by" ? " for a defect" : ""}`);
87
+ const needed = [...required, ...conditionallyRequired(event, fields)];
88
+ const problems = needed.filter((field) => (fields[field] ?? "").trim() === "").map((field) => `${event} needs ${field}${CONDITION_NOTES[field] ?? ""}`);
76
89
  const known = [...required, ...(OPTIONAL_FIELDS[event] ?? [])];
77
90
  for (const field of known) {
78
91
  const value = fields[field];
@@ -1,3 +1,4 @@
1
+ import { settledIds } from "../approvals/rebase.ts";
1
2
  import { sectionForKind } from "../architecture_sections.ts";
2
3
  import { CruzeError } from "../cruze_error.ts";
3
4
  import { setStatus } from "../edits/status_lines.ts";
@@ -26,7 +27,8 @@ export interface MergePlan {
26
27
  /**
27
28
  * Merges a change's work into the living docs. The first change of a feature to land merges
28
29
  * the whole delta; elements it doesn't build arrive as planned, and later changes flip what
29
- * they build to built. Text is replaced only when nobody else changed it since this work merged it.
30
+ * they build to built. Text is replaced only when nobody else changed it since this work merged it,
31
+ * and an element merged and unchanged in the delta since keeps its living text, whoever edited it.
30
32
  */
31
33
  export function planMerge(view: ProjectView, change: WorkItem, source: WorkItem): MergePlan {
32
34
  const scope = readScope(change.doc);
@@ -36,6 +38,7 @@ export function planMerge(view: ProjectView, change: WorkItem, source: WorkItem)
36
38
  const files = new Map<string, string>();
37
39
  const text = (path: string): string => files.get(path) ?? view.snapshot.get(path) ?? "";
38
40
  const plan: MergePlan = { files, merged, mergedIds: [], built: [], removed: [] };
41
+ const settled = settledIds(source.doc, merged);
39
42
 
40
43
  for (const op of delta.capabilities) {
41
44
  const key = capabilityKey(op.capability);
@@ -56,8 +59,10 @@ export function planMerge(view: ProjectView, change: WorkItem, source: WorkItem)
56
59
  }
57
60
  continue;
58
61
  }
59
- mergeEntry(view, source, entry, path, text, files, merged, plan);
62
+ const kept = settled.has(id) && view.living.elements.has(id);
63
+ if (!kept) mergeEntry(view, source, entry, path, text, files, merged, plan);
60
64
  for (const target of [entry.element, ...entry.scenarios].filter((e) => STATUS_KINDS.includes(e.kind))) {
65
+ if (kept && !inScope.has(target.id)) continue;
61
66
  files.set(path, setStatus(text(path), target.id, statusAfterMerge(view, source, target, inScope)));
62
67
  if (inScope.has(target.id)) plan.built.push(target.id);
63
68
  }
@@ -0,0 +1,56 @@
1
+ /**
2
+ * A line diff of two texts as unified-diff lines: " " for a kept line, "- " removed, "+ " added.
3
+ * Only the changes and `context` kept lines around each are shown; "…" marks the lines left out.
4
+ */
5
+ export function lineDiff(before: string[], after: string[], context = 2): string[] {
6
+ const ops = diffOps(before, after);
7
+ const near = new Set<number>();
8
+ ops.forEach((op, i) => {
9
+ if (op.kind === " ") return;
10
+ for (let j = Math.max(0, i - context); j <= Math.min(ops.length - 1, i + context); j++) near.add(j);
11
+ });
12
+ const lines: string[] = [];
13
+ let skipped = false;
14
+ ops.forEach((op, i) => {
15
+ if (!near.has(i)) {
16
+ skipped = true;
17
+ return;
18
+ }
19
+ if (skipped && lines.length > 0) lines.push("…");
20
+ skipped = false;
21
+ lines.push(`${op.kind} ${op.line}`);
22
+ });
23
+ if (skipped && lines.length > 0) lines.push("…");
24
+ return lines;
25
+ }
26
+
27
+ interface Op {
28
+ kind: " " | "-" | "+";
29
+ line: string;
30
+ }
31
+
32
+ /** The edit script of a longest common subsequence: documents are small enough for the quadratic table. */
33
+ function diffOps(a: string[], b: string[]): Op[] {
34
+ const width = b.length + 1;
35
+ const table = new Int32Array((a.length + 1) * width);
36
+ const at = (i: number, j: number): number => table[i * width + j] ?? 0;
37
+ for (let i = a.length - 1; i >= 0; i--) {
38
+ for (let j = b.length - 1; j >= 0; j--) {
39
+ table[i * width + j] = a[i] === b[j] ? at(i + 1, j + 1) + 1 : Math.max(at(i + 1, j), at(i, j + 1));
40
+ }
41
+ }
42
+ const ops: Op[] = [];
43
+ let i = 0;
44
+ let j = 0;
45
+ while (i < a.length || j < b.length) {
46
+ if (i < a.length && j < b.length && a[i] === b[j]) {
47
+ ops.push({ kind: " ", line: a[i++] ?? "" });
48
+ j++;
49
+ } else if (j >= b.length || (i < a.length && at(i + 1, j) >= at(i, j + 1))) {
50
+ ops.push({ kind: "-", line: a[i++] ?? "" });
51
+ } else {
52
+ ops.push({ kind: "+", line: b[j++] ?? "" });
53
+ }
54
+ }
55
+ return ops;
56
+ }
@@ -0,0 +1,124 @@
1
+ import { elementLines, factsOf, statusOf, type DeltaOp, type Element, type Status } from "../elements.ts";
2
+ import { findIds, kindOf, scopeOf, type Kind } from "../ids.ts";
3
+ import type { MarkdownDoc } from "../markdown.ts";
4
+ import { readDelta } from "./deltas.ts";
5
+ import { PATHS } from "./layout.ts";
6
+ import type { ProjectView } from "./project_view.ts";
7
+ import type { ShownElement } from "./scope_view.ts";
8
+ import type { WorkItem } from "./work_items.ts";
9
+
10
+ /**
11
+ * Elements one at a time, and an index of all of them, so a step that needs a few elements of a
12
+ * large architecture fetches those instead of reading the whole file. One project's architecture
13
+ * held 52k words, and a single architect run read all of it to find what it would extend.
14
+ */
15
+
16
+ export interface IndexEntry {
17
+ id: string;
18
+ title: string;
19
+ kind: Kind;
20
+ /** The living document that holds it, or the work item that adds it. */
21
+ source: string;
22
+ status?: Status;
23
+ /** Where its code lives: the `Module` it names, or a module's `Path`. */
24
+ place?: string;
25
+ /** For a requirement, how many scenarios it holds. */
26
+ scenarios?: number;
27
+ /** Work in flight whose delta changes or removes it. */
28
+ changedBy: string[];
29
+ /** Set when only in-flight work defines it so far. */
30
+ addedBy?: string;
31
+ }
32
+
33
+ export interface ElementIndex {
34
+ /** The words in the living architecture and specs, so a step can judge whether to read them whole. */
35
+ words: { architecture: number; specs: number };
36
+ entries: IndexEntry[];
37
+ }
38
+
39
+ const DOCS_INDEXED = (path: string): boolean => path === PATHS.architecture || path.startsWith(`${PATHS.specsDir}/`);
40
+
41
+ /**
42
+ * Every element of the living architecture and specs, one entry each, with what in-flight work
43
+ * adds. Without a scope, scenarios are counted under their requirement; with a context or
44
+ * capability name, only its elements are listed, scenarios included.
45
+ */
46
+ export function elementIndex(view: ProjectView, scope?: string): ElementIndex {
47
+ const inScope = (id: string): boolean => scope === undefined || scopeOf(id) === scope || id === `CTX-${scope}`;
48
+ const entries: IndexEntry[] = [];
49
+ const byId = new Map<string, IndexEntry>();
50
+ for (const living of view.living.elements.values()) {
51
+ if (!DOCS_INDEXED(living.path) || !inScope(living.id) || (scope === undefined && kindOf(living.id) === "SCN")) continue;
52
+ const entry = entryOf(living.id, living.element, living.doc, living.path);
53
+ if (kindOf(living.id) === "REQ") entry.scenarios = scenarioCount(view, living.id);
54
+ entries.push(entry);
55
+ byId.set(entry.id, entry);
56
+ }
57
+ for (const item of inFlight(view)) {
58
+ for (const element of deltaElements(item)) {
59
+ if (!inScope(element.element.id) || (scope === undefined && element.element.kind === "SCN")) continue;
60
+ const known = byId.get(element.element.id);
61
+ if (known !== undefined) {
62
+ known.changedBy.push(item.ref);
63
+ continue;
64
+ }
65
+ const added = { ...entryOf(element.element.id, element.element, item.doc, item.ref), addedBy: item.ref };
66
+ entries.push(added);
67
+ byId.set(added.id, added);
68
+ }
69
+ }
70
+ return { words: livingWords(view), entries };
71
+ }
72
+
73
+ /** The bodies of the named elements: the living one, then each in-flight delta that changes it. */
74
+ export function lookupElements(view: ProjectView, ids: string[]): { elements: ShownElement[]; missing: string[] } {
75
+ const elements: ShownElement[] = [];
76
+ const missing: string[] = [];
77
+ for (const id of ids) {
78
+ const found: ShownElement[] = [];
79
+ const living = view.living.elements.get(id);
80
+ if (living !== undefined) found.push(shown(living.doc, living.element, living.path));
81
+ for (const item of inFlight(view)) {
82
+ const delta = deltaElements(item).find((d) => d.element.id === id);
83
+ if (delta !== undefined) found.push({ ...shown(item.doc, delta.element, item.path), ...(delta.op === undefined ? {} : { op: delta.op }) });
84
+ }
85
+ if (found.length === 0) missing.push(id);
86
+ elements.push(...found);
87
+ }
88
+ return { elements, missing };
89
+ }
90
+
91
+ function entryOf(id: string, element: Element, doc: MarkdownDoc, source: string): IndexEntry {
92
+ const facts = factsOf(doc, element);
93
+ const place = (facts.get("Module") ?? []).flatMap(findIds)[0] ?? (facts.get("Path") ?? [])[0];
94
+ const status = statusOf(doc, element);
95
+ return { id, title: element.title, kind: kindOf(id), source, changedBy: [], ...(status === undefined ? {} : { status }), ...(place === undefined ? {} : { place }) };
96
+ }
97
+
98
+ function shown(doc: MarkdownDoc, element: Element, path: string): ShownElement {
99
+ return { id: element.id, title: element.title, source: `${path}:${element.start + 1}`, body: elementLines(doc, element) };
100
+ }
101
+
102
+ function inFlight(view: ProjectView): WorkItem[] {
103
+ return view.items.filter((item) => !item.archived && item.kind !== "change");
104
+ }
105
+
106
+ /** Each element a work item's delta defines or changes, scenarios under a requirement included. */
107
+ function deltaElements(item: WorkItem): Array<{ element: Element; op?: DeltaOp }> {
108
+ return readDelta(item.doc).entries.flatMap((entry) => [
109
+ { element: entry.element, ...(entry.element.op === undefined ? {} : { op: entry.element.op }) },
110
+ ...entry.scenarios.map((scenario) => ({ element: scenario })),
111
+ ]);
112
+ }
113
+
114
+ function scenarioCount(view: ProjectView, requirement: string): number {
115
+ const living = view.living.elements.get(requirement);
116
+ if (living === undefined) return 0;
117
+ return [...view.living.elements.values()].filter((e) => e.path === living.path && e.id.startsWith("SCN-") && e.element.start > living.element.start && e.element.start < living.element.end).length;
118
+ }
119
+
120
+ function livingWords(view: ProjectView): { architecture: number; specs: number } {
121
+ const words = (path: string): number => (view.snapshot.get(path) ?? "").split(/\s+/).filter((w) => w !== "").length;
122
+ const specs = [...view.living.docs.keys()].filter((path) => path.startsWith(`${PATHS.specsDir}/`));
123
+ return { architecture: words(PATHS.architecture), specs: specs.reduce((sum, path) => sum + words(path), 0) };
124
+ }