@sanqianx/project-knowledge 5.0.18 → 5.0.20-rc.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 (209) hide show
  1. package/.agents/plugins/marketplace.json +3 -3
  2. package/.claude-plugin/marketplace.json +1 -1
  3. package/CHANGELOG.md +14 -0
  4. package/LICENSE +201 -201
  5. package/NOTICE +5 -5
  6. package/README.md +349 -349
  7. package/_modules/knowledge-engine/README.md +4 -0
  8. package/_modules/knowledge-engine/src/analysis-contract.js +4 -3
  9. package/_modules/knowledge-engine/src/analysis-failures.js +39 -0
  10. package/_modules/knowledge-engine/src/analysis-worker.js +6 -2
  11. package/_modules/knowledge-engine/src/coordinator.js +8 -0
  12. package/_modules/knowledge-engine/src/headless-analyzer.js +2 -1
  13. package/_modules/knowledge-engine/src/memories.js +10 -5
  14. package/_modules/knowledge-engine/src/memory-eligibility.js +74 -0
  15. package/_modules/knowledge-engine/src/retrieval-ranking.js +19 -1
  16. package/_modules/knowledge-engine/src/runtime/commit-conversation-binder.js +1 -0
  17. package/_modules/knowledge-engine/src/runtime/commit-prompt.js +12 -9
  18. package/_modules/knowledge-engine/src/runtime/conversation-store.js +2 -0
  19. package/_modules/knowledge-engine/src/server.js +1 -1
  20. package/_site/_test/agent-capture-mcp-ui-test.js +67 -67
  21. package/_site/_test/ai-profile-test.js +75 -75
  22. package/_site/_test/ai-vendor-presets-test.js +91 -91
  23. package/_site/_test/automatic-context-test.js +70 -70
  24. package/_site/_test/bin-cli-test.js +230 -230
  25. package/_site/_test/bridge-adapter-test.js +95 -95
  26. package/_site/_test/bridge-consumer-service-test.js +310 -310
  27. package/_site/_test/candidate-bin-content-test.js +35 -0
  28. package/_site/_test/candidate-product-assets-test.js +13 -0
  29. package/_site/_test/candidate-release-contract-test.js +14 -14
  30. package/_site/_test/capture-hook-dedup-test.js +158 -158
  31. package/_site/_test/claude-executable-discovery-test.js +28 -28
  32. package/_site/_test/claude-session-lifecycle-sweep-test.js +252 -252
  33. package/_site/_test/cli-instance-management-test.js +62 -62
  34. package/_site/_test/client-capture-restart-e2e-test.js +189 -189
  35. package/_site/_test/codex-conversation-projection-test.js +60 -60
  36. package/_site/_test/codex-marketplace-scoped-path-test.js +186 -186
  37. package/_site/_test/codex-notify-capture-e2e-test.js +101 -101
  38. package/_site/_test/codex-notify-fanout-test.js +134 -134
  39. package/_site/_test/codex-notify-upgrade-test.js +253 -253
  40. package/_site/_test/commit-boundary-freeze-test.js +147 -147
  41. package/_site/_test/commit-conversation-binding-test.js +4 -4
  42. package/_site/_test/configuration-generation-test.js +22 -22
  43. package/_site/_test/context-pack-test.js +200 -200
  44. package/_site/_test/conversation-api-test.js +10 -10
  45. package/_site/_test/conversation-origin-test.js +15 -0
  46. package/_site/_test/cross-repo-isolation-e2e-test.js +187 -187
  47. package/_site/_test/embedding-config-test.js +32 -32
  48. package/_site/_test/fixtures/fake-browser-exit.js +10 -10
  49. package/_site/_test/fixtures/fake-browser-hang.js +10 -10
  50. package/_site/_test/fixtures/integration-busy-worker.cjs +6 -6
  51. package/_site/_test/fixtures/make-git-repos.js +92 -92
  52. package/_site/_test/fixtures/retrieval-gold-queries.json +32 -0
  53. package/_site/_test/fresh-hook-reimport-test.js +53 -53
  54. package/_site/_test/fresh-product-data-test.js +56 -56
  55. package/_site/_test/git-path-compatibility-test.js +80 -80
  56. package/_site/_test/git-validation-test.js +81 -81
  57. package/_site/_test/hook-worktree-test.js +42 -42
  58. package/_site/_test/index-builder-test.js +41 -41
  59. package/_site/_test/index-error-display-contract-test.js +10 -10
  60. package/_site/_test/integration-adapters-test.js +67 -67
  61. package/_site/_test/integration-capture-setup-test.js +118 -118
  62. package/_site/_test/integration-runtime-binding-a2-test.js +566 -566
  63. package/_site/_test/integration-runtime-binding-a3-test.js +227 -227
  64. package/_site/_test/integration-runtime-binding-test.js +473 -473
  65. package/_site/_test/integration-status-scan-test.js +29 -29
  66. package/_site/_test/kb-framework-test.js +57 -57
  67. package/_site/_test/kbpath-follow-test.js +63 -63
  68. package/_site/_test/knowledge-db-test.js +144 -144
  69. package/_site/_test/knowledge-engine-client-test.js +109 -109
  70. package/_site/_test/knowledge-maintenance-test.js +40 -40
  71. package/_site/_test/knowledge-panel-ui-contract-test.js +112 -0
  72. package/_site/_test/knowledge-scopes-test.js +37 -37
  73. package/_site/_test/knowledge-storage-location-test.js +28 -28
  74. package/_site/_test/launcher-readiness-test.js +80 -80
  75. package/_site/_test/legacy-claude-session-alias-test.js +106 -106
  76. package/_site/_test/legacy-routes-removed-test.js +47 -47
  77. package/_site/_test/legacy-workbench-exclusion-test.js +92 -92
  78. package/_site/_test/live-gateway-test.js +48 -48
  79. package/_site/_test/local-marketplace-test.js +16 -16
  80. package/_site/_test/log-redaction-test.js +58 -58
  81. package/_site/_test/markdown-maintenance-test.js +11 -11
  82. package/_site/_test/model-context-windows-test.js +89 -89
  83. package/_site/_test/module-agent-start-proxy-test.js +65 -65
  84. package/_site/_test/module-artifact-integrity-test.js +27 -27
  85. package/_site/_test/module-boundary-test.js +30 -30
  86. package/_site/_test/module-bridge-eventbridge-test.js +202 -202
  87. package/_site/_test/module-dynamic-port-test.js +118 -118
  88. package/_site/_test/module-index-proxy-test.js +33 -0
  89. package/_site/_test/module-model-configuration-test.js +44 -44
  90. package/_site/_test/module-process-lifecycle-test.js +35 -35
  91. package/_site/_test/module-stream-proxy-test.js +34 -34
  92. package/_site/_test/module-terminal-restart-test.js +63 -0
  93. package/_site/_test/module-wiring-unbind-race-test.js +59 -59
  94. package/_site/_test/native-context-integrations-test.js +86 -86
  95. package/_site/_test/orphaned-claim-recovery-test.js +80 -80
  96. package/_site/_test/package-boundary-test.js +43 -42
  97. package/_site/_test/package-startup-test.js +56 -56
  98. package/_site/_test/packaged-ui-smoke-test.js +88 -88
  99. package/_site/_test/pr-consumer-contract-test.js +55 -55
  100. package/_site/_test/product-brand-contract-test.js +25 -25
  101. package/_site/_test/product-diagnostics-ui-test.js +93 -93
  102. package/_site/_test/product-import-ui-test.js +104 -104
  103. package/_site/_test/product-progress-status-test.js +12 -1
  104. package/_site/_test/project-remove-running-guard-test.js +79 -79
  105. package/_site/_test/project-store-test.js +90 -90
  106. package/_site/_test/registry-events-test.js +38 -0
  107. package/_site/_test/release-version-sync-test.js +115 -115
  108. package/_site/_test/requirement-binding-test.js +113 -113
  109. package/_site/_test/runtime-endpoint-test.js +64 -64
  110. package/_site/_test/scanner-test.js +83 -83
  111. package/_site/_test/server-security-test.js +96 -96
  112. package/_site/_test/sessions-stream-test.js +93 -93
  113. package/_site/_test/shared-scope-root-binding-test.js +67 -67
  114. package/_site/_test/simple-import-test.js +98 -98
  115. package/_site/_test/startup-analysis-disabled-test.js +6 -6
  116. package/_site/_test/team-knowledge-store-sparse-checkout-test.js +196 -196
  117. package/_site/_test/team-knowledge-store-test.js +132 -132
  118. package/_site/_test/test-server-cleanup-test.js +35 -35
  119. package/_site/_test/test-server-module-isolation-test.js +37 -37
  120. package/_site/_test/tracking-start-test.js +35 -35
  121. package/_site/_test/workbench-context-receipts-test.js +22 -0
  122. package/_site/_test/workspace-ui-contract-test.js +31 -31
  123. package/_site/_test/zcode-capture-integration-test.js +108 -108
  124. package/_site/lib/ai-vendor-presets.js +83 -83
  125. package/_site/lib/ai-workspace.js +3 -3
  126. package/_site/lib/atomic-file.js +204 -204
  127. package/_site/lib/bridge-adapter.js +260 -260
  128. package/_site/lib/capture-hook-config.js +108 -108
  129. package/_site/lib/claude-cli-runner.js +89 -89
  130. package/_site/lib/cli-instances.js +43 -43
  131. package/_site/lib/codex-context-status.js +17 -17
  132. package/_site/lib/codex-notify-config.js +193 -193
  133. package/_site/lib/commit-conversation-binder.js +13 -12
  134. package/_site/lib/commit-reconciler.js +38 -38
  135. package/_site/lib/context-pack-builder.js +299 -299
  136. package/_site/lib/conversation-exclusions.js +204 -204
  137. package/_site/lib/conversation-query-service.js +17 -17
  138. package/_site/lib/conversation-store.js +2 -0
  139. package/_site/lib/data-dir.js +13 -13
  140. package/_site/lib/embedding-service.js +85 -85
  141. package/_site/lib/engine-connection.js +93 -90
  142. package/_site/lib/engine-knowledge-client.js +72 -72
  143. package/_site/lib/folder-picker-output.js +3 -3
  144. package/_site/lib/git-path.js +14 -14
  145. package/_site/lib/github-team-store.js +3 -3
  146. package/_site/lib/index-builder.js +157 -157
  147. package/_site/lib/integration-status-scan.js +99 -99
  148. package/_site/lib/integration-status-worker.js +14 -14
  149. package/_site/lib/kb-framework.js +15 -15
  150. package/_site/lib/knowledge-db.js +363 -363
  151. package/_site/lib/knowledge-schema.js +121 -121
  152. package/_site/lib/live-gateway.js +78 -76
  153. package/_site/lib/llm-client.js +12 -12
  154. package/_site/lib/model-context-windows.js +82 -82
  155. package/_site/lib/module-bridge.js +874 -865
  156. package/_site/lib/module-port-resolver.js +57 -57
  157. package/_site/lib/post-commit-automation.js +54 -54
  158. package/_site/lib/product-data.js +35 -35
  159. package/_site/lib/project-lifecycle-service.js +14 -14
  160. package/_site/lib/project-registry-store.js +129 -129
  161. package/_site/lib/prompt-registry.js +148 -148
  162. package/_site/lib/registry-events.js +16 -0
  163. package/_site/lib/requirement-adapters.js +10 -10
  164. package/_site/lib/requirement-binder.js +112 -112
  165. package/_site/lib/runtime-control.js +89 -89
  166. package/_site/lib/runtime-endpoint.js +5 -5
  167. package/_site/lib/server-app.js +10 -1
  168. package/_site/lib/zcode-context-integration.js +60 -60
  169. package/_site/scripts/codex-notify-fanout.cjs +95 -95
  170. package/_site/scripts/install-module-candidates.js +69 -69
  171. package/_site/scripts/pack-module-candidates.js +89 -72
  172. package/_site/scripts/sync-product-content.js +28 -28
  173. package/_site/scripts/sync-release-version.js +164 -164
  174. package/_site/scripts/vendor-modules.js +49 -49
  175. package/_site/scripts/verify-module-runtime.js +50 -50
  176. package/_site/scripts/verify-product-runtime.js +36 -36
  177. package/_site/scripts/verify-retrieval-gold.js +83 -0
  178. package/_site/server.js +15 -15
  179. package/_site/start.bat +26 -26
  180. package/_site/stop.bat +11 -11
  181. package/bin/project-knowledge-integrations.js +254 -254
  182. package/bin/project-knowledge-kb.js +67 -67
  183. package/bin/project-knowledge-mcp.js +8 -8
  184. package/bin/project-knowledge.js +170 -170
  185. package/claude-prompts.json +21 -21
  186. package/docs/README.zh-CN.md +205 -205
  187. package/docs/assets/architecture.svg +181 -181
  188. package/docs/assets/logo.svg +49 -49
  189. package/docs/fresh-v5-start.md +42 -42
  190. package/docs/leader-glm-workbench-playbook.md +122 -119
  191. package/docs/project-registry-schema.md +11 -11
  192. package/docs/release-5.0.16-acceptance.md +176 -176
  193. package/docs/release-5.0.17-acceptance.md +117 -117
  194. package/docs/release-5.0.19-acceptance.md +39 -0
  195. package/docs/team-knowledge-mode-a-plan.md +73 -73
  196. package/module-runtime-manifest.json +126 -104
  197. package/package.json +110 -108
  198. package/plugins/project-knowledge/.claude-plugin/plugin.json +1 -1
  199. package/plugins/project-knowledge/.codex-plugin/plugin.json +1 -1
  200. package/plugins/project-knowledge/.mcp.json +1 -1
  201. package/plugins/project-knowledge/opencode/project-knowledge.md +3 -3
  202. package/plugins/project-knowledge/skills/project-knowledge/SKILL.md +28 -28
  203. package/templates/change.md +30 -30
  204. package/templates/project-readme.md +18 -18
  205. package/ui/index.html +1 -1
  206. package/ui/knowledge-panel.html +118 -0
  207. package/ui/product.css +8 -0
  208. package/ui/product.js +175 -8
  209. package/vendor-manifest.json +55 -53
