create-claude-context 1.0.0 → 1.2.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 (117) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +169 -146
  3. package/bin/create-claude-context.js +75 -61
  4. package/lib/ai-orchestrator.js +423 -0
  5. package/lib/call-tracer.js +444 -0
  6. package/lib/detector.js +456 -373
  7. package/lib/environment-detector.js +239 -0
  8. package/lib/index.js +271 -170
  9. package/lib/installer.js +371 -362
  10. package/lib/placeholder.js +269 -208
  11. package/lib/prompts.js +287 -287
  12. package/lib/spinner.js +60 -60
  13. package/lib/static-analyzer.js +729 -0
  14. package/lib/template-populator.js +835 -0
  15. package/lib/validate.js +147 -147
  16. package/package.json +59 -59
  17. package/templates/CLAUDE.md.template +235 -235
  18. package/templates/base/README.md +257 -257
  19. package/templates/base/RPI_WORKFLOW_PLAN.md +320 -320
  20. package/templates/base/agents/api-developer.md +76 -76
  21. package/templates/base/agents/context-engineer.md +525 -525
  22. package/templates/base/agents/core-architect.md +76 -76
  23. package/templates/base/agents/database-ops.md +76 -76
  24. package/templates/base/agents/deployment-ops.md +76 -76
  25. package/templates/base/agents/integration-hub.md +76 -76
  26. package/templates/base/analytics/README.md +114 -114
  27. package/templates/base/automation/config.json +58 -0
  28. package/templates/base/automation/generators/code-mapper.js +308 -0
  29. package/templates/base/automation/generators/index-builder.js +321 -0
  30. package/templates/base/automation/hooks/post-commit.sh +83 -0
  31. package/templates/base/automation/hooks/pre-commit.sh +103 -0
  32. package/templates/base/ci-templates/README.md +108 -108
  33. package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
  34. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
  35. package/templates/base/commands/analytics.md +238 -238
  36. package/templates/base/commands/auto-sync.md +172 -0
  37. package/templates/base/commands/collab.md +194 -194
  38. package/templates/base/commands/help.md +450 -450
  39. package/templates/base/commands/rpi-implement.md +115 -115
  40. package/templates/base/commands/rpi-plan.md +93 -93
  41. package/templates/base/commands/rpi-research.md +88 -88
  42. package/templates/base/commands/session-resume.md +144 -0
  43. package/templates/base/commands/session-save.md +112 -0
  44. package/templates/base/commands/validate-all.md +77 -77
  45. package/templates/base/commands/verify-docs-current.md +86 -86
  46. package/templates/base/config/base.json +57 -57
  47. package/templates/base/config/environments/development.json +13 -13
  48. package/templates/base/config/environments/production.json +17 -17
  49. package/templates/base/config/environments/staging.json +13 -13
  50. package/templates/base/config/local.json.example +21 -21
  51. package/templates/base/context/.meta/generated-at.json +18 -0
  52. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
  53. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
  54. package/templates/base/context/FILE_OWNERSHIP.md +57 -0
  55. package/templates/base/context/INTEGRATION_POINTS.md +92 -0
  56. package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
  57. package/templates/base/context/TESTING_MAP.md +95 -0
  58. package/templates/base/context/WORKFLOW_INDEX.md +129 -129
  59. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
  60. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
  61. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
  62. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
  63. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
  64. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
  65. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
  66. package/templates/base/knowledge/README.md +98 -98
  67. package/templates/base/knowledge/sessions/README.md +88 -88
  68. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
  69. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
  70. package/templates/base/knowledge/shared/decisions/README.md +49 -49
  71. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
  72. package/templates/base/knowledge/shared/patterns/README.md +62 -62
  73. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
  74. package/templates/base/plans/PLAN_TEMPLATE.md +250 -250
  75. package/templates/base/research/RESEARCH_TEMPLATE.md +153 -153
  76. package/templates/base/schemas/agent.schema.json +141 -141
  77. package/templates/base/schemas/anchors.schema.json +54 -0
  78. package/templates/base/schemas/automation.schema.json +93 -0
  79. package/templates/base/schemas/command.schema.json +134 -134
  80. package/templates/base/schemas/hashes.schema.json +40 -0
  81. package/templates/base/schemas/manifest.schema.json +117 -117
  82. package/templates/base/schemas/plan.schema.json +136 -136
  83. package/templates/base/schemas/research.schema.json +115 -115
  84. package/templates/base/schemas/roles.schema.json +34 -0
  85. package/templates/base/schemas/session.schema.json +77 -0
  86. package/templates/base/schemas/settings.schema.json +244 -244
  87. package/templates/base/schemas/staleness.schema.json +53 -0
  88. package/templates/base/schemas/team-config.schema.json +42 -0
  89. package/templates/base/schemas/workflow.schema.json +126 -126
  90. package/templates/base/session/checkpoints/.gitkeep +2 -0
  91. package/templates/base/session/current/state.json +20 -0
  92. package/templates/base/session/history/.gitkeep +2 -0
  93. package/templates/base/settings.json +3 -57
  94. package/templates/base/standards/COMPATIBILITY.md +219 -219
  95. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
  96. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
  97. package/templates/base/standards/README.md +66 -66
  98. package/templates/base/sync/anchors.json +6 -0
  99. package/templates/base/sync/hashes.json +6 -0
  100. package/templates/base/sync/staleness.json +10 -0
  101. package/templates/base/team/README.md +168 -168
  102. package/templates/base/team/config.json +79 -79
  103. package/templates/base/team/roles.json +145 -145
  104. package/templates/base/tools/bin/claude-context.js +151 -151
  105. package/templates/base/tools/lib/anchor-resolver.js +276 -0
  106. package/templates/base/tools/lib/config-loader.js +363 -363
  107. package/templates/base/tools/lib/detector.js +350 -350
  108. package/templates/base/tools/lib/diagnose.js +206 -206
  109. package/templates/base/tools/lib/drift-detector.js +373 -0
  110. package/templates/base/tools/lib/errors.js +199 -199
  111. package/templates/base/tools/lib/index.js +36 -24
  112. package/templates/base/tools/lib/init.js +192 -192
  113. package/templates/base/tools/lib/logger.js +230 -230
  114. package/templates/base/tools/lib/placeholder.js +201 -201
  115. package/templates/base/tools/lib/session-manager.js +354 -0
  116. package/templates/base/tools/lib/validate.js +521 -521
  117. package/templates/base/tools/package.json +49 -49
