sentinelayer-cli 0.6.2 → 0.8.1

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 (280) hide show
  1. package/README.md +1009 -996
  2. package/bin/create-sentinelayer.js +5 -5
  3. package/bin/sentinelayer-cli.js +4 -4
  4. package/bin/sl.js +5 -5
  5. package/package.json +64 -63
  6. package/src/agents/ai-governance/index.js +12 -0
  7. package/src/agents/ai-governance/tools/base.js +171 -0
  8. package/src/agents/ai-governance/tools/eval-regression.js +47 -0
  9. package/src/agents/ai-governance/tools/hitl-audit.js +81 -0
  10. package/src/agents/ai-governance/tools/index.js +52 -0
  11. package/src/agents/ai-governance/tools/prompt-drift.js +42 -0
  12. package/src/agents/ai-governance/tools/provenance-check.js +69 -0
  13. package/src/agents/backend/index.js +12 -0
  14. package/src/agents/backend/tools/base.js +189 -0
  15. package/src/agents/backend/tools/circuit-breaker-check.js +123 -0
  16. package/src/agents/backend/tools/idempotency-audit.js +105 -0
  17. package/src/agents/backend/tools/index.js +87 -0
  18. package/src/agents/backend/tools/retry-audit.js +132 -0
  19. package/src/agents/backend/tools/timeout-audit.js +144 -0
  20. package/src/agents/code-quality/index.js +12 -0
  21. package/src/agents/code-quality/tools/base.js +159 -0
  22. package/src/agents/code-quality/tools/complexity-measure.js +197 -0
  23. package/src/agents/code-quality/tools/coupling-analysis.js +81 -0
  24. package/src/agents/code-quality/tools/cycle-detect.js +49 -0
  25. package/src/agents/code-quality/tools/dep-graph.js +196 -0
  26. package/src/agents/code-quality/tools/index.js +89 -0
  27. package/src/agents/data-layer/index.js +12 -0
  28. package/src/agents/data-layer/tools/base.js +181 -0
  29. package/src/agents/data-layer/tools/index-audit.js +165 -0
  30. package/src/agents/data-layer/tools/index.js +83 -0
  31. package/src/agents/data-layer/tools/migration-scan.js +135 -0
  32. package/src/agents/data-layer/tools/query-explain.js +120 -0
  33. package/src/agents/data-layer/tools/tenancy-scan.js +166 -0
  34. package/src/agents/documentation/index.js +12 -0
  35. package/src/agents/documentation/tools/api-diff.js +91 -0
  36. package/src/agents/documentation/tools/base.js +151 -0
  37. package/src/agents/documentation/tools/dead-link-check.js +58 -0
  38. package/src/agents/documentation/tools/docstring-coverage.js +78 -0
  39. package/src/agents/documentation/tools/index.js +52 -0
  40. package/src/agents/documentation/tools/readme-freshness.js +61 -0
  41. package/src/agents/envelope/fix-cycle.js +45 -0
  42. package/src/agents/envelope/index.js +31 -0
  43. package/src/agents/envelope/loop.js +150 -0
  44. package/src/agents/envelope/pulse.js +18 -0
  45. package/src/agents/envelope/stream.js +40 -0
  46. package/src/agents/infrastructure/index.js +12 -0
  47. package/src/agents/infrastructure/tools/base.js +171 -0
  48. package/src/agents/infrastructure/tools/checkov-run.js +32 -0
  49. package/src/agents/infrastructure/tools/drift-detect.js +59 -0
  50. package/src/agents/infrastructure/tools/iam-least-priv-check.js +78 -0
  51. package/src/agents/infrastructure/tools/index.js +52 -0
  52. package/src/agents/infrastructure/tools/tflint-run.js +31 -0
  53. package/src/agents/jules/config/definition.js +160 -160
  54. package/src/agents/jules/config/system-prompt.js +182 -182
  55. package/src/agents/jules/error-intake.js +51 -51
  56. package/src/agents/jules/fix-cycle.js +17 -17
  57. package/src/agents/jules/loop.js +460 -450
  58. package/src/agents/jules/pulse.js +10 -10
  59. package/src/agents/jules/stream.js +187 -186
  60. package/src/agents/jules/swarm/file-scanner.js +74 -74
  61. package/src/agents/jules/swarm/index.js +11 -11
  62. package/src/agents/jules/swarm/orchestrator.js +362 -362
  63. package/src/agents/jules/swarm/pattern-hunter.js +123 -123
  64. package/src/agents/jules/swarm/sub-agent.js +315 -309
  65. package/src/agents/jules/tools/aidenid-email.js +189 -189
  66. package/src/agents/jules/tools/auth-audit.js +1708 -1691
  67. package/src/agents/jules/tools/dispatch.js +340 -335
  68. package/src/agents/jules/tools/file-edit.js +2 -2
  69. package/src/agents/jules/tools/file-read.js +2 -2
  70. package/src/agents/jules/tools/frontend-analyze.js +570 -570
  71. package/src/agents/jules/tools/glob.js +2 -2
  72. package/src/agents/jules/tools/grep.js +2 -2
  73. package/src/agents/jules/tools/index.js +29 -29
  74. package/src/agents/jules/tools/path-guards.js +2 -2
  75. package/src/agents/jules/tools/runtime-audit.js +507 -507
  76. package/src/agents/jules/tools/shell.js +2 -2
  77. package/src/agents/jules/tools/url-policy.js +100 -100
  78. package/src/agents/mode.js +113 -0
  79. package/src/agents/observability/index.js +12 -0
  80. package/src/agents/observability/tools/alert-audit.js +39 -0
  81. package/src/agents/observability/tools/base.js +181 -0
  82. package/src/agents/observability/tools/dashboard-gap.js +42 -0
  83. package/src/agents/observability/tools/index.js +54 -0
  84. package/src/agents/observability/tools/log-schema-check.js +74 -0
  85. package/src/agents/observability/tools/span-coverage.js +74 -0
  86. package/src/agents/persona-visuals.js +102 -61
  87. package/src/agents/release/index.js +12 -0
  88. package/src/agents/release/tools/base.js +181 -0
  89. package/src/agents/release/tools/changelog-diff.js +86 -0
  90. package/src/agents/release/tools/feature-flag-audit.js +126 -0
  91. package/src/agents/release/tools/index.js +61 -0
  92. package/src/agents/release/tools/rollback-verify.js +129 -0
  93. package/src/agents/release/tools/semver-check.js +109 -0
  94. package/src/agents/reliability/index.js +12 -0
  95. package/src/agents/reliability/tools/backpressure-check.js +129 -0
  96. package/src/agents/reliability/tools/base.js +181 -0
  97. package/src/agents/reliability/tools/chaos-probe.js +109 -0
  98. package/src/agents/reliability/tools/graceful-degradation-check.js +114 -0
  99. package/src/agents/reliability/tools/health-check-audit.js +111 -0
  100. package/src/agents/reliability/tools/index.js +87 -0
  101. package/src/agents/run-persona.js +109 -0
  102. package/src/agents/security/index.js +12 -0
  103. package/src/agents/security/tools/authz-audit.js +134 -0
  104. package/src/agents/security/tools/base.js +190 -0
  105. package/src/agents/security/tools/crypto-review.js +175 -0
  106. package/src/agents/security/tools/index.js +97 -0
  107. package/src/agents/security/tools/sast-scan.js +175 -0
  108. package/src/agents/security/tools/secrets-scan.js +216 -0
  109. package/src/agents/shared-tools/dispatch-core.js +320 -315
  110. package/src/agents/shared-tools/file-edit.js +180 -180
  111. package/src/agents/shared-tools/file-read.js +100 -100
  112. package/src/agents/shared-tools/glob.js +168 -168
  113. package/src/agents/shared-tools/grep.js +228 -228
  114. package/src/agents/shared-tools/index.js +46 -46
  115. package/src/agents/shared-tools/path-guards.js +161 -161
  116. package/src/agents/shared-tools/shell.js +383 -383
  117. package/src/agents/supply-chain/index.js +12 -0
  118. package/src/agents/supply-chain/tools/attestation-check.js +42 -0
  119. package/src/agents/supply-chain/tools/base.js +151 -0
  120. package/src/agents/supply-chain/tools/index.js +52 -0
  121. package/src/agents/supply-chain/tools/lockfile-integrity.js +73 -0
  122. package/src/agents/supply-chain/tools/package-verify.js +56 -0
  123. package/src/agents/supply-chain/tools/sbom-diff.js +34 -0
  124. package/src/agents/testing/index.js +12 -0
  125. package/src/agents/testing/tools/base.js +202 -0
  126. package/src/agents/testing/tools/coverage-gap.js +144 -0
  127. package/src/agents/testing/tools/flake-detect.js +125 -0
  128. package/src/agents/testing/tools/index.js +85 -0
  129. package/src/agents/testing/tools/mutation-test.js +143 -0
  130. package/src/agents/testing/tools/snapshot-diff.js +103 -0
  131. package/src/ai/aidenid.js +1021 -1009
  132. package/src/ai/client.js +553 -553
  133. package/src/ai/domain-target-store.js +268 -268
  134. package/src/ai/identity-store.js +270 -270
  135. package/src/ai/proxy.js +137 -137
  136. package/src/ai/site-store.js +145 -145
  137. package/src/audit/agents/architecture.js +180 -180
  138. package/src/audit/agents/compliance.js +179 -179
  139. package/src/audit/agents/documentation.js +165 -165
  140. package/src/audit/agents/performance.js +145 -145
  141. package/src/audit/agents/security.js +215 -215
  142. package/src/audit/agents/testing.js +172 -172
  143. package/src/audit/orchestrator.js +557 -557
  144. package/src/audit/package.js +204 -204
  145. package/src/audit/registry.js +284 -284
  146. package/src/audit/replay.js +103 -103
  147. package/src/auth/gate.js +428 -371
  148. package/src/auth/http.js +681 -611
  149. package/src/auth/service.js +1106 -1106
  150. package/src/auth/session-store.js +813 -813
  151. package/src/cli.js +257 -252
  152. package/src/commands/ai/identity-lifecycle.js +1338 -1338
  153. package/src/commands/ai/provision-governance.js +1272 -1272
  154. package/src/commands/ai/shared.js +147 -147
  155. package/src/commands/ai.js +11 -11
  156. package/src/commands/apply.js +12 -12
  157. package/src/commands/audit.js +1171 -1166
  158. package/src/commands/auth.js +419 -419
  159. package/src/commands/chat.js +184 -191
  160. package/src/commands/config.js +184 -184
  161. package/src/commands/cost.js +311 -311
  162. package/src/commands/daemon/core.js +850 -850
  163. package/src/commands/daemon/extended.js +1048 -1048
  164. package/src/commands/daemon/shared.js +213 -213
  165. package/src/commands/daemon.js +11 -11
  166. package/src/commands/guide.js +174 -174
  167. package/src/commands/ingest.js +58 -58
  168. package/src/commands/init.js +55 -55
  169. package/src/commands/legacy-args.js +20 -10
  170. package/src/commands/mcp.js +461 -461
  171. package/src/commands/omargate.js +63 -29
  172. package/src/commands/persona.js +65 -20
  173. package/src/commands/plugin.js +260 -260
  174. package/src/commands/policy.js +132 -132
  175. package/src/commands/prompt.js +238 -238
  176. package/src/commands/review.js +704 -704
  177. package/src/commands/scan.js +865 -872
  178. package/src/commands/session.js +1238 -0
  179. package/src/commands/spec.js +771 -716
  180. package/src/commands/swarm.js +651 -651
  181. package/src/commands/telemetry.js +202 -202
  182. package/src/commands/watch.js +511 -511
  183. package/src/config/agent-dictionary.js +182 -182
  184. package/src/config/io.js +56 -56
  185. package/src/config/paths.js +18 -18
  186. package/src/config/schema.js +55 -55
  187. package/src/config/service.js +184 -184
  188. package/src/coord/events-log.js +141 -0
  189. package/src/coord/handshake.js +719 -0
  190. package/src/coord/index.js +35 -0
  191. package/src/coord/paths.js +84 -0
  192. package/src/coord/priority.js +62 -0
  193. package/src/coord/tarjan.js +157 -0
  194. package/src/cost/budget.js +235 -235
  195. package/src/cost/history.js +188 -188
  196. package/src/cost/tokenizer.js +160 -0
  197. package/src/cost/tracker.js +232 -171
  198. package/src/daemon/artifact-lineage.js +896 -534
  199. package/src/daemon/assignment-ledger.js +1083 -770
  200. package/src/daemon/ast-drift.js +496 -0
  201. package/src/daemon/ast-parser-layer.js +258 -258
  202. package/src/daemon/budget-governor.js +633 -633
  203. package/src/daemon/callgraph-overlay.js +646 -646
  204. package/src/daemon/error-worker.js +1209 -626
  205. package/src/daemon/fix-cycle.js +384 -377
  206. package/src/daemon/hybrid-mapper.js +929 -929
  207. package/src/daemon/ingest-refresh.js +79 -11
  208. package/src/daemon/jira-lifecycle.js +767 -632
  209. package/src/daemon/operator-control.js +657 -657
  210. package/src/daemon/pulse.js +327 -327
  211. package/src/daemon/reliability-lane.js +471 -471
  212. package/src/daemon/scope-engine.js +1068 -0
  213. package/src/daemon/watchdog.js +971 -971
  214. package/src/events/schema.js +190 -0
  215. package/src/guide/generator.js +316 -316
  216. package/src/ingest/engine.js +933 -918
  217. package/src/ingest/ownership.js +380 -0
  218. package/src/interactive/index.js +97 -97
  219. package/src/legacy-cli.js +3228 -2994
  220. package/src/mcp/registry.js +695 -695
  221. package/src/memory/blackboard.js +301 -301
  222. package/src/memory/retrieval.js +581 -581
  223. package/src/orchestrator/kai-chen.js +126 -0
  224. package/src/plugin/manifest.js +553 -553
  225. package/src/policy/packs.js +144 -144
  226. package/src/prompt/generator.js +136 -118
  227. package/src/review/ai-review.js +672 -679
  228. package/src/review/compliance-pack.js +389 -0
  229. package/src/review/investor-dd-config.js +54 -0
  230. package/src/review/investor-dd-file-loop.js +303 -0
  231. package/src/review/investor-dd-file-router.js +406 -0
  232. package/src/review/investor-dd-html-report.js +233 -0
  233. package/src/review/investor-dd-notification.js +120 -0
  234. package/src/review/investor-dd-orchestrator.js +405 -0
  235. package/src/review/investor-dd-persona-runner.js +275 -0
  236. package/src/review/live-validator.js +253 -0
  237. package/src/review/local-review.js +1351 -1305
  238. package/src/review/omargate-interactive.js +68 -68
  239. package/src/review/omargate-orchestrator.js +492 -300
  240. package/src/review/persona-prompts.js +484 -296
  241. package/src/review/reconciliation-rules.js +329 -0
  242. package/src/review/replay.js +235 -235
  243. package/src/review/report.js +664 -664
  244. package/src/review/reproducibility-chain.js +136 -0
  245. package/src/review/scan-modes.js +147 -42
  246. package/src/review/spec-binding.js +487 -487
  247. package/src/scaffold/generator.js +67 -67
  248. package/src/scaffold/templates.js +150 -150
  249. package/src/scan/generator.js +418 -418
  250. package/src/scan/gh-secrets.js +107 -107
  251. package/src/session/agent-registry.js +359 -0
  252. package/src/session/analytics.js +479 -0
  253. package/src/session/daemon.js +1396 -0
  254. package/src/session/file-locks.js +666 -0
  255. package/src/session/paths.js +37 -0
  256. package/src/session/recap.js +567 -0
  257. package/src/session/redact.js +82 -0
  258. package/src/session/runtime-bridge.js +762 -0
  259. package/src/session/scoring.js +406 -0
  260. package/src/session/setup-guides.js +304 -0
  261. package/src/session/store.js +704 -0
  262. package/src/session/stream.js +333 -0
  263. package/src/session/sync.js +753 -0
  264. package/src/session/tasks.js +1054 -0
  265. package/src/session/templates.js +188 -0
  266. package/src/spec/generator.js +619 -519
  267. package/src/spec/regenerate.js +237 -237
  268. package/src/spec/templates.js +91 -91
  269. package/src/swarm/dashboard.js +247 -247
  270. package/src/swarm/factory.js +363 -363
  271. package/src/swarm/pentest.js +934 -934
  272. package/src/swarm/registry.js +419 -419
  273. package/src/swarm/report.js +158 -158
  274. package/src/swarm/runtime.js +569 -576
  275. package/src/swarm/scenario-dsl.js +272 -272
  276. package/src/telemetry/ledger.js +302 -302
  277. package/src/telemetry/session-tracker.js +234 -234
  278. package/src/telemetry/sync.js +203 -203
  279. package/src/ui/command-hints.js +13 -13
  280. package/src/ui/markdown.js +220 -220