@@ -1,299 +1,299 @@
1
- // Context Pack Builder (TASK-006)
2
- // Collects Git diff / stats, project goal, related module/change docs,
3
- // package/config files, neighbouring source, and tests into a machine-readable
4
- // context pack written to _site/_ai/<slug>/context-packs/<run-id>/.
5
- //
6
- // Path safety: every path is normalized and verified to live inside the project root
7
- // before it is added to the pack. Outside-the-project paths are rejected.
8
-
9
- const fs = require('fs');
10
- const path = require('path');
11
- const crypto = require('crypto');
12
- const { execGit } = require('./git-runner');
13
- const aiWorkspace = require('./ai-workspace');
14
-
15
- const MAX_FILE_BYTES = 200 * 1024; // Skip files larger than 200 KB
16
- const MAX_EXCERPT_BYTES = 8 * 1024; // Excerpt limited to 8 KB
17
- const BINARY_DETECT_BYTES = 4096; // Read up to 4 KB to detect binary
18
-
19
- const PACKAGE_CONFIG_FILES = [
20
- 'package.json', 'package-lock.json', 'pnpm-workspace.yaml', 'pnpm-lock.yaml',
21
- 'tsconfig.json', 'tsconfig.base.json', 'pyproject.toml', 'setup.py', 'requirements.txt',
22
- 'Cargo.toml', 'Cargo.lock', 'go.mod', 'go.sum', 'pom.xml', 'build.gradle',
23
- '.eslintrc.json', '.eslintrc.js', '.prettierrc.json',
24
- ];
25
-
26
- function shortHash(input) {
27
- return crypto.createHash('sha1').update(input).digest('hex').slice(0, 12);
28
- }
29
-
30
- function isSafePath(projectRoot, target) {
31
- const resolved = path.resolve(projectRoot, target);
32
- const root = path.resolve(projectRoot);
33
- // Use a separator-aware check so 'proj-other' does not pass 'proj' as parent.
34
- return resolved === root || resolved.startsWith(root + path.sep) || resolved.startsWith(root + '/');
35
- }
36
-
37
- function isBinaryBuffer(buf) {
38
- const limit = Math.min(BINARY_DETECT_BYTES, buf.length);
39
- for (let i = 0; i < limit; i++) {
40
- if (buf[i] === 0) return true;
41
- }
42
- return false;
43
- }
44
-
45
- function readSafeExcerpt(absPath) {
46
- let stat;
47
- try { stat = fs.statSync(absPath); } catch { return null; }
48
- if (!stat.isFile()) return null;
49
- if (stat.size > MAX_FILE_BYTES) {
50
- return { excerpt: null, size: stat.size, binary: false, skipped: 'too-large' };
51
- }
52
- let buf;
53
- try { buf = fs.readFileSync(absPath); } catch { return null; }
54
- if (isBinaryBuffer(buf)) {
55
- return { excerpt: null, size: stat.size, binary: true, skipped: 'binary' };
56
- }
57
- const text = buf.toString('utf-8');
58
- if (text.length > MAX_EXCERPT_BYTES) {
59
- return { excerpt: text.slice(0, MAX_EXCERPT_BYTES) + '\n...[truncated]', size: stat.size, binary: false, truncated: true };
60
- }
61
- return { excerpt: text, size: stat.size, binary: false, truncated: false };
62
- }
63
-
64
- function getNeighborPaths(projectRoot, changedFiles) {
65
- const neighbors = new Set();
66
- for (const file of changedFiles) {
67
- if (!file) continue;
68
- const dir = path.dirname(file);
69
- if (!dir || dir === '.') continue;
70
- try {
71
- const entries = fs.readdirSync(path.join(projectRoot, dir), { withFileTypes: true });
72
- for (const e of entries) {
73
- if (!e.isFile()) continue;
74
- if (e.name.startsWith('.')) continue;
75
- const rel = path.posix.join(dir, e.name).replace(/\\/g, '/');
76
- if (changedFiles.includes(rel)) continue;
77
- neighbors.add(rel);
78
- }
79
- } catch {
80
- // Neighbor discovery is optional evidence; unreadable directories are omitted from the manifest.
81
- }
82
- }
83
- return [...neighbors];
84
- }
85
-
86
- function getTestPaths(projectRoot, changedFiles) {
87
- const tests = new Set();
88
- const isTestName = (name) => /\.(test|spec)\.[a-z]+$/i.test(name) || /^test[s]?[\/\\]/i.test(name) || /__tests__[\/\\]/i.test(name);
89
- // Tests in the same directory tree, and direct "test" / "tests" siblings
90
- for (const file of changedFiles) {
91
- if (!file) continue;
92
- const dir = path.dirname(file);
93
- // Same-dir tests
94
- try {
95
- const entries = fs.readdirSync(path.join(projectRoot, dir), { withFileTypes: true });
96
- for (const e of entries) {
97
- if (!e.isFile()) continue;
98
- if (isTestName(e.name)) {
99
- tests.add(path.posix.join(dir, e.name).replace(/\\/g, '/'));
100
- }
101
- }
102
- } catch {
103
- // Test discovery is best-effort and records only readable sibling files.
104
- }
105
- // Direct test/ folder sibling
106
- for (const candidate of ['tests', 'test', '__tests__']) {
107
- const testDir = path.join(projectRoot, dir, candidate);
108
- if (!fs.existsSync(testDir)) continue;
109
- try {
110
- const entries = fs.readdirSync(testDir, { withFileTypes: true });
111
- for (const e of entries) {
112
- if (!e.isFile()) continue;
113
- if (isTestName(e.name)) {
114
- tests.add(path.posix.join(dir, candidate, e.name).replace(/\\/g, '/'));
115
- }
116
- }
117
- } catch {
118
- // An unreadable optional test directory contributes no context-pack entry.
119
- }
120
- }
121
- }
122
- return [...tests];
123
- }
124
-
125
- function findRelatedDocs(projectRoot, changedFiles) {
126
- // Map files to existing module/change docs by lightweight body/path match.
127
- const out = new Set();
128
- const dirs = [path.join(projectRoot, 'modules'), path.join(projectRoot, 'changes')];
129
- for (const dir of dirs) {
130
- if (!fs.existsSync(dir)) continue;
131
- let entries;
132
- try { entries = fs.readdirSync(dir, { withFileTypes: true }); } catch { continue; }
133
- for (const e of entries) {
134
- if (!e.isFile() || !e.name.endsWith('.md')) continue;
135
- const full = path.join(dir, e.name);
136
- let text;
137
- try { text = fs.readFileSync(full, 'utf-8'); } catch { continue; }
138
- const rel = path.posix.join(path.basename(dir), e.name).replace(/\\/g, '/');
139
- // Heuristic: if any changed file path is mentioned in the doc body, treat as related.
140
- for (const f of changedFiles) {
141
- if (f && text.includes(f)) { out.add(rel); break; }
142
- }
143
- }
144
- }
145
- return [...out];
146
- }
147
-
148
- async function buildContextPack({ project, runId, trigger, commits = [], options = {} }) {
149
- if (!project || !project.slug) throw new Error('project required');
150
- const slug = project.slug;
151
- if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(slug)) throw new Error('invalid project id');
152
- if (runId && !/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(runId)) throw new Error('invalid context pack run id');
153
- if (!project.kbPath) throw new Error('project.kbPath is required');
154
- const projectRoot = path.resolve(project.kbPath);
155
- if (!isSafePath(projectRoot, '')) throw new Error('unsafe project root');
156
-
157
- const gitPath = project.gitPath || project.localPath;
158
- if (!gitPath) throw new Error('project has no git/local path');
159
- const sourceRoot = path.resolve(gitPath); // source files live in the git repo, not the KB
160
-
161
- const maxFiles = Number.isInteger(options.maxFiles) && options.maxFiles > 0 ? Math.min(options.maxFiles, 500) : 80;
162
- const entries = [];
163
- const seenAbs = new Set();
164
- const safeSeen = (rel) => entries.find(e => e.path === rel);
165
-
166
- function addEntry(rel, kind, reason) {
167
- if (entries.length >= maxFiles) return;
168
- // Decide which root to read from: KB files are anchored at projectRoot,
169
- // source files are anchored at sourceRoot.
170
- const isKbKind = ['goal', 'analysis', 'module-doc', 'change-doc'].includes(kind);
171
- const root = isKbKind ? projectRoot : sourceRoot;
172
- if (!isSafePath(root, rel)) return; // path traversal guard
173
- if (safeSeen(rel)) return;
174
- const abs = path.join(root, rel);
175
- if (seenAbs.has(abs)) return;
176
- if (!fs.existsSync(abs)) return;
177
- let stat;
178
- try { stat = fs.statSync(abs); } catch { return; }
179
- if (!stat.isFile()) return;
180
- const data = readSafeExcerpt(abs);
181
- if (!data) return;
182
- entries.push({
183
- path: rel.replace(/\\/g, '/'),
184
- kind,
185
- reason,
186
- size: data.size,
187
- binary: data.binary,
188
- truncated: !!data.truncated,
189
- skipped: data.skipped || null,
190
- excerpt: data.excerpt,
191
- });
192
- seenAbs.add(abs);
193
- }
194
-
195
- // 1. project goal (highest-priority context)
196
- if (fs.existsSync(path.join(projectRoot, 'GOAL.md'))) {
197
- addEntry('GOAL.md', 'goal', 'highest-priority human-controlled truth');
198
- }
199
-
200
- // 2. architecture / project analysis
201
- if (fs.existsSync(path.join(projectRoot, 'ARCHITECTURE.md'))) {
202
- addEntry('ARCHITECTURE.md', 'analysis', 'current architecture and project description');
203
- }
204
-
205
- let changedFiles = [];
206
- let range = null;
207
- let diffStat = null;
208
-
209
- if (trigger === 'commits' && commits.length > 0) {
210
- // 3a. Collect every file touched by any of the commits (use git show --name-only).
211
- // This is safer than `diff first^..last` because the first commit has no parent.
212
- const seen = new Set();
213
- for (const c of commits) {
214
- const r = await execGit(gitPath, ['show', '--name-only', '--format=', c.hash]);
215
- if (r.ok) {
216
- for (const line of (r.stdout || '').split('\n')) {
217
- const f = line.trim();
218
- if (f) seen.add(f);
219
- }
220
- }
221
- }
222
- changedFiles = [...seen];
223
- range = `${commits[0].hash.slice(0, 7)}..${commits[commits.length - 1].hash.slice(0, 7)} (${commits.length} commit${commits.length === 1 ? '' : 's'})`;
224
- // shortstat across the union of commits
225
- const stat = await execGit(gitPath, ['diff', '--shortstat', `${commits[0].hash}^`, commits[commits.length - 1].hash]);
226
- if (stat.ok) diffStat = (stat.stdout || '').trim();
227
- } else {
228
- // initial: enumerate tracked files (top N by size is overkill — just take first maxFiles)
229
- const ls = await execGit(gitPath, ['ls-files']);
230
- if (ls.ok) {
231
- changedFiles = (ls.stdout || '').split('\n').map(s => s.trim()).filter(Boolean);
232
- }
233
- range = 'all-tracked-files';
234
- }
235
-
236
- // 3b. Changed files (as evidence)
237
- for (const f of changedFiles) addEntry(f, 'git-changed', trigger === 'commits' ? `changed in ${range}` : 'tracked file');
238
-
239
- // 4. Package / config files (look in source root)
240
- for (const f of PACKAGE_CONFIG_FILES) {
241
- if (fs.existsSync(path.join(sourceRoot, f))) addEntry(f, 'package-config', 'package or build configuration');
242
- }
243
-
244
- // 5. Neighbouring source files (in source root)
245
- for (const f of getNeighborPaths(sourceRoot, changedFiles)) {
246
- addEntry(f, 'neighbor', 'sibling of a changed file');
247
- }
248
-
249
- // 6. Tests near changed files (in source root)
250
- for (const f of getTestPaths(sourceRoot, changedFiles)) {
251
- addEntry(f, 'test-nearby', 'test for a changed file');
252
- }
253
-
254
- // 7. Related module / change docs (look in KB root)
255
- for (const f of findRelatedDocs(projectRoot, changedFiles)) {
256
- const kind = f.startsWith('changes/') ? 'change-doc' : 'module-doc';
257
- addEntry(f, kind, 'mentions a changed file');
258
- }
259
-
260
- const pack = {
261
- schema: 'context-pack/v1',
262
- runId: runId || shortHash(`${slug}:${Date.now()}:${Math.random()}`),
263
- project: slug,
264
- createdAt: new Date().toISOString(),
265
- trigger: trigger || 'initial',
266
- gitPath,
267
- kbPath: projectRoot,
268
- sourceBranch: project.currentBranch || null,
269
- sourceDefaultBranch: project.defaultBranch || null,
270
- sourceRemote: project.remoteUrl || null,
271
- range,
272
- diffStat,
273
- commitCount: commits.length,
274
- commits: commits.map(c => ({ hash: c.hash, short: c.short, subject: c.subject, date: c.date, author: c.author })),
275
- entries,
276
- limits: {
277
- maxFiles,
278
- maxFileBytes: MAX_FILE_BYTES,
279
- maxExcerptBytes: MAX_EXCERPT_BYTES,
280
- },
281
- };
282
-
283
- // 8. Write to disk
284
- const outDir = options.outputDir
285
- ? path.resolve(options.outputDir, pack.runId)
286
- : aiWorkspace.contextPackDir(slug, pack.runId);
287
- fs.mkdirSync(outDir, { recursive: true });
288
- fs.writeFileSync(path.join(outDir, 'context-pack.json'), JSON.stringify(pack, null, 2), 'utf-8');
289
-
290
- return pack;
291
- }
292
-
293
- module.exports = {
294
- buildContextPack,
295
- isSafePath,
296
- PACKAGE_CONFIG_FILES,
297
- MAX_FILE_BYTES,
298
- MAX_EXCERPT_BYTES,
299
- };
1
+ // Context Pack Builder (TASK-006)
2
+ // Collects Git diff / stats, project goal, related module/change docs,
3
+ // package/config files, neighbouring source, and tests into a machine-readable
4
+ // context pack written to _site/_ai/<slug>/context-packs/<run-id>/.
5
+ //
6
+ // Path safety: every path is normalized and verified to live inside the project root
7
+ // before it is added to the pack. Outside-the-project paths are rejected.
8
+
9
+ const fs = require('fs');
10
+ const path = require('path');
11
+ const crypto = require('crypto');
12
+ const { execGit } = require('./git-runner');
13
+ const aiWorkspace = require('./ai-workspace');
14
+
15
+ const MAX_FILE_BYTES = 200 * 1024; // Skip files larger than 200 KB
16
+ const MAX_EXCERPT_BYTES = 8 * 1024; // Excerpt limited to 8 KB
17
+ const BINARY_DETECT_BYTES = 4096; // Read up to 4 KB to detect binary
18
+
19
+ const PACKAGE_CONFIG_FILES = [
20
+ 'package.json', 'package-lock.json', 'pnpm-workspace.yaml', 'pnpm-lock.yaml',
21
+ 'tsconfig.json', 'tsconfig.base.json', 'pyproject.toml', 'setup.py', 'requirements.txt',
22
+ 'Cargo.toml', 'Cargo.lock', 'go.mod', 'go.sum', 'pom.xml', 'build.gradle',
23
+ '.eslintrc.json', '.eslintrc.js', '.prettierrc.json',
24
+ ];
25
+
26
+ function shortHash(input) {
27
+ return crypto.createHash('sha1').update(input).digest('hex').slice(0, 12);
28
+ }
29
+
30
+ function isSafePath(projectRoot, target) {
31
+ const resolved = path.resolve(projectRoot, target);
32
+ const root = path.resolve(projectRoot);
33
+ // Use a separator-aware check so 'proj-other' does not pass 'proj' as parent.
34
+ return resolved === root || resolved.startsWith(root + path.sep) || resolved.startsWith(root + '/');
35
+ }
36
+
37
+ function isBinaryBuffer(buf) {
38
+ const limit = Math.min(BINARY_DETECT_BYTES, buf.length);
39
+ for (let i = 0; i < limit; i++) {
40
+ if (buf[i] === 0) return true;
41
+ }
42
+ return false;
43
+ }
44
+
45
+ function readSafeExcerpt(absPath) {
46
+ let stat;
47
+ try { stat = fs.statSync(absPath); } catch { return null; }
48
+ if (!stat.isFile()) return null;
49
+ if (stat.size > MAX_FILE_BYTES) {
50
+ return { excerpt: null, size: stat.size, binary: false, skipped: 'too-large' };
51
+ }
52
+ let buf;
53
+ try { buf = fs.readFileSync(absPath); } catch { return null; }
54
+ if (isBinaryBuffer(buf)) {
55
+ return { excerpt: null, size: stat.size, binary: true, skipped: 'binary' };
56
+ }
57
+ const text = buf.toString('utf-8');
58
+ if (text.length > MAX_EXCERPT_BYTES) {
59
+ return { excerpt: text.slice(0, MAX_EXCERPT_BYTES) + '\n...[truncated]', size: stat.size, binary: false, truncated: true };
60
+ }
61
+ return { excerpt: text, size: stat.size, binary: false, truncated: false };
62
+ }
63
+
64
+ function getNeighborPaths(projectRoot, changedFiles) {
65
+ const neighbors = new Set();
66
+ for (const file of changedFiles) {
67
+ if (!file) continue;
68
+ const dir = path.dirname(file);
69
+ if (!dir || dir === '.') continue;
70
+ try {
71
+ const entries = fs.readdirSync(path.join(projectRoot, dir), { withFileTypes: true });
72
+ for (const e of entries) {
73
+ if (!e.isFile()) continue;
74
+ if (e.name.startsWith('.')) continue;
75
+ const rel = path.posix.join(dir, e.name).replace(/\\/g, '/');
76
+ if (changedFiles.includes(rel)) continue;
77
+ neighbors.add(rel);
78
+ }
79
+ } catch {
80
+ // Neighbor discovery is optional evidence; unreadable directories are omitted from the manifest.
81
+ }
82
+ }
83
+ return [...neighbors];
84
+ }
85
+
86
+ function getTestPaths(projectRoot, changedFiles) {
87
+ const tests = new Set();
88
+ const isTestName = (name) => /\.(test|spec)\.[a-z]+$/i.test(name) || /^test[s]?[\/\\]/i.test(name) || /__tests__[\/\\]/i.test(name);
89
+ // Tests in the same directory tree, and direct "test" / "tests" siblings
90
+ for (const file of changedFiles) {
91
+ if (!file) continue;
92
+ const dir = path.dirname(file);
93
+ // Same-dir tests
94
+ try {
95
+ const entries = fs.readdirSync(path.join(projectRoot, dir), { withFileTypes: true });
96
+ for (const e of entries) {
97
+ if (!e.isFile()) continue;
98
+ if (isTestName(e.name)) {
99
+ tests.add(path.posix.join(dir, e.name).replace(/\\/g, '/'));
100
+ }
101
+ }
102
+ } catch {
103
+ // Test discovery is best-effort and records only readable sibling files.
104
+ }
105
+ // Direct test/ folder sibling
106
+ for (const candidate of ['tests', 'test', '__tests__']) {
107
+ const testDir = path.join(projectRoot, dir, candidate);
108
+ if (!fs.existsSync(testDir)) continue;
109
+ try {
110
+ const entries = fs.readdirSync(testDir, { withFileTypes: true });
111
+ for (const e of entries) {
112
+ if (!e.isFile()) continue;
113
+ if (isTestName(e.name)) {
114
+ tests.add(path.posix.join(dir, candidate, e.name).replace(/\\/g, '/'));
115
+ }
116
+ }
117
+ } catch {
118
+ // An unreadable optional test directory contributes no context-pack entry.
119
+ }
120
+ }
121
+ }
122
+ return [...tests];
123
+ }
124
+
125
+ function findRelatedDocs(projectRoot, changedFiles) {
126
+ // Map files to existing module/change docs by lightweight body/path match.
127
+ const out = new Set();
128
+ const dirs = [path.join(projectRoot, 'modules'), path.join(projectRoot, 'changes')];
129
+ for (const dir of dirs) {
130
+ if (!fs.existsSync(dir)) continue;
131
+ let entries;
132
+ try { entries = fs.readdirSync(dir, { withFileTypes: true }); } catch { continue; }
133
+ for (const e of entries) {
134
+ if (!e.isFile() || !e.name.endsWith('.md')) continue;
135
+ const full = path.join(dir, e.name);
136
+ let text;
137
+ try { text = fs.readFileSync(full, 'utf-8'); } catch { continue; }
138
+ const rel = path.posix.join(path.basename(dir), e.name).replace(/\\/g, '/');
139
+ // Heuristic: if any changed file path is mentioned in the doc body, treat as related.
140
+ for (const f of changedFiles) {
141
+ if (f && text.includes(f)) { out.add(rel); break; }
142
+ }
143
+ }
144
+ }
145
+ return [...out];
146
+ }
147
+
148
+ async function buildContextPack({ project, runId, trigger, commits = [], options = {} }) {
149
+ if (!project || !project.slug) throw new Error('project required');
150
+ const slug = project.slug;
151
+ if (!/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(slug)) throw new Error('invalid project id');
152
+ if (runId && !/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/.test(runId)) throw new Error('invalid context pack run id');
153
+ if (!project.kbPath) throw new Error('project.kbPath is required');
154
+ const projectRoot = path.resolve(project.kbPath);
155
+ if (!isSafePath(projectRoot, '')) throw new Error('unsafe project root');
156
+
157
+ const gitPath = project.gitPath || project.localPath;
158
+ if (!gitPath) throw new Error('project has no git/local path');
159
+ const sourceRoot = path.resolve(gitPath); // source files live in the git repo, not the KB
160
+
161
+ const maxFiles = Number.isInteger(options.maxFiles) && options.maxFiles > 0 ? Math.min(options.maxFiles, 500) : 80;
162
+ const entries = [];
163
+ const seenAbs = new Set();
164
+ const safeSeen = (rel) => entries.find(e => e.path === rel);
165
+
166
+ function addEntry(rel, kind, reason) {
167
+ if (entries.length >= maxFiles) return;
168
+ // Decide which root to read from: KB files are anchored at projectRoot,
169
+ // source files are anchored at sourceRoot.
170
+ const isKbKind = ['goal', 'analysis', 'module-doc', 'change-doc'].includes(kind);
171
+ const root = isKbKind ? projectRoot : sourceRoot;
172
+ if (!isSafePath(root, rel)) return; // path traversal guard
173
+ if (safeSeen(rel)) return;
174
+ const abs = path.join(root, rel);
175
+ if (seenAbs.has(abs)) return;
176
+ if (!fs.existsSync(abs)) return;
177
+ let stat;
178
+ try { stat = fs.statSync(abs); } catch { return; }
179
+ if (!stat.isFile()) return;
180
+ const data = readSafeExcerpt(abs);
181
+ if (!data) return;
182
+ entries.push({
183
+ path: rel.replace(/\\/g, '/'),
184
+ kind,
185
+ reason,
186
+ size: data.size,
187
+ binary: data.binary,
188
+ truncated: !!data.truncated,
189
+ skipped: data.skipped || null,
190
+ excerpt: data.excerpt,
191
+ });
192
+ seenAbs.add(abs);
193
+ }
194
+
195
+ // 1. project goal (highest-priority context)
196
+ if (fs.existsSync(path.join(projectRoot, 'GOAL.md'))) {
197
+ addEntry('GOAL.md', 'goal', 'highest-priority human-controlled truth');
198
+ }
199
+
200
+ // 2. architecture / project analysis
201
+ if (fs.existsSync(path.join(projectRoot, 'ARCHITECTURE.md'))) {
202
+ addEntry('ARCHITECTURE.md', 'analysis', 'current architecture and project description');
203
+ }
204
+
205
+ let changedFiles = [];
206
+ let range = null;
207
+ let diffStat = null;
208
+
209
+ if (trigger === 'commits' && commits.length > 0) {
210
+ // 3a. Collect every file touched by any of the commits (use git show --name-only).
211
+ // This is safer than `diff first^..last` because the first commit has no parent.
212
+ const seen = new Set();
213
+ for (const c of commits) {
214
+ const r = await execGit(gitPath, ['show', '--name-only', '--format=', c.hash]);
215
+ if (r.ok) {
216
+ for (const line of (r.stdout || '').split('\n')) {
217
+ const f = line.trim();
218
+ if (f) seen.add(f);
219
+ }
220
+ }
221
+ }
222
+ changedFiles = [...seen];
223
+ range = `${commits[0].hash.slice(0, 7)}..${commits[commits.length - 1].hash.slice(0, 7)} (${commits.length} commit${commits.length === 1 ? '' : 's'})`;
224
+ // shortstat across the union of commits
225
+ const stat = await execGit(gitPath, ['diff', '--shortstat', `${commits[0].hash}^`, commits[commits.length - 1].hash]);
226
+ if (stat.ok) diffStat = (stat.stdout || '').trim();
227
+ } else {
228
+ // initial: enumerate tracked files (top N by size is overkill — just take first maxFiles)
229
+ const ls = await execGit(gitPath, ['ls-files']);
230
+ if (ls.ok) {
231
+ changedFiles = (ls.stdout || '').split('\n').map(s => s.trim()).filter(Boolean);
232
+ }
233
+ range = 'all-tracked-files';
234
+ }
235
+
236
+ // 3b. Changed files (as evidence)
237
+ for (const f of changedFiles) addEntry(f, 'git-changed', trigger === 'commits' ? `changed in ${range}` : 'tracked file');
238
+
239
+ // 4. Package / config files (look in source root)
240
+ for (const f of PACKAGE_CONFIG_FILES) {
241
+ if (fs.existsSync(path.join(sourceRoot, f))) addEntry(f, 'package-config', 'package or build configuration');
242
+ }
243
+
244
+ // 5. Neighbouring source files (in source root)
245
+ for (const f of getNeighborPaths(sourceRoot, changedFiles)) {
246
+ addEntry(f, 'neighbor', 'sibling of a changed file');
247
+ }
248
+
249
+ // 6. Tests near changed files (in source root)
250
+ for (const f of getTestPaths(sourceRoot, changedFiles)) {
251
+ addEntry(f, 'test-nearby', 'test for a changed file');
252
+ }
253
+
254
+ // 7. Related module / change docs (look in KB root)
255
+ for (const f of findRelatedDocs(projectRoot, changedFiles)) {
256
+ const kind = f.startsWith('changes/') ? 'change-doc' : 'module-doc';
257
+ addEntry(f, kind, 'mentions a changed file');
258
+ }
259
+
260
+ const pack = {
261
+ schema: 'context-pack/v1',
262
+ runId: runId || shortHash(`${slug}:${Date.now()}:${Math.random()}`),
263
+ project: slug,
264
+ createdAt: new Date().toISOString(),
265
+ trigger: trigger || 'initial',
266
+ gitPath,
267
+ kbPath: projectRoot,
268
+ sourceBranch: project.currentBranch || null,
269
+ sourceDefaultBranch: project.defaultBranch || null,
270
+ sourceRemote: project.remoteUrl || null,
271
+ range,
272
+ diffStat,
273
+ commitCount: commits.length,
274
+ commits: commits.map(c => ({ hash: c.hash, short: c.short, subject: c.subject, date: c.date, author: c.author })),
275
+ entries,
276
+ limits: {
277
+ maxFiles,
278
+ maxFileBytes: MAX_FILE_BYTES,
279
+ maxExcerptBytes: MAX_EXCERPT_BYTES,
280
+ },
281
+ };
282
+
283
+ // 8. Write to disk
284
+ const outDir = options.outputDir
285
+ ? path.resolve(options.outputDir, pack.runId)
286
+ : aiWorkspace.contextPackDir(slug, pack.runId);
287
+ fs.mkdirSync(outDir, { recursive: true });
288
+ fs.writeFileSync(path.join(outDir, 'context-pack.json'), JSON.stringify(pack, null, 2), 'utf-8');
289
+
290
+ return pack;
291
+ }
292
+
293
+ module.exports = {
294
+ buildContextPack,
295
+ isSafePath,
296
+ PACKAGE_CONFIG_FILES,
297
+ MAX_FILE_BYTES,
298
+ MAX_EXCERPT_BYTES,
299
+ };