@@ -1,521 +1,521 @@
1
- /**
2
- * Claude Context Engineering - Validation Module
3
- *
4
- * Comprehensive validation of the context engineering setup:
5
- * - Schema validation for JSON files
6
- * - Markdown link validation
7
- * - Placeholder detection
8
- * - Line number accuracy checking
9
- * - Structure validation
10
- */
11
-
12
- const fs = require('fs');
13
- const path = require('path');
14
- const chalk = require('chalk');
15
- const Ajv = require('ajv');
16
- const addFormats = require('ajv-formats');
17
- const { glob } = require('glob');
18
- const { configLoader, findClaudeDir, loadJsonFile } = require('./config-loader');
19
- const { logger } = require('./logger');
20
- const { ValidationError } = require('./errors');
21
-
22
- /**
23
- * Main validation function
24
- */
25
- async function validate(options = {}) {
26
- const {
27
- all = false,
28
- links = false,
29
- lines = false,
30
- placeholders = false,
31
- schema = false,
32
- structure = false,
33
- threshold = 60,
34
- output = 'console',
35
- file = null,
36
- } = options;
37
-
38
- const op = logger.startOperation('validate');
39
- const claudeDir = options.claudeDir || findClaudeDir();
40
- const projectRoot = path.dirname(claudeDir);
41
-
42
- const results = {
43
- timestamp: new Date().toISOString(),
44
- claudeDir,
45
- checks: {},
46
- summary: {
47
- total: 0,
48
- passed: 0,
49
- failed: 0,
50
- warnings: 0,
51
- },
52
- };
53
-
54
- try {
55
- console.log(chalk.cyan('\n🔍 Running Validation Suite...\n'));
56
-
57
- // Schema validation
58
- if (all || schema) {
59
- console.log(chalk.white('Schema Validation'));
60
- console.log(chalk.gray('─'.repeat(50)));
61
- results.checks.schema = await validateSchemas(claudeDir);
62
- printCheckResult(results.checks.schema);
63
- }
64
-
65
- // Link validation
66
- if (all || links) {
67
- console.log(chalk.white('\nLink Validation'));
68
- console.log(chalk.gray('─'.repeat(50)));
69
- results.checks.links = await validateLinks(claudeDir, projectRoot);
70
- printCheckResult(results.checks.links);
71
- }
72
-
73
- // Placeholder detection
74
- if (all || placeholders) {
75
- console.log(chalk.white('\nPlaceholder Detection'));
76
- console.log(chalk.gray('─'.repeat(50)));
77
- results.checks.placeholders = await detectPlaceholders(claudeDir, projectRoot);
78
- printCheckResult(results.checks.placeholders);
79
- }
80
-
81
- // Line number accuracy
82
- if (all || lines) {
83
- console.log(chalk.white('\nLine Number Accuracy'));
84
- console.log(chalk.gray('─'.repeat(50)));
85
- results.checks.lineNumbers = await validateLineNumbers(claudeDir, projectRoot, parseInt(threshold));
86
- printCheckResult(results.checks.lineNumbers);
87
- }
88
-
89
- // Structure validation
90
- if (all || structure) {
91
- console.log(chalk.white('\nStructure Validation'));
92
- console.log(chalk.gray('─'.repeat(50)));
93
- results.checks.structure = await validateStructure(claudeDir);
94
- printCheckResult(results.checks.structure);
95
- }
96
-
97
- // Calculate summary
98
- for (const check of Object.values(results.checks)) {
99
- results.summary.total++;
100
- if (check.status === 'PASS') results.summary.passed++;
101
- else if (check.status === 'FAIL') results.summary.failed++;
102
- else if (check.status === 'WARN') results.summary.warnings++;
103
- }
104
-
105
- // Print summary
106
- printSummary(results.summary);
107
-
108
- // Output results
109
- if (output === 'json') {
110
- console.log(JSON.stringify(results, null, 2));
111
- } else if (output === 'markdown') {
112
- console.log(formatMarkdown(results));
113
- }
114
-
115
- op.success();
116
- return results;
117
-
118
- } catch (error) {
119
- op.fail(error);
120
- throw error;
121
- }
122
- }
123
-
124
- /**
125
- * Validate JSON files against their schemas
126
- */
127
- async function validateSchemas(claudeDir) {
128
- const result = {
129
- name: 'Schema Validation',
130
- status: 'PASS',
131
- checked: 0,
132
- passed: 0,
133
- failed: 0,
134
- issues: [],
135
- };
136
-
137
- const ajv = new Ajv({ allErrors: true, strict: false });
138
- addFormats(ajv);
139
-
140
- // Load all schemas
141
- const schemaDir = path.join(claudeDir, 'schemas');
142
- if (!fs.existsSync(schemaDir)) {
143
- result.status = 'WARN';
144
- result.issues.push({ file: schemaDir, message: 'Schemas directory not found' });
145
- return result;
146
- }
147
-
148
- // Validate settings.json
149
- const settingsPath = path.join(claudeDir, 'settings.json');
150
- const settingsSchemaPath = path.join(schemaDir, 'settings.schema.json');
151
-
152
- if (fs.existsSync(settingsPath) && fs.existsSync(settingsSchemaPath)) {
153
- result.checked++;
154
- try {
155
- const settings = loadJsonFile(settingsPath);
156
- const schema = loadJsonFile(settingsSchemaPath);
157
- const validate = ajv.compile(schema);
158
-
159
- if (validate(settings)) {
160
- result.passed++;
161
- console.log(chalk.green(' ✓ settings.json'));
162
- } else {
163
- result.failed++;
164
- result.status = 'FAIL';
165
- const errors = validate.errors.map(e => `${e.instancePath} ${e.message}`);
166
- result.issues.push({ file: 'settings.json', errors });
167
- console.log(chalk.red(' ✗ settings.json'));
168
- errors.forEach(e => console.log(chalk.gray(` - ${e}`)));
169
- }
170
- } catch (error) {
171
- result.failed++;
172
- result.status = 'FAIL';
173
- result.issues.push({ file: 'settings.json', message: error.message });
174
- console.log(chalk.red(` ✗ settings.json: ${error.message}`));
175
- }
176
- }
177
-
178
- return result;
179
- }
180
-
181
- /**
182
- * Validate markdown links
183
- */
184
- async function validateLinks(claudeDir, projectRoot) {
185
- const result = {
186
- name: 'Link Validation',
187
- status: 'PASS',
188
- checked: 0,
189
- valid: 0,
190
- broken: 0,
191
- issues: [],
192
- };
193
-
194
- // Find all markdown files
195
- const mdFiles = await glob('**/*.md', {
196
- cwd: claudeDir,
197
- ignore: ['node_modules/**'],
198
- });
199
-
200
- const linkPattern = /\[([^\]]+)\]\(([^)]+)\)/g;
201
-
202
- for (const mdFile of mdFiles) {
203
- const filePath = path.join(claudeDir, mdFile);
204
- const content = fs.readFileSync(filePath, 'utf8');
205
- let match;
206
-
207
- while ((match = linkPattern.exec(content)) !== null) {
208
- const [, text, link] = match;
209
-
210
- // Skip external links and anchors
211
- if (link.startsWith('http') || link.startsWith('#') || link.startsWith('mailto:')) {
212
- continue;
213
- }
214
-
215
- result.checked++;
216
-
217
- // Resolve the link path
218
- const linkPath = path.resolve(path.dirname(filePath), link.split('#')[0]);
219
-
220
- if (fs.existsSync(linkPath)) {
221
- result.valid++;
222
- } else {
223
- result.broken++;
224
- result.issues.push({
225
- file: mdFile,
226
- link,
227
- text,
228
- });
229
- console.log(chalk.red(` ✗ ${mdFile}: broken link "${link}"`));
230
- }
231
- }
232
- }
233
-
234
- if (result.broken > 0) {
235
- result.status = 'FAIL';
236
- }
237
-
238
- console.log(chalk.gray(` Checked ${result.checked} links, ${result.valid} valid, ${result.broken} broken`));
239
-
240
- return result;
241
- }
242
-
243
- /**
244
- * Detect remaining placeholders
245
- */
246
- async function detectPlaceholders(claudeDir, projectRoot) {
247
- const result = {
248
- name: 'Placeholder Detection',
249
- status: 'PASS',
250
- checked: 0,
251
- found: 0,
252
- issues: [],
253
- };
254
-
255
- const placeholderPattern = /\{\{([A-Z_]+)\}\}/g;
256
-
257
- // Check CLAUDE.md in project root
258
- const claudeMdPath = path.join(projectRoot, 'CLAUDE.md');
259
- if (fs.existsSync(claudeMdPath)) {
260
- const content = fs.readFileSync(claudeMdPath, 'utf8');
261
- let match;
262
-
263
- while ((match = placeholderPattern.exec(content)) !== null) {
264
- result.found++;
265
- result.issues.push({
266
- file: 'CLAUDE.md',
267
- placeholder: match[0],
268
- name: match[1],
269
- });
270
- }
271
- result.checked++;
272
- }
273
-
274
- // Check files in .claude directory
275
- const mdFiles = await glob('**/*.md', {
276
- cwd: claudeDir,
277
- ignore: ['node_modules/**'],
278
- });
279
-
280
- for (const mdFile of mdFiles) {
281
- const filePath = path.join(claudeDir, mdFile);
282
- const content = fs.readFileSync(filePath, 'utf8');
283
- let match;
284
-
285
- while ((match = placeholderPattern.exec(content)) !== null) {
286
- result.found++;
287
- result.issues.push({
288
- file: `.claude/${mdFile}`,
289
- placeholder: match[0],
290
- name: match[1],
291
- });
292
- }
293
- result.checked++;
294
- }
295
-
296
- if (result.found > 0) {
297
- result.status = 'WARN';
298
- console.log(chalk.yellow(` ⚠️ Found ${result.found} unresolved placeholders:`));
299
- result.issues.forEach(issue => {
300
- console.log(chalk.gray(` - ${issue.file}: ${issue.placeholder}`));
301
- });
302
- } else {
303
- console.log(chalk.green(' ✓ No unresolved placeholders'));
304
- }
305
-
306
- return result;
307
- }
308
-
309
- /**
310
- * Validate line number references
311
- */
312
- async function validateLineNumbers(claudeDir, projectRoot, threshold) {
313
- const result = {
314
- name: 'Line Number Accuracy',
315
- status: 'PASS',
316
- checked: 0,
317
- valid: 0,
318
- invalid: 0,
319
- accuracy: 0,
320
- issues: [],
321
- };
322
-
323
- const lineRefPattern = /\[Line[s]?\s*(\d+)(?:-(\d+))?\]/gi;
324
- const fileLinePattern = /([^\s:]+):(\d+)/g;
325
-
326
- // Sample workflow files
327
- const workflowDir = path.join(claudeDir, 'context', 'workflows');
328
- if (!fs.existsSync(workflowDir)) {
329
- result.status = 'WARN';
330
- result.issues.push({ message: 'No workflow files found to validate' });
331
- console.log(chalk.yellow(' ⚠️ No workflow files found'));
332
- return result;
333
- }
334
-
335
- const workflowFiles = await glob('*.md', { cwd: workflowDir });
336
-
337
- // Sample up to 5 random references
338
- const samples = [];
339
-
340
- for (const wfFile of workflowFiles.slice(0, 3)) {
341
- const content = fs.readFileSync(path.join(workflowDir, wfFile), 'utf8');
342
- let match;
343
-
344
- while ((match = fileLinePattern.exec(content)) !== null) {
345
- const [, filePath, lineNum] = match;
346
- // Skip if it looks like a URL or example
347
- if (filePath.includes('http') || filePath.includes('example')) continue;
348
-
349
- samples.push({
350
- workflow: wfFile,
351
- file: filePath,
352
- line: parseInt(lineNum),
353
- });
354
- }
355
- }
356
-
357
- // Check samples (max 10)
358
- for (const sample of samples.slice(0, 10)) {
359
- result.checked++;
360
-
361
- const fullPath = path.join(projectRoot, sample.file);
362
- if (!fs.existsSync(fullPath)) {
363
- result.invalid++;
364
- result.issues.push({
365
- workflow: sample.workflow,
366
- file: sample.file,
367
- line: sample.line,
368
- error: 'File not found',
369
- });
370
- continue;
371
- }
372
-
373
- const lines = fs.readFileSync(fullPath, 'utf8').split('\n');
374
- if (sample.line <= lines.length) {
375
- result.valid++;
376
- } else {
377
- result.invalid++;
378
- result.issues.push({
379
- workflow: sample.workflow,
380
- file: sample.file,
381
- line: sample.line,
382
- error: `Line ${sample.line} exceeds file length (${lines.length})`,
383
- });
384
- }
385
- }
386
-
387
- // Calculate accuracy
388
- result.accuracy = result.checked > 0 ? Math.round((result.valid / result.checked) * 100) : 100;
389
-
390
- if (result.accuracy < threshold) {
391
- result.status = 'FAIL';
392
- console.log(chalk.red(` ✗ Accuracy: ${result.accuracy}% (threshold: ${threshold}%)`));
393
- } else {
394
- console.log(chalk.green(` ✓ Accuracy: ${result.accuracy}% (threshold: ${threshold}%)`));
395
- }
396
-
397
- console.log(chalk.gray(` Checked ${result.checked} references`));
398
-
399
- return result;
400
- }
401
-
402
- /**
403
- * Validate directory structure
404
- */
405
- async function validateStructure(claudeDir) {
406
- const result = {
407
- name: 'Structure Validation',
408
- status: 'PASS',
409
- required: 0,
410
- found: 0,
411
- missing: [],
412
- };
413
-
414
- const requiredPaths = [
415
- 'settings.json',
416
- 'README.md',
417
- 'agents',
418
- 'commands',
419
- 'context',
420
- 'indexes',
421
- ];
422
-
423
- const recommendedPaths = [
424
- 'research',
425
- 'plans',
426
- 'schemas',
427
- ];
428
-
429
- for (const reqPath of requiredPaths) {
430
- result.required++;
431
- const fullPath = path.join(claudeDir, reqPath);
432
-
433
- if (fs.existsSync(fullPath)) {
434
- result.found++;
435
- console.log(chalk.green(` ✓ ${reqPath}`));
436
- } else {
437
- result.missing.push(reqPath);
438
- console.log(chalk.red(` ✗ ${reqPath} (required)`));
439
- }
440
- }
441
-
442
- for (const recPath of recommendedPaths) {
443
- const fullPath = path.join(claudeDir, recPath);
444
-
445
- if (fs.existsSync(fullPath)) {
446
- console.log(chalk.green(` ✓ ${recPath}`));
447
- } else {
448
- console.log(chalk.yellow(` ⚠️ ${recPath} (recommended)`));
449
- }
450
- }
451
-
452
- if (result.missing.length > 0) {
453
- result.status = 'FAIL';
454
- }
455
-
456
- return result;
457
- }
458
-
459
- /**
460
- * Print check result
461
- */
462
- function printCheckResult(check) {
463
- const statusIcon = check.status === 'PASS' ? chalk.green('✓') :
464
- check.status === 'WARN' ? chalk.yellow('⚠️') :
465
- chalk.red('✗');
466
- // Status already printed by individual checks
467
- }
468
-
469
- /**
470
- * Print summary
471
- */
472
- function printSummary(summary) {
473
- console.log(chalk.white('\n📊 Validation Summary'));
474
- console.log(chalk.gray('─'.repeat(50)));
475
-
476
- const statusColor = summary.failed > 0 ? chalk.red :
477
- summary.warnings > 0 ? chalk.yellow :
478
- chalk.green;
479
-
480
- console.log(` Total checks: ${summary.total}`);
481
- console.log(chalk.green(` Passed: ${summary.passed}`));
482
- if (summary.warnings > 0) console.log(chalk.yellow(` Warnings: ${summary.warnings}`));
483
- if (summary.failed > 0) console.log(chalk.red(` Failed: ${summary.failed}`));
484
-
485
- const overallStatus = summary.failed > 0 ? 'FAIL' :
486
- summary.warnings > 0 ? 'WARN' : 'PASS';
487
-
488
- console.log(statusColor(`\n Overall: ${overallStatus}`));
489
- }
490
-
491
- /**
492
- * Format results as markdown
493
- */
494
- function formatMarkdown(results) {
495
- let md = `# Validation Report\n\n`;
496
- md += `**Date:** ${results.timestamp}\n\n`;
497
-
498
- for (const [name, check] of Object.entries(results.checks)) {
499
- md += `## ${check.name}\n\n`;
500
- md += `**Status:** ${check.status}\n\n`;
501
-
502
- if (check.issues && check.issues.length > 0) {
503
- md += `### Issues\n\n`;
504
- for (const issue of check.issues) {
505
- md += `- ${JSON.stringify(issue)}\n`;
506
- }
507
- md += '\n';
508
- }
509
- }
510
-
511
- return md;
512
- }
513
-
514
- module.exports = {
515
- validate,
516
- validateSchemas,
517
- validateLinks,
518
- detectPlaceholders,
519
- validateLineNumbers,
520
- validateStructure,
521
- };
1
+ /**
2
+ * Claude Context Engineering - Validation Module
3
+ *
4
+ * Comprehensive validation of the context engineering setup:
5
+ * - Schema validation for JSON files
6
+ * - Markdown link validation
7
+ * - Placeholder detection
8
+ * - Line number accuracy checking
9
+ * - Structure validation
10
+ */
11
+
12
+ const fs = require('fs');
13
+ const path = require('path');
14
+ const chalk = require('chalk');
15
+ const Ajv = require('ajv');
16
+ const addFormats = require('ajv-formats');
17
+ const { glob } = require('glob');
18
+ const { configLoader, findClaudeDir, loadJsonFile } = require('./config-loader');
19
+ const { logger } = require('./logger');
20
+ const { ValidationError } = require('./errors');
21
+
22
+ /**
23
+ * Main validation function
24
+ */
25
+ async function validate(options = {}) {
26
+ const {
27
+ all = false,
28
+ links = false,
29
+ lines = false,
30
+ placeholders = false,
31
+ schema = false,
32
+ structure = false,
33
+ threshold = 60,
34
+ output = 'console',
35
+ file = null,
36
+ } = options;
37
+
38
+ const op = logger.startOperation('validate');
39
+ const claudeDir = options.claudeDir || findClaudeDir();
40
+ const projectRoot = path.dirname(claudeDir);
41
+
42
+ const results = {
43
+ timestamp: new Date().toISOString(),
44
+ claudeDir,
45
+ checks: {},
46
+ summary: {
47
+ total: 0,
48
+ passed: 0,
49
+ failed: 0,
50
+ warnings: 0,
51
+ },
52
+ };
53
+
54
+ try {
55
+ console.log(chalk.cyan('\n🔍 Running Validation Suite...\n'));
56
+
57
+ // Schema validation
58
+ if (all || schema) {
59
+ console.log(chalk.white('Schema Validation'));
60
+ console.log(chalk.gray('─'.repeat(50)));
61
+ results.checks.schema = await validateSchemas(claudeDir);
62
+ printCheckResult(results.checks.schema);
63
+ }
64
+
65
+ // Link validation
66
+ if (all || links) {
67
+ console.log(chalk.white('\nLink Validation'));
68
+ console.log(chalk.gray('─'.repeat(50)));
69
+ results.checks.links = await validateLinks(claudeDir, projectRoot);
70
+ printCheckResult(results.checks.links);
71
+ }
72
+
73
+ // Placeholder detection
74
+ if (all || placeholders) {
75
+ console.log(chalk.white('\nPlaceholder Detection'));
76
+ console.log(chalk.gray('─'.repeat(50)));
77
+ results.checks.placeholders = await detectPlaceholders(claudeDir, projectRoot);
78
+ printCheckResult(results.checks.placeholders);
79
+ }
80
+
81
+ // Line number accuracy
82
+ if (all || lines) {
83
+ console.log(chalk.white('\nLine Number Accuracy'));
84
+ console.log(chalk.gray('─'.repeat(50)));
85
+ results.checks.lineNumbers = await validateLineNumbers(claudeDir, projectRoot, parseInt(threshold));
86
+ printCheckResult(results.checks.lineNumbers);
87
+ }
88
+
89
+ // Structure validation
90
+ if (all || structure) {
91
+ console.log(chalk.white('\nStructure Validation'));
92
+ console.log(chalk.gray('─'.repeat(50)));
93
+ results.checks.structure = await validateStructure(claudeDir);
94
+ printCheckResult(results.checks.structure);
95
+ }
96
+
97
+ // Calculate summary
98
+ for (const check of Object.values(results.checks)) {
99
+ results.summary.total++;
100
+ if (check.status === 'PASS') results.summary.passed++;
101
+ else if (check.status === 'FAIL') results.summary.failed++;
102
+ else if (check.status === 'WARN') results.summary.warnings++;
103
+ }
104
+
105
+ // Print summary
106
+ printSummary(results.summary);
107
+
108
+ // Output results
109
+ if (output === 'json') {
110
+ console.log(JSON.stringify(results, null, 2));
111
+ } else if (output === 'markdown') {
112
+ console.log(formatMarkdown(results));
113
+ }
114
+
115
+ op.success();
116
+ return results;
117
+
118
+ } catch (error) {
119
+ op.fail(error);
120
+ throw error;
121
+ }
122
+ }
123
+
124
+ /**
125
+ * Validate JSON files against their schemas
126
+ */
127
+ async function validateSchemas(claudeDir) {
128
+ const result = {
129
+ name: 'Schema Validation',
130
+ status: 'PASS',
131
+ checked: 0,
132
+ passed: 0,
133
+ failed: 0,
134
+ issues: [],
135
+ };
136
+
137
+ const ajv = new Ajv({ allErrors: true, strict: false });
138
+ addFormats(ajv);
139
+
140
+ // Load all schemas
141
+ const schemaDir = path.join(claudeDir, 'schemas');
142
+ if (!fs.existsSync(schemaDir)) {
143
+ result.status = 'WARN';
144
+ result.issues.push({ file: schemaDir, message: 'Schemas directory not found' });
145
+ return result;
146
+ }
147
+
148
+ // Validate settings.json
149
+ const settingsPath = path.join(claudeDir, 'settings.json');
150
+ const settingsSchemaPath = path.join(schemaDir, 'settings.schema.json');
151
+
152
+ if (fs.existsSync(settingsPath) && fs.existsSync(settingsSchemaPath)) {
153
+ result.checked++;
154
+ try {
155
+ const settings = loadJsonFile(settingsPath);
156
+ const schema = loadJsonFile(settingsSchemaPath);
157
+ const validate = ajv.compile(schema);
158
+
159
+ if (validate(settings)) {
160
+ result.passed++;
161
+ console.log(chalk.green(' ✓ settings.json'));
162
+ } else {
163
+ result.failed++;
164
+ result.status = 'FAIL';
165
+ const errors = validate.errors.map(e => `${e.instancePath} ${e.message}`);
166
+ result.issues.push({ file: 'settings.json', errors });
167
+ console.log(chalk.red(' ✗ settings.json'));
168
+ errors.forEach(e => console.log(chalk.gray(` - ${e}`)));
169
+ }
170
+ } catch (error) {
171
+ result.failed++;
172
+ result.status = 'FAIL';
173
+ result.issues.push({ file: 'settings.json', message: error.message });
174
+ console.log(chalk.red(` ✗ settings.json: ${error.message}`));
175
+ }
176
+ }
177
+
178
+ return result;
179
+ }
180
+
181
+ /**
182
+ * Validate markdown links
183
+ */
184
+ async function validateLinks(claudeDir, projectRoot) {
185
+ const result = {
186
+ name: 'Link Validation',
187
+ status: 'PASS',
188
+ checked: 0,
189
+ valid: 0,
190
+ broken: 0,
191
+ issues: [],
192
+ };
193
+
194
+ // Find all markdown files
195
+ const mdFiles = await glob('**/*.md', {
196
+ cwd: claudeDir,
197
+ ignore: ['node_modules/**'],
198
+ });
199
+
200
+ const linkPattern = /\[([^\]]+)\]\(([^)]+)\)/g;
201
+
202
+ for (const mdFile of mdFiles) {
203
+ const filePath = path.join(claudeDir, mdFile);
204
+ const content = fs.readFileSync(filePath, 'utf8');
205
+ let match;
206
+
207
+ while ((match = linkPattern.exec(content)) !== null) {
208
+ const [, text, link] = match;
209
+
210
+ // Skip external links and anchors
211
+ if (link.startsWith('http') || link.startsWith('#') || link.startsWith('mailto:')) {
212
+ continue;
213
+ }
214
+
215
+ result.checked++;
216
+
217
+ // Resolve the link path
218
+ const linkPath = path.resolve(path.dirname(filePath), link.split('#')[0]);
219
+
220
+ if (fs.existsSync(linkPath)) {
221
+ result.valid++;
222
+ } else {
223
+ result.broken++;
224
+ result.issues.push({
225
+ file: mdFile,
226
+ link,
227
+ text,
228
+ });
229
+ console.log(chalk.red(` ✗ ${mdFile}: broken link "${link}"`));
230
+ }
231
+ }
232
+ }
233
+
234
+ if (result.broken > 0) {
235
+ result.status = 'FAIL';
236
+ }
237
+
238
+ console.log(chalk.gray(` Checked ${result.checked} links, ${result.valid} valid, ${result.broken} broken`));
239
+
240
+ return result;
241
+ }
242
+
243
+ /**
244
+ * Detect remaining placeholders
245
+ */
246
+ async function detectPlaceholders(claudeDir, projectRoot) {
247
+ const result = {
248
+ name: 'Placeholder Detection',
249
+ status: 'PASS',
250
+ checked: 0,
251
+ found: 0,
252
+ issues: [],
253
+ };
254
+
255
+ const placeholderPattern = /\{\{([A-Z_]+)\}\}/g;
256
+
257
+ // Check CLAUDE.md in project root
258
+ const claudeMdPath = path.join(projectRoot, 'CLAUDE.md');
259
+ if (fs.existsSync(claudeMdPath)) {
260
+ const content = fs.readFileSync(claudeMdPath, 'utf8');
261
+ let match;
262
+
263
+ while ((match = placeholderPattern.exec(content)) !== null) {
264
+ result.found++;
265
+ result.issues.push({
266
+ file: 'CLAUDE.md',
267
+ placeholder: match[0],
268
+ name: match[1],
269
+ });
270
+ }
271
+ result.checked++;
272
+ }
273
+
274
+ // Check files in .claude directory
275
+ const mdFiles = await glob('**/*.md', {
276
+ cwd: claudeDir,
277
+ ignore: ['node_modules/**'],
278
+ });
279
+
280
+ for (const mdFile of mdFiles) {
281
+ const filePath = path.join(claudeDir, mdFile);
282
+ const content = fs.readFileSync(filePath, 'utf8');
283
+ let match;
284
+
285
+ while ((match = placeholderPattern.exec(content)) !== null) {
286
+ result.found++;
287
+ result.issues.push({
288
+ file: `.claude/${mdFile}`,
289
+ placeholder: match[0],
290
+ name: match[1],
291
+ });
292
+ }
293
+ result.checked++;
294
+ }
295
+
296
+ if (result.found > 0) {
297
+ result.status = 'WARN';
298
+ console.log(chalk.yellow(` ⚠️ Found ${result.found} unresolved placeholders:`));
299
+ result.issues.forEach(issue => {
300
+ console.log(chalk.gray(` - ${issue.file}: ${issue.placeholder}`));
301
+ });
302
+ } else {
303
+ console.log(chalk.green(' ✓ No unresolved placeholders'));
304
+ }
305
+
306
+ return result;
307
+ }
308
+
309
+ /**
310
+ * Validate line number references
311
+ */
312
+ async function validateLineNumbers(claudeDir, projectRoot, threshold) {
313
+ const result = {
314
+ name: 'Line Number Accuracy',
315
+ status: 'PASS',
316
+ checked: 0,
317
+ valid: 0,
318
+ invalid: 0,
319
+ accuracy: 0,
320
+ issues: [],
321
+ };
322
+
323
+ const lineRefPattern = /\[Line[s]?\s*(\d+)(?:-(\d+))?\]/gi;
324
+ const fileLinePattern = /([^\s:]+):(\d+)/g;
325
+
326
+ // Sample workflow files
327
+ const workflowDir = path.join(claudeDir, 'context', 'workflows');
328
+ if (!fs.existsSync(workflowDir)) {
329
+ result.status = 'WARN';
330
+ result.issues.push({ message: 'No workflow files found to validate' });
331
+ console.log(chalk.yellow(' ⚠️ No workflow files found'));
332
+ return result;
333
+ }
334
+
335
+ const workflowFiles = await glob('*.md', { cwd: workflowDir });
336
+
337
+ // Sample up to 5 random references
338
+ const samples = [];
339
+
340
+ for (const wfFile of workflowFiles.slice(0, 3)) {
341
+ const content = fs.readFileSync(path.join(workflowDir, wfFile), 'utf8');
342
+ let match;
343
+
344
+ while ((match = fileLinePattern.exec(content)) !== null) {
345
+ const [, filePath, lineNum] = match;
346
+ // Skip if it looks like a URL or example
347
+ if (filePath.includes('http') || filePath.includes('example')) continue;
348
+
349
+ samples.push({
350
+ workflow: wfFile,
351
+ file: filePath,
352
+ line: parseInt(lineNum),
353
+ });
354
+ }
355
+ }
356
+
357
+ // Check samples (max 10)
358
+ for (const sample of samples.slice(0, 10)) {
359
+ result.checked++;
360
+
361
+ const fullPath = path.join(projectRoot, sample.file);
362
+ if (!fs.existsSync(fullPath)) {
363
+ result.invalid++;
364
+ result.issues.push({
365
+ workflow: sample.workflow,
366
+ file: sample.file,
367
+ line: sample.line,
368
+ error: 'File not found',
369
+ });
370
+ continue;
371
+ }
372
+
373
+ const lines = fs.readFileSync(fullPath, 'utf8').split('\n');
374
+ if (sample.line <= lines.length) {
375
+ result.valid++;
376
+ } else {
377
+ result.invalid++;
378
+ result.issues.push({
379
+ workflow: sample.workflow,
380
+ file: sample.file,
381
+ line: sample.line,
382
+ error: `Line ${sample.line} exceeds file length (${lines.length})`,
383
+ });
384
+ }
385
+ }
386
+
387
+ // Calculate accuracy
388
+ result.accuracy = result.checked > 0 ? Math.round((result.valid / result.checked) * 100) : 100;
389
+
390
+ if (result.accuracy < threshold) {
391
+ result.status = 'FAIL';
392
+ console.log(chalk.red(` ✗ Accuracy: ${result.accuracy}% (threshold: ${threshold}%)`));
393
+ } else {
394
+ console.log(chalk.green(` ✓ Accuracy: ${result.accuracy}% (threshold: ${threshold}%)`));
395
+ }
396
+
397
+ console.log(chalk.gray(` Checked ${result.checked} references`));
398
+
399
+ return result;
400
+ }
401
+
402
+ /**
403
+ * Validate directory structure
404
+ */
405
+ async function validateStructure(claudeDir) {
406
+ const result = {
407
+ name: 'Structure Validation',
408
+ status: 'PASS',
409
+ required: 0,
410
+ found: 0,
411
+ missing: [],
412
+ };
413
+
414
+ const requiredPaths = [
415
+ 'settings.json',
416
+ 'README.md',
417
+ 'agents',
418
+ 'commands',
419
+ 'context',
420
+ 'indexes',
421
+ ];
422
+
423
+ const recommendedPaths = [
424
+ 'research',
425
+ 'plans',
426
+ 'schemas',
427
+ ];
428
+
429
+ for (const reqPath of requiredPaths) {
430
+ result.required++;
431
+ const fullPath = path.join(claudeDir, reqPath);
432
+
433
+ if (fs.existsSync(fullPath)) {
434
+ result.found++;
435
+ console.log(chalk.green(` ✓ ${reqPath}`));
436
+ } else {
437
+ result.missing.push(reqPath);
438
+ console.log(chalk.red(` ✗ ${reqPath} (required)`));
439
+ }
440
+ }
441
+
442
+ for (const recPath of recommendedPaths) {
443
+ const fullPath = path.join(claudeDir, recPath);
444
+
445
+ if (fs.existsSync(fullPath)) {
446
+ console.log(chalk.green(` ✓ ${recPath}`));
447
+ } else {
448
+ console.log(chalk.yellow(` ⚠️ ${recPath} (recommended)`));
449
+ }
450
+ }
451
+
452
+ if (result.missing.length > 0) {
453
+ result.status = 'FAIL';
454
+ }
455
+
456
+ return result;
457
+ }
458
+
459
+ /**
460
+ * Print check result
461
+ */
462
+ function printCheckResult(check) {
463
+ const statusIcon = check.status === 'PASS' ? chalk.green('✓') :
464
+ check.status === 'WARN' ? chalk.yellow('⚠️') :
465
+ chalk.red('✗');
466
+ // Status already printed by individual checks
467
+ }
468
+
469
+ /**
470
+ * Print summary
471
+ */
472
+ function printSummary(summary) {
473
+ console.log(chalk.white('\n📊 Validation Summary'));
474
+ console.log(chalk.gray('─'.repeat(50)));
475
+
476
+ const statusColor = summary.failed > 0 ? chalk.red :
477
+ summary.warnings > 0 ? chalk.yellow :
478
+ chalk.green;
479
+
480
+ console.log(` Total checks: ${summary.total}`);
481
+ console.log(chalk.green(` Passed: ${summary.passed}`));
482
+ if (summary.warnings > 0) console.log(chalk.yellow(` Warnings: ${summary.warnings}`));
483
+ if (summary.failed > 0) console.log(chalk.red(` Failed: ${summary.failed}`));
484
+
485
+ const overallStatus = summary.failed > 0 ? 'FAIL' :
486
+ summary.warnings > 0 ? 'WARN' : 'PASS';
487
+
488
+ console.log(statusColor(`\n Overall: ${overallStatus}`));
489
+ }
490
+
491
+ /**
492
+ * Format results as markdown
493
+ */
494
+ function formatMarkdown(results) {
495
+ let md = `# Validation Report\n\n`;
496
+ md += `**Date:** ${results.timestamp}\n\n`;
497
+
498
+ for (const [name, check] of Object.entries(results.checks)) {
499
+ md += `## ${check.name}\n\n`;
500
+ md += `**Status:** ${check.status}\n\n`;
501
+
502
+ if (check.issues && check.issues.length > 0) {
503
+ md += `### Issues\n\n`;
504
+ for (const issue of check.issues) {
505
+ md += `- ${JSON.stringify(issue)}\n`;
506
+ }
507
+ md += '\n';
508
+ }
509
+ }
510
+
511
+ return md;
512
+ }
513
+
514
+ module.exports = {
515
+ validate,
516
+ validateSchemas,
517
+ validateLinks,
518
+ detectPlaceholders,
519
+ validateLineNumbers,
520
+ validateStructure,
521
+ };