@@ -0,0 +1,151 @@
1
+ // Shared helpers for Samir's (documentation) domain tools (#A23).
2
+
3
+ import fsp from "node:fs/promises";
4
+ import path from "node:path";
5
+ import process from "node:process";
6
+
7
+ import ignore from "ignore";
8
+
9
+ const DEFAULT_IGNORED_DIRS = new Set([
10
+ ".git",
11
+ "node_modules",
12
+ ".venv",
13
+ ".next",
14
+ "dist",
15
+ "build",
16
+ "coverage",
17
+ ".sentinelayer",
18
+ ".sentinel",
19
+ ".turbo",
20
+ ".idea",
21
+ ".vscode",
22
+ "__pycache__",
23
+ ".cache",
24
+ ]);
25
+ const MAX_FILE_SIZE_BYTES = 1024 * 1024;
26
+ const SEVERITIES = Object.freeze(["P0", "P1", "P2", "P3"]);
27
+
28
+ export function toPosix(value) {
29
+ return String(value || "").replace(/\\/g, "/");
30
+ }
31
+
32
+ export function createFinding({
33
+ severity,
34
+ kind,
35
+ file,
36
+ line = 0,
37
+ evidence = "",
38
+ rootCause = "",
39
+ recommendedFix = "",
40
+ confidence = null,
41
+ tool = "",
42
+ persona = "documentation",
43
+ } = {}) {
44
+ const normalizedSeverity = SEVERITIES.includes(String(severity || "").toUpperCase())
45
+ ? String(severity).toUpperCase()
46
+ : "P3";
47
+ return {
48
+ persona,
49
+ tool: String(tool || "").trim(),
50
+ kind: String(kind || "").trim() || "documentation",
51
+ severity: normalizedSeverity,
52
+ file: toPosix(file || ""),
53
+ line: Number.isFinite(Number(line)) ? Math.max(0, Math.floor(Number(line))) : 0,
54
+ evidence: String(evidence || "").trim().slice(0, 400),
55
+ rootCause: String(rootCause || "").trim(),
56
+ recommendedFix: String(recommendedFix || "").trim(),
57
+ confidence:
58
+ confidence === null || confidence === undefined
59
+ ? null
60
+ : Math.max(0, Math.min(1, Number(confidence) || 0)),
61
+ };
62
+ }
63
+
64
+ async function readIgnorePatterns(filePath) {
65
+ try {
66
+ const raw = await fsp.readFile(filePath, "utf-8");
67
+ return String(raw || "")
68
+ .split(/\r?\n/)
69
+ .map((line) => line.trim())
70
+ .filter((line) => line && !line.startsWith("#"));
71
+ } catch (err) {
72
+ if (err && typeof err === "object" && err.code === "ENOENT") {
73
+ return [];
74
+ }
75
+ throw err;
76
+ }
77
+ }
78
+
79
+ async function createIgnoreMatcher(rootPath) {
80
+ const matcher = ignore();
81
+ const gitignore = await readIgnorePatterns(path.join(rootPath, ".gitignore"));
82
+ const sentinel = await readIgnorePatterns(
83
+ path.join(rootPath, ".sentinelayerignore")
84
+ );
85
+ matcher.add([...gitignore, ...sentinel]);
86
+ return (relativePath, isDirectory) => {
87
+ const normalized = toPosix(relativePath);
88
+ if (!normalized) {
89
+ return false;
90
+ }
91
+ const candidate = isDirectory ? `${normalized}/` : normalized;
92
+ return matcher.ignores(candidate);
93
+ };
94
+ }
95
+
96
+ export async function* walkRepoFiles({
97
+ rootPath = process.cwd(),
98
+ extensions = new Set(),
99
+ maxFileSize = MAX_FILE_SIZE_BYTES,
100
+ } = {}) {
101
+ const resolvedRoot = path.resolve(rootPath);
102
+ const ignoreMatcher = await createIgnoreMatcher(resolvedRoot);
103
+ const wantedExtensions =
104
+ extensions instanceof Set
105
+ ? extensions
106
+ : new Set(Array.isArray(extensions) ? extensions : []);
107
+ const stack = [resolvedRoot];
108
+ while (stack.length > 0) {
109
+ const current = stack.pop();
110
+ let entries = [];
111
+ try {
112
+ entries = await fsp.readdir(current, { withFileTypes: true });
113
+ } catch {
114
+ continue;
115
+ }
116
+ for (const entry of entries) {
117
+ const fullPath = path.join(current, entry.name);
118
+ const relativePath = toPosix(path.relative(resolvedRoot, fullPath));
119
+ if (entry.isDirectory()) {
120
+ if (!relativePath || DEFAULT_IGNORED_DIRS.has(entry.name)) {
121
+ continue;
122
+ }
123
+ if (ignoreMatcher(relativePath, true)) {
124
+ continue;
125
+ }
126
+ stack.push(fullPath);
127
+ continue;
128
+ }
129
+ if (!entry.isFile()) {
130
+ continue;
131
+ }
132
+ if (ignoreMatcher(relativePath, false)) {
133
+ continue;
134
+ }
135
+ const ext = path.extname(entry.name).toLowerCase();
136
+ if (wantedExtensions.size > 0 && !wantedExtensions.has(ext) && !wantedExtensions.has("")) {
137
+ continue;
138
+ }
139
+ let stat = null;
140
+ try {
141
+ stat = await fsp.stat(fullPath);
142
+ } catch {
143
+ stat = null;
144
+ }
145
+ if (!stat || stat.size > maxFileSize) {
146
+ continue;
147
+ }
148
+ yield { fullPath, relativePath, stat };
149
+ }
150
+ }
151
+ }
@@ -0,0 +1,58 @@
1
+ // dead-link-check — find markdown relative links that point at non-existent files (#A23).
2
+
3
+ import fsp from "node:fs/promises";
4
+ import path from "node:path";
5
+
6
+ import { createFinding, toPosix, walkRepoFiles } from "./base.js";
7
+
8
+ const LINK_REGEX = /\[[^\]]*\]\(([^)\s]+)\)/g;
9
+
10
+ export async function runDeadLinkCheck({ rootPath } = {}) {
11
+ const resolvedRoot = path.resolve(String(rootPath || "."));
12
+ const findings = [];
13
+ for await (const { fullPath, relativePath } of walkRepoFiles({
14
+ rootPath: resolvedRoot,
15
+ extensions: new Set([".md"]),
16
+ })) {
17
+ let content;
18
+ try {
19
+ content = await fsp.readFile(fullPath, "utf-8");
20
+ } catch {
21
+ continue;
22
+ }
23
+ const rel = toPosix(relativePath);
24
+ const dir = path.posix.dirname(rel);
25
+ let m;
26
+ while ((m = LINK_REGEX.exec(content)) !== null) {
27
+ const target = m[1].split("#")[0];
28
+ if (!target || /^https?:/i.test(target) || target.startsWith("mailto:")) continue;
29
+ const normalizedTarget = target.replace(/\?.*$/, "");
30
+ const resolvedTarget = path.posix.normalize(`${dir}/${normalizedTarget}`);
31
+ const absolute = path.join(resolvedRoot, resolvedTarget);
32
+ let exists = false;
33
+ try {
34
+ await fsp.stat(absolute);
35
+ exists = true;
36
+ } catch {
37
+ exists = false;
38
+ }
39
+ if (!exists) {
40
+ const lineIndex = content.slice(0, m.index).split(/\r?\n/).length;
41
+ findings.push(
42
+ createFinding({
43
+ tool: "dead-link-check",
44
+ kind: "documentation.dead-link",
45
+ severity: "P3",
46
+ file: rel,
47
+ line: lineIndex,
48
+ evidence: `${m[0]} → ${resolvedTarget} does not exist`,
49
+ rootCause: "Broken markdown link — readers follow it to a 404 and lose trust in the docs.",
50
+ recommendedFix: "Update the link to the new path, or delete the reference if the target was intentionally removed.",
51
+ confidence: 0.85,
52
+ })
53
+ );
54
+ }
55
+ }
56
+ }
57
+ return findings;
58
+ }
@@ -0,0 +1,78 @@
1
+ // docstring-coverage — find exported functions without a preceding comment (#A23).
2
+
3
+ import fsp from "node:fs/promises";
4
+ import path from "node:path";
5
+
6
+ import { parse } from "@babel/parser";
7
+
8
+ import { createFinding, toPosix, walkRepoFiles } from "./base.js";
9
+
10
+ const JS_EXTS = new Set([".js", ".jsx", ".ts", ".tsx", ".mjs", ".cjs"]);
11
+
12
+ function hasLeadingComment(node) {
13
+ return Array.isArray(node.leadingComments) && node.leadingComments.length > 0;
14
+ }
15
+
16
+ export async function runDocstringCoverage({ rootPath, files = null } = {}) {
17
+ const resolvedRoot = path.resolve(String(rootPath || "."));
18
+ const iterator =
19
+ Array.isArray(files) && files.length > 0
20
+ ? iterateExplicitFiles(resolvedRoot, files)
21
+ : walkRepoFiles({ rootPath: resolvedRoot, extensions: JS_EXTS });
22
+
23
+ const findings = [];
24
+ for await (const { fullPath, relativePath } of iterator) {
25
+ const rel = toPosix(relativePath);
26
+ if (/(^|\/)(tests?|__tests__|specs?)\//.test(rel)) continue;
27
+ let content;
28
+ try {
29
+ content = await fsp.readFile(fullPath, "utf-8");
30
+ } catch {
31
+ continue;
32
+ }
33
+ let ast;
34
+ try {
35
+ ast = parse(content, {
36
+ sourceType: "unambiguous",
37
+ errorRecovery: true,
38
+ plugins:
39
+ rel.endsWith(".ts") || rel.endsWith(".tsx") ? ["typescript", "jsx"] : ["jsx"],
40
+ });
41
+ } catch {
42
+ continue;
43
+ }
44
+ for (const stmt of ast.program.body) {
45
+ if (
46
+ stmt.type === "ExportNamedDeclaration" &&
47
+ stmt.declaration?.type === "FunctionDeclaration"
48
+ ) {
49
+ const fn = stmt.declaration;
50
+ if (hasLeadingComment(stmt) || hasLeadingComment(fn)) continue;
51
+ findings.push(
52
+ createFinding({
53
+ tool: "docstring-coverage",
54
+ kind: "documentation.undocumented-export",
55
+ severity: "P3",
56
+ file: rel,
57
+ line: fn.loc?.start?.line || 0,
58
+ evidence: `export function ${fn.id?.name || "<anonymous>"} has no leading comment`,
59
+ rootCause: "Public exports ship without explanation. Consumers reverse-engineer expected behavior from implementation.",
60
+ recommendedFix: "Add a JSDoc block describing parameters, return value, and any non-obvious preconditions.",
61
+ confidence: 0.4,
62
+ })
63
+ );
64
+ }
65
+ }
66
+ }
67
+ return findings;
68
+ }
69
+
70
+ async function* iterateExplicitFiles(resolvedRoot, files) {
71
+ for (const file of files) {
72
+ const trimmed = String(file || "").trim();
73
+ if (!trimmed) continue;
74
+ const fullPath = path.isAbsolute(trimmed) ? trimmed : path.join(resolvedRoot, trimmed);
75
+ const relativePath = path.relative(resolvedRoot, fullPath).replace(/\\/g, "/");
76
+ yield { fullPath, relativePath };
77
+ }
78
+ }
@@ -0,0 +1,52 @@
1
+ // Samir (documentation persona) domain-tool registry (#A23).
2
+
3
+ import { runApiDiff } from "./api-diff.js";
4
+ import { runDeadLinkCheck } from "./dead-link-check.js";
5
+ import { runDocstringCoverage } from "./docstring-coverage.js";
6
+ import { runReadmeFreshness } from "./readme-freshness.js";
7
+
8
+ export const DOCUMENTATION_TOOLS = Object.freeze({
9
+ "docstring-coverage": {
10
+ id: "docstring-coverage",
11
+ description: "Flag exported functions (JS/TS) without a leading comment / JSDoc block.",
12
+ schema: { type: "object", properties: { rootPath: { type: "string" }, files: { type: "array", items: { type: "string" } } } },
13
+ handler: runDocstringCoverage,
14
+ },
15
+ "readme-freshness": {
16
+ id: "readme-freshness",
17
+ description: "Flag missing top-level README.md or README > 180 days older than the newest source file.",
18
+ schema: { type: "object", properties: { rootPath: { type: "string" }, staleDays: { type: "number" } } },
19
+ handler: runReadmeFreshness,
20
+ },
21
+ "api-diff": {
22
+ id: "api-diff",
23
+ description: "Detect HTTP endpoints in source and flag any that lack a matching entry in docs/, openapi*, swagger*, or API.md.",
24
+ schema: { type: "object", properties: { rootPath: { type: "string" } } },
25
+ handler: runApiDiff,
26
+ },
27
+ "dead-link-check": {
28
+ id: "dead-link-check",
29
+ description: "Scan markdown files for relative links whose target file doesn't exist.",
30
+ schema: { type: "object", properties: { rootPath: { type: "string" } } },
31
+ handler: runDeadLinkCheck,
32
+ },
33
+ });
34
+
35
+ export const DOCUMENTATION_TOOL_IDS = Object.freeze(Object.keys(DOCUMENTATION_TOOLS));
36
+
37
+ export async function dispatchDocumentationTool(toolId, args = {}) {
38
+ const tool = DOCUMENTATION_TOOLS[toolId];
39
+ if (!tool) throw new Error(`Unknown documentation tool: ${toolId}`);
40
+ return tool.handler(args);
41
+ }
42
+
43
+ export async function runAllDocumentationTools({ rootPath, files = null } = {}) {
44
+ const findings = [];
45
+ for (const toolId of DOCUMENTATION_TOOL_IDS) {
46
+ const out = await dispatchDocumentationTool(toolId, { rootPath, files });
47
+ findings.push(...out);
48
+ }
49
+ return findings;
50
+ }
51
+
52
+ export { runApiDiff, runDeadLinkCheck, runDocstringCoverage, runReadmeFreshness };
@@ -0,0 +1,61 @@
1
+ // readme-freshness — flag stale READMEs (#A23).
2
+
3
+ import path from "node:path";
4
+
5
+ import { createFinding, toPosix, walkRepoFiles } from "./base.js";
6
+
7
+ const STALE_DAYS = 180;
8
+
9
+ export async function runReadmeFreshness({ rootPath, staleDays = STALE_DAYS } = {}) {
10
+ const resolvedRoot = path.resolve(String(rootPath || "."));
11
+ const now = Date.now();
12
+ const threshold = now - staleDays * 24 * 60 * 60 * 1000;
13
+ const findings = [];
14
+ let codeMaxMtime = 0;
15
+ let readme = null;
16
+ for await (const { relativePath, stat } of walkRepoFiles({ rootPath: resolvedRoot })) {
17
+ const rel = toPosix(relativePath);
18
+ if (/(^|\/)README\.md$/i.test(rel) && !readme) {
19
+ readme = { rel, mtime: Number(stat?.mtimeMs || 0) };
20
+ }
21
+ if (/\.(js|jsx|ts|tsx|py|go|rb|mjs|cjs)$/i.test(rel)) {
22
+ codeMaxMtime = Math.max(codeMaxMtime, Number(stat?.mtimeMs || 0));
23
+ }
24
+ }
25
+ if (!readme) {
26
+ findings.push(
27
+ createFinding({
28
+ tool: "readme-freshness",
29
+ kind: "documentation.no-readme",
30
+ severity: "P2",
31
+ file: "",
32
+ line: 0,
33
+ evidence: "No top-level README.md",
34
+ rootCause: "A repo without a README has no entry point for new contributors.",
35
+ recommendedFix: "Add a README.md with: project purpose, quickstart, and how to contribute.",
36
+ confidence: 0.9,
37
+ })
38
+ );
39
+ return findings;
40
+ }
41
+ if (readme.mtime && readme.mtime < threshold && codeMaxMtime > readme.mtime) {
42
+ const ageDays = Math.floor((now - readme.mtime) / (24 * 60 * 60 * 1000));
43
+ const driftDays = Math.floor((codeMaxMtime - readme.mtime) / (24 * 60 * 60 * 1000));
44
+ findings.push(
45
+ createFinding({
46
+ tool: "readme-freshness",
47
+ kind: "documentation.stale-readme",
48
+ severity: "P3",
49
+ file: readme.rel,
50
+ line: 0,
51
+ evidence: `README last modified ${ageDays}d ago; newest code ${driftDays}d newer`,
52
+ rootCause: "README is falling behind the code. New contributors will be guided by outdated instructions.",
53
+ recommendedFix: "Review the quickstart + architecture sections and update anything that's moved.",
54
+ confidence: 0.45,
55
+ })
56
+ );
57
+ }
58
+ return findings;
59
+ }
60
+
61
+ export { STALE_DAYS };
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Iterative fix-cycle helper (#A8 envelope).
3
+ *
4
+ * Pattern: when the envelope loop reports stuckReason or remaining
5
+ * findings, a fix-cycle re-runs the loop with an amended prompt and a
6
+ * reduced toolset, bounded by maxCycles. Used by personas that want
7
+ * Jules-tier "try until green" behavior.
8
+ */
9
+
10
+ import { runEnvelopeLoop } from "./loop.js";
11
+
12
+ export const DEFAULT_MAX_CYCLES = 3;
13
+
14
+ /**
15
+ * @param {object} params
16
+ * @param {Function} params.runCycle — async ({ cycle }) => { findings, messages, stuckReason, ... }
17
+ * @param {Function} [params.isResolved] — sync (result) => boolean; default: findings empty AND no stuckReason
18
+ * @param {number} [params.maxCycles]
19
+ */
20
+ export async function runFixCycle({
21
+ runCycle,
22
+ isResolved,
23
+ maxCycles = DEFAULT_MAX_CYCLES,
24
+ } = {}) {
25
+ if (typeof runCycle !== "function") {
26
+ throw new TypeError("runFixCycle requires a runCycle function");
27
+ }
28
+ const checkResolved = typeof isResolved === "function"
29
+ ? isResolved
30
+ : (result) => Array.isArray(result?.findings) && result.findings.length === 0 && !result?.stuckReason;
31
+
32
+ const history = [];
33
+ for (let cycle = 1; cycle <= maxCycles; cycle += 1) {
34
+ const result = await runCycle({ cycle });
35
+ history.push(result);
36
+ if (checkResolved(result)) {
37
+ return { resolved: true, cyclesUsed: cycle, history };
38
+ }
39
+ }
40
+ return { resolved: false, cyclesUsed: maxCycles, history };
41
+ }
42
+
43
+ // Re-export runEnvelopeLoop so consumers can import the whole kit
44
+ // from one module path in downstream PRs.
45
+ export { runEnvelopeLoop };
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Agent envelope foundation (#A8).
3
+ *
4
+ * Generic multi-turn agent envelope that all 12 non-Jules personas adopt to
5
+ * become "Jules-tier" — i.e., stateful agents with a turn loop, stuck
6
+ * detection, and optional fix-cycles. Jules keeps its bespoke
7
+ * src/agents/jules/ package because it has additional swarm-coordination
8
+ * logic; everyone else shares this envelope.
9
+ *
10
+ * Public surface (stable):
11
+ * createAgentEnvelope(config) -> EnvelopeInstance
12
+ *
13
+ * An EnvelopeInstance has .run(inputs) that executes a bounded multi-turn
14
+ * loop over the configured tools and returns:
15
+ * {
16
+ * messages: [...full message trace...],
17
+ * findings: [...structured findings...],
18
+ * stuckReason: null | "no-tool-calls" | "max-turns" | "budget-exceeded",
19
+ * turnsUsed: number,
20
+ * toolInvocations: [{turn, tool, input, output, error?}]
21
+ * }
22
+ *
23
+ * The envelope delegates actual LLM invocation to a pluggable client
24
+ * supplied by the caller (so different personas can route to different
25
+ * providers). The envelope itself is provider-agnostic.
26
+ */
27
+
28
+ export { runEnvelopeLoop, DEFAULT_MAX_TURNS, DEFAULT_STUCK_THRESHOLD } from "./loop.js";
29
+ export { detectStuck } from "./pulse.js";
30
+ export { runFixCycle } from "./fix-cycle.js";
31
+ export { createEventStream } from "./stream.js";
@@ -0,0 +1,150 @@
1
+ /**
2
+ * Multi-turn agent loop (#A8 — the core of the envelope).
3
+ *
4
+ * Runs a plan → tool-calls → observe → continue/stop cycle with a hard
5
+ * maxTurns guard, stuck detection via pulse.detectStuck, and per-turn
6
+ * budget checks supplied by the caller.
7
+ *
8
+ * The loop is LLM-client-agnostic: callers pass a `client` that implements
9
+ * `async client.generatePlan(messages, options) -> plan`.
10
+ *
11
+ * A plan has shape:
12
+ * {
13
+ * stopReason: "end-turn" | "tool-use" | null,
14
+ * content: string, // may include reasoning / narration
15
+ * toolCalls: [{ name, input }],
16
+ * findings: [...], // optional per-turn findings
17
+ * }
18
+ */
19
+
20
+ import { detectStuck } from "./pulse.js";
21
+
22
+ export const DEFAULT_MAX_TURNS = 10;
23
+ export const DEFAULT_STUCK_THRESHOLD = 2;
24
+
25
+ /**
26
+ * @param {object} params
27
+ * @param {object} params.client
28
+ * @param {Array} params.initialMessages
29
+ * @param {Array} params.tools - list of { name, invoke(input) => Promise }
30
+ * @param {object} [params.options]
31
+ * @param {number} [params.options.maxTurns]
32
+ * @param {number} [params.options.stuckThreshold]
33
+ * @param {Function} [params.options.shouldAllowCall] - gate invoked before each LLM call
34
+ * @param {Function} [params.options.onTurn] - callback per turn
35
+ */
36
+ export async function runEnvelopeLoop({
37
+ client,
38
+ initialMessages = [],
39
+ tools = [],
40
+ options = {},
41
+ } = {}) {
42
+ if (!client || typeof client.generatePlan !== "function") {
43
+ throw new TypeError("runEnvelopeLoop requires a client with generatePlan()");
44
+ }
45
+
46
+ const maxTurns = Number.isInteger(options.maxTurns) ? options.maxTurns : DEFAULT_MAX_TURNS;
47
+ const stuckThreshold = Number.isInteger(options.stuckThreshold)
48
+ ? options.stuckThreshold
49
+ : DEFAULT_STUCK_THRESHOLD;
50
+ const shouldAllowCall = typeof options.shouldAllowCall === "function"
51
+ ? options.shouldAllowCall
52
+ : () => ({ allow: true });
53
+ const onTurn = typeof options.onTurn === "function" ? options.onTurn : null;
54
+
55
+ const messages = [...initialMessages];
56
+ const findings = [];
57
+ const toolInvocations = [];
58
+ const toolByName = new Map(tools.map((t) => [t.name, t]));
59
+ const turnStates = [];
60
+
61
+ let turnsUsed = 0;
62
+ let stuckReason = null;
63
+
64
+ for (let turn = 1; turn <= maxTurns; turn += 1) {
65
+ const budgetDecision = shouldAllowCall({ turn, messages });
66
+ if (budgetDecision && budgetDecision.allow === false) {
67
+ stuckReason = "budget-exceeded";
68
+ break;
69
+ }
70
+
71
+ let plan;
72
+ try {
73
+ plan = await client.generatePlan(messages, { turn, tools: tools.map((t) => t.name) });
74
+ } catch (err) {
75
+ messages.push({ role: "error", content: String(err) });
76
+ stuckReason = "client-error";
77
+ turnsUsed = turn;
78
+ break;
79
+ }
80
+
81
+ const toolCalls = Array.isArray(plan?.toolCalls) ? plan.toolCalls : [];
82
+ messages.push({ role: "assistant", content: plan?.content ?? "", toolCalls });
83
+ if (Array.isArray(plan?.findings)) {
84
+ findings.push(...plan.findings);
85
+ }
86
+
87
+ if (onTurn) {
88
+ try {
89
+ onTurn({ turn, plan });
90
+ } catch {
91
+ // onTurn is advisory; never let observer errors break the loop
92
+ }
93
+ }
94
+
95
+ turnsUsed = turn;
96
+ turnStates.push({ turn, hadToolCalls: toolCalls.length > 0 });
97
+
98
+ if (detectStuck(turnStates, stuckThreshold)) {
99
+ stuckReason = "no-tool-calls";
100
+ break;
101
+ }
102
+
103
+ if (plan?.stopReason === "end-turn") {
104
+ break;
105
+ }
106
+
107
+ // Execute tools.
108
+ for (const call of toolCalls) {
109
+ const tool = toolByName.get(call.name);
110
+ if (!tool) {
111
+ messages.push({
112
+ role: "tool-result",
113
+ toolName: call.name,
114
+ error: `Unknown tool: ${call.name}`,
115
+ });
116
+ toolInvocations.push({ turn, tool: call.name, input: call.input, error: "unknown-tool" });
117
+ continue;
118
+ }
119
+ try {
120
+ const output = await tool.invoke(call.input);
121
+ messages.push({
122
+ role: "tool-result",
123
+ toolName: call.name,
124
+ output,
125
+ });
126
+ toolInvocations.push({ turn, tool: call.name, input: call.input, output });
127
+ } catch (err) {
128
+ const errorMessage = err instanceof Error ? err.message : String(err);
129
+ messages.push({
130
+ role: "tool-result",
131
+ toolName: call.name,
132
+ error: errorMessage,
133
+ });
134
+ toolInvocations.push({ turn, tool: call.name, input: call.input, error: errorMessage });
135
+ }
136
+ }
137
+ }
138
+
139
+ if (!stuckReason && turnsUsed >= maxTurns) {
140
+ stuckReason = "max-turns";
141
+ }
142
+
143
+ return {
144
+ messages,
145
+ findings,
146
+ stuckReason,
147
+ turnsUsed,
148
+ toolInvocations,
149
+ };
150
+ }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Stuck-detection pulse (#A8 envelope).
3
+ *
4
+ * Called by the loop after each turn. If the agent has emitted zero
5
+ * tool calls for `threshold` consecutive turns, the loop short-circuits
6
+ * with stuckReason="no-tool-calls" — prevents infinite reasoning
7
+ * without action.
8
+ */
9
+
10
+ /**
11
+ * @param {Array<{turn: number, hadToolCalls: boolean}>} turnStates
12
+ * @param {number} threshold
13
+ */
14
+ export function detectStuck(turnStates, threshold = 2) {
15
+ if (!Array.isArray(turnStates) || turnStates.length < threshold) return false;
16
+ const recent = turnStates.slice(-threshold);
17
+ return recent.every((state) => state.hadToolCalls === false);
18
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Streaming event adapter (#A8 envelope).
3
+ *
4
+ * Wraps the envelope loop's onTurn callback so personas can publish
5
+ * turn-level events to any sink (Telegram forum topic, SSE channel,
6
+ * console spinner). The adapter normalizes event shape so sink
7
+ * implementations don't need to know envelope internals.
8
+ */
9
+
10
+ /**
11
+ * @param {object} [options]
12
+ * @param {Function} [options.sink] - (event) => void
13
+ */
14
+ export function createEventStream({ sink } = {}) {
15
+ const emit = typeof sink === "function" ? sink : () => {};
16
+ const events = [];
17
+
18
+ return {
19
+ /** Call this as the envelope loop's onTurn callback. */
20
+ onTurn: ({ turn, plan }) => {
21
+ const event = {
22
+ type: "turn",
23
+ turn,
24
+ planSummary: {
25
+ stopReason: plan?.stopReason ?? null,
26
+ toolCallCount: Array.isArray(plan?.toolCalls) ? plan.toolCalls.length : 0,
27
+ findingCount: Array.isArray(plan?.findings) ? plan.findings.length : 0,
28
+ },
29
+ };
30
+ events.push(event);
31
+ try {
32
+ emit(event);
33
+ } catch {
34
+ // sinks are advisory; never let them break the loop
35
+ }
36
+ },
37
+ /** Get the buffered event history. */
38
+ history: () => events.slice(),
39
+ };
40
+ }