memorix 1.2.2 → 1.2.3

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 (139) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/TEAM.md +86 -86
  3. package/dist/cli/index.js +34 -18
  4. package/dist/cli/index.js.map +1 -1
  5. package/dist/index.js +17 -8
  6. package/dist/index.js.map +1 -1
  7. package/dist/maintenance-runner.js.map +1 -1
  8. package/dist/memcode-runtime/CHANGELOG.md +7 -0
  9. package/dist/sdk.js +17 -8
  10. package/dist/sdk.js.map +1 -1
  11. package/docs/DESIGN_DECISIONS.md +357 -357
  12. package/docs/dev-log/progress.txt +18 -8
  13. package/package.json +1 -1
  14. package/plugins/codex/memorix/.codex-plugin/plugin.json +1 -1
  15. package/src/audit/index.ts +156 -156
  16. package/src/cli/commands/audit-list.ts +89 -89
  17. package/src/cli/commands/background.ts +659 -659
  18. package/src/cli/commands/formation.ts +48 -48
  19. package/src/cli/commands/git-hook-install.ts +111 -111
  20. package/src/cli/commands/handoff.ts +54 -54
  21. package/src/cli/commands/hooks-status.ts +63 -63
  22. package/src/cli/commands/ingest-commit.ts +153 -153
  23. package/src/cli/commands/ingest-image.ts +66 -66
  24. package/src/cli/commands/ingest-log.ts +180 -180
  25. package/src/cli/commands/ingest.ts +44 -44
  26. package/src/cli/commands/integrate-shared.ts +15 -15
  27. package/src/cli/commands/lock.ts +82 -82
  28. package/src/cli/commands/message.ts +104 -104
  29. package/src/cli/commands/poll.ts +58 -58
  30. package/src/cli/commands/purge-all-memory.ts +85 -85
  31. package/src/cli/commands/purge-project-memory.ts +83 -83
  32. package/src/cli/commands/reasoning.ts +118 -118
  33. package/src/cli/commands/serve-shared.ts +118 -118
  34. package/src/cli/commands/session.ts +15 -7
  35. package/src/cli/commands/skills.ts +114 -114
  36. package/src/cli/commands/task.ts +167 -167
  37. package/src/cli/commands/transfer.ts +47 -47
  38. package/src/cli/commands/uninstall-project-artifacts.ts +85 -85
  39. package/src/cli/tui/ChatView.tsx +234 -234
  40. package/src/cli/tui/CommandBar.tsx +312 -312
  41. package/src/cli/tui/ContextRail.tsx +118 -118
  42. package/src/cli/tui/HeaderBar.tsx +72 -72
  43. package/src/cli/tui/LogoBanner.tsx +51 -51
  44. package/src/cli/tui/Sidebar.tsx +179 -179
  45. package/src/cli/tui/index.ts +41 -41
  46. package/src/cli/tui/markdown-render.tsx +371 -371
  47. package/src/cli/tui/session-service.ts +3 -2
  48. package/src/cli/tui/use-mouse.ts +157 -157
  49. package/src/cli/tui/useNavigation.ts +56 -56
  50. package/src/cli/update-checker.ts +211 -211
  51. package/src/cli/version.ts +7 -7
  52. package/src/cli/workbench.ts +1 -1
  53. package/src/compact/token-budget.ts +74 -74
  54. package/src/dashboard/project-classification.ts +64 -64
  55. package/src/embedding/fastembed-provider.ts +142 -142
  56. package/src/embedding/transformers-provider.ts +111 -111
  57. package/src/git/extractor.ts +209 -209
  58. package/src/git/hooks-path.ts +85 -85
  59. package/src/hooks/pattern-detector.ts +173 -173
  60. package/src/hooks/significance-filter.ts +250 -250
  61. package/src/llm/memory-manager.ts +328 -328
  62. package/src/llm/provider.ts +885 -885
  63. package/src/llm/quality.ts +248 -248
  64. package/src/memory/attribution-guard.ts +249 -249
  65. package/src/memory/disclosure-policy.ts +135 -135
  66. package/src/memory/entity-extractor.ts +197 -197
  67. package/src/memory/formation/evaluate.ts +217 -217
  68. package/src/memory/formation/extract.ts +361 -361
  69. package/src/memory/formation/index.ts +417 -417
  70. package/src/memory/formation/resolve.ts +344 -344
  71. package/src/memory/formation/types.ts +315 -315
  72. package/src/memory/freshness.ts +122 -122
  73. package/src/memory/graph.ts +197 -197
  74. package/src/memory/refs.ts +94 -94
  75. package/src/memory/secret-filter.ts +79 -79
  76. package/src/memory/session.ts +24 -9
  77. package/src/multimodal/image-loader.ts +143 -143
  78. package/src/orchestrate/adapters/claude-stream.ts +192 -192
  79. package/src/orchestrate/adapters/claude.ts +111 -111
  80. package/src/orchestrate/adapters/codex-stream.ts +134 -134
  81. package/src/orchestrate/adapters/codex.ts +41 -41
  82. package/src/orchestrate/adapters/gemini-stream.ts +166 -166
  83. package/src/orchestrate/adapters/gemini.ts +42 -42
  84. package/src/orchestrate/adapters/index.ts +73 -73
  85. package/src/orchestrate/adapters/opencode-stream.ts +143 -143
  86. package/src/orchestrate/adapters/opencode.ts +47 -47
  87. package/src/orchestrate/adapters/spawn-helper.ts +286 -286
  88. package/src/orchestrate/adapters/types.ts +77 -77
  89. package/src/orchestrate/capability-router.ts +284 -284
  90. package/src/orchestrate/context-compact.ts +188 -188
  91. package/src/orchestrate/cost-tracker.ts +219 -219
  92. package/src/orchestrate/error-recovery.ts +191 -191
  93. package/src/orchestrate/evidence.ts +140 -140
  94. package/src/orchestrate/ledger.ts +110 -110
  95. package/src/orchestrate/memorix-bridge.ts +343 -343
  96. package/src/orchestrate/output-budget.ts +80 -80
  97. package/src/orchestrate/permission.ts +152 -152
  98. package/src/orchestrate/pipeline-trace.ts +131 -131
  99. package/src/orchestrate/prompt-builder.ts +155 -155
  100. package/src/orchestrate/ring-buffer.ts +37 -37
  101. package/src/orchestrate/task-graph.ts +389 -389
  102. package/src/orchestrate/worktree.ts +232 -232
  103. package/src/project/aliases.ts +374 -374
  104. package/src/project/detector.ts +268 -268
  105. package/src/rules/adapters/claude-code.ts +99 -99
  106. package/src/rules/adapters/codex.ts +97 -97
  107. package/src/rules/adapters/copilot.ts +124 -124
  108. package/src/rules/adapters/cursor.ts +114 -114
  109. package/src/rules/adapters/kiro.ts +126 -126
  110. package/src/rules/adapters/trae.ts +56 -56
  111. package/src/rules/adapters/windsurf.ts +83 -83
  112. package/src/rules/syncer.ts +235 -235
  113. package/src/sdk.ts +299 -299
  114. package/src/search/intent-detector.ts +289 -289
  115. package/src/search/query-expansion.ts +52 -52
  116. package/src/server/formation-timeout.ts +27 -27
  117. package/src/server.ts +7 -2
  118. package/src/skills/mini-skills.ts +386 -386
  119. package/src/store/chat-store.ts +119 -119
  120. package/src/store/graph-store.ts +249 -249
  121. package/src/store/mini-skill-store.ts +349 -349
  122. package/src/store/persistence-json.ts +212 -212
  123. package/src/store/persistence.ts +291 -291
  124. package/src/store/project-affinity.ts +195 -195
  125. package/src/team/event-bus.ts +76 -76
  126. package/src/team/file-locks.ts +173 -173
  127. package/src/team/handoff.ts +161 -161
  128. package/src/team/messages.ts +203 -203
  129. package/src/team/poll.ts +132 -132
  130. package/src/team/tasks.ts +211 -211
  131. package/src/workspace/mcp-adapters/codex.ts +191 -191
  132. package/src/workspace/mcp-adapters/copilot.ts +105 -105
  133. package/src/workspace/mcp-adapters/cursor.ts +53 -53
  134. package/src/workspace/mcp-adapters/kiro.ts +64 -64
  135. package/src/workspace/mcp-adapters/opencode.ts +123 -123
  136. package/src/workspace/mcp-adapters/trae.ts +134 -134
  137. package/src/workspace/mcp-adapters/windsurf.ts +91 -91
  138. package/src/workspace/sanitizer.ts +60 -60
  139. package/src/workspace/workflow-sync.ts +131 -131
@@ -1,99 +1,99 @@
1
- /**
2
- * Claude Code Rule Format Adapter
3
- *
4
- * Parses and generates rules in Claude Code's formats:
5
- * - CLAUDE.md / .claude/CLAUDE.md (project-level Markdown)
6
- * - .claude/rules/*.md (Markdown with optional `paths` frontmatter)
7
- *
8
- * Source: Claude Code official documentation.
9
- */
10
-
11
- import matter from 'gray-matter';
12
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
- import { hashContent, generateRuleId } from '../utils.js';
14
-
15
- export class ClaudeCodeAdapter implements RuleFormatAdapter {
16
- readonly source: RuleSource = 'claude-code';
17
-
18
- readonly filePatterns = [
19
- 'CLAUDE.md',
20
- '.claude/CLAUDE.md',
21
- '.claude/rules/*.md',
22
- ];
23
-
24
- parse(filePath: string, content: string): UnifiedRule[] {
25
- // .claude/rules/*.md may have `paths` frontmatter
26
- if (filePath.includes('.claude/rules/')) {
27
- return this.parseModularRule(filePath, content);
28
- }
29
- // CLAUDE.md — project-level
30
- return this.parseClaudeMd(filePath, content);
31
- }
32
-
33
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
34
- const projectRules = rules.filter(r => r.scope !== 'path-specific');
35
- const pathRules = rules.filter(r => r.scope === 'path-specific');
36
-
37
- const files: { filePath: string; content: string }[] = [];
38
-
39
- if (projectRules.length > 0) {
40
- files.push({
41
- filePath: 'CLAUDE.md',
42
- content: projectRules.map(r => r.content).join('\n\n'),
43
- });
44
- }
45
-
46
- for (const rule of pathRules) {
47
- const fm: Record<string, unknown> = {};
48
- if (rule.paths && rule.paths.length > 0) fm.paths = rule.paths;
49
-
50
- const fileName = rule.id
51
- .replace(/^claude-code:/, '')
52
- .replace(/[^a-zA-Z0-9-_]/g, '-')
53
- || 'rule';
54
-
55
- files.push({
56
- filePath: `.claude/rules/${fileName}.md`,
57
- content: Object.keys(fm).length > 0
58
- ? matter.stringify(rule.content, fm)
59
- : rule.content,
60
- });
61
- }
62
-
63
- return files;
64
- }
65
-
66
- private parseClaudeMd(filePath: string, content: string): UnifiedRule[] {
67
- const trimmed = content.trim();
68
- if (!trimmed) return [];
69
-
70
- return [{
71
- id: generateRuleId('claude-code', filePath),
72
- content: trimmed,
73
- source: 'claude-code',
74
- scope: 'project',
75
- priority: 5,
76
- hash: hashContent(trimmed),
77
- }];
78
- }
79
-
80
- private parseModularRule(filePath: string, content: string): UnifiedRule[] {
81
- const { data, content: body } = matter(content);
82
- const trimmed = body.trim();
83
- if (!trimmed) return [];
84
-
85
- const paths = data.paths as string[] | undefined;
86
- const hasPaths = Array.isArray(paths) && paths.length > 0;
87
-
88
- return [{
89
- id: generateRuleId('claude-code', filePath),
90
- content: trimmed,
91
- description: data.description as string | undefined,
92
- source: 'claude-code',
93
- scope: hasPaths ? 'path-specific' : 'project',
94
- paths: hasPaths ? paths : undefined,
95
- priority: 5,
96
- hash: hashContent(trimmed),
97
- }];
98
- }
99
- }
1
+ /**
2
+ * Claude Code Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Claude Code's formats:
5
+ * - CLAUDE.md / .claude/CLAUDE.md (project-level Markdown)
6
+ * - .claude/rules/*.md (Markdown with optional `paths` frontmatter)
7
+ *
8
+ * Source: Claude Code official documentation.
9
+ */
10
+
11
+ import matter from 'gray-matter';
12
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
+ import { hashContent, generateRuleId } from '../utils.js';
14
+
15
+ export class ClaudeCodeAdapter implements RuleFormatAdapter {
16
+ readonly source: RuleSource = 'claude-code';
17
+
18
+ readonly filePatterns = [
19
+ 'CLAUDE.md',
20
+ '.claude/CLAUDE.md',
21
+ '.claude/rules/*.md',
22
+ ];
23
+
24
+ parse(filePath: string, content: string): UnifiedRule[] {
25
+ // .claude/rules/*.md may have `paths` frontmatter
26
+ if (filePath.includes('.claude/rules/')) {
27
+ return this.parseModularRule(filePath, content);
28
+ }
29
+ // CLAUDE.md — project-level
30
+ return this.parseClaudeMd(filePath, content);
31
+ }
32
+
33
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
34
+ const projectRules = rules.filter(r => r.scope !== 'path-specific');
35
+ const pathRules = rules.filter(r => r.scope === 'path-specific');
36
+
37
+ const files: { filePath: string; content: string }[] = [];
38
+
39
+ if (projectRules.length > 0) {
40
+ files.push({
41
+ filePath: 'CLAUDE.md',
42
+ content: projectRules.map(r => r.content).join('\n\n'),
43
+ });
44
+ }
45
+
46
+ for (const rule of pathRules) {
47
+ const fm: Record<string, unknown> = {};
48
+ if (rule.paths && rule.paths.length > 0) fm.paths = rule.paths;
49
+
50
+ const fileName = rule.id
51
+ .replace(/^claude-code:/, '')
52
+ .replace(/[^a-zA-Z0-9-_]/g, '-')
53
+ || 'rule';
54
+
55
+ files.push({
56
+ filePath: `.claude/rules/${fileName}.md`,
57
+ content: Object.keys(fm).length > 0
58
+ ? matter.stringify(rule.content, fm)
59
+ : rule.content,
60
+ });
61
+ }
62
+
63
+ return files;
64
+ }
65
+
66
+ private parseClaudeMd(filePath: string, content: string): UnifiedRule[] {
67
+ const trimmed = content.trim();
68
+ if (!trimmed) return [];
69
+
70
+ return [{
71
+ id: generateRuleId('claude-code', filePath),
72
+ content: trimmed,
73
+ source: 'claude-code',
74
+ scope: 'project',
75
+ priority: 5,
76
+ hash: hashContent(trimmed),
77
+ }];
78
+ }
79
+
80
+ private parseModularRule(filePath: string, content: string): UnifiedRule[] {
81
+ const { data, content: body } = matter(content);
82
+ const trimmed = body.trim();
83
+ if (!trimmed) return [];
84
+
85
+ const paths = data.paths as string[] | undefined;
86
+ const hasPaths = Array.isArray(paths) && paths.length > 0;
87
+
88
+ return [{
89
+ id: generateRuleId('claude-code', filePath),
90
+ content: trimmed,
91
+ description: data.description as string | undefined,
92
+ source: 'claude-code',
93
+ scope: hasPaths ? 'path-specific' : 'project',
94
+ paths: hasPaths ? paths : undefined,
95
+ priority: 5,
96
+ hash: hashContent(trimmed),
97
+ }];
98
+ }
99
+ }
@@ -1,97 +1,97 @@
1
- /**
2
- * OpenAI Codex Rule Format Adapter
3
- *
4
- * Parses and generates rules in Codex's formats:
5
- * - .agents/skills/[name]/SKILL.md (Markdown + frontmatter with name, description)
6
- * - AGENTS.md (pure Markdown)
7
- *
8
- * Source: OpenAI Codex Skills documentation.
9
- */
10
-
11
- import matter from 'gray-matter';
12
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
- import { hashContent, generateRuleId } from '../utils.js';
14
-
15
- export class CodexAdapter implements RuleFormatAdapter {
16
- readonly source: RuleSource = 'codex';
17
-
18
- readonly filePatterns = [
19
- '.agents/skills/*/SKILL.md',
20
- 'AGENTS.md',
21
- ];
22
-
23
- parse(filePath: string, content: string): UnifiedRule[] {
24
- if (filePath.includes('SKILL.md')) {
25
- return this.parseSkillMd(filePath, content);
26
- }
27
- if (filePath.endsWith('AGENTS.md')) {
28
- return this.parseAgentsMd(filePath, content);
29
- }
30
- return [];
31
- }
32
-
33
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
34
- return rules.map((rule, i) => {
35
- const skillName = rule.id
36
- .replace(/^codex:/, '')
37
- .replace(/[^a-zA-Z0-9-_]/g, '-')
38
- || `skill-${i}`;
39
-
40
- const fm: Record<string, unknown> = {
41
- name: skillName,
42
- };
43
-
44
- // Codex needs description to know WHEN to trigger the skill.
45
- // If no description exists, auto-generate from content (first 120 chars).
46
- if (rule.description) {
47
- fm.description = rule.description;
48
- } else {
49
- fm.description = this.autoDescription(rule.content);
50
- }
51
-
52
- return {
53
- filePath: `.agents/skills/${skillName}/SKILL.md`,
54
- content: matter.stringify(rule.content, fm),
55
- };
56
- });
57
- }
58
-
59
- /** Extract a short description from rule content for Codex skill triggering */
60
- private autoDescription(content: string): string {
61
- // Take first meaningful line, strip markdown formatting
62
- const lines = content.split('\n').map(l => l.trim()).filter(Boolean);
63
- const first = lines[0]?.replace(/^#+\s*/, '').replace(/^[-*]\s*/, '') || 'Project rules';
64
- if (first.length <= 120) return first;
65
- return first.substring(0, 117) + '...';
66
- }
67
-
68
- private parseSkillMd(filePath: string, content: string): UnifiedRule[] {
69
- const { data, content: body } = matter(content);
70
- const trimmed = body.trim();
71
- if (!trimmed) return [];
72
-
73
- return [{
74
- id: generateRuleId('codex', filePath),
75
- content: trimmed,
76
- description: (data.description as string) || undefined,
77
- source: 'codex',
78
- scope: 'project',
79
- priority: 5,
80
- hash: hashContent(trimmed),
81
- }];
82
- }
83
-
84
- private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
85
- const trimmed = content.trim();
86
- if (!trimmed) return [];
87
-
88
- return [{
89
- id: generateRuleId('codex', filePath),
90
- content: trimmed,
91
- source: 'codex',
92
- scope: 'project',
93
- priority: 5,
94
- hash: hashContent(trimmed),
95
- }];
96
- }
97
- }
1
+ /**
2
+ * OpenAI Codex Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Codex's formats:
5
+ * - .agents/skills/[name]/SKILL.md (Markdown + frontmatter with name, description)
6
+ * - AGENTS.md (pure Markdown)
7
+ *
8
+ * Source: OpenAI Codex Skills documentation.
9
+ */
10
+
11
+ import matter from 'gray-matter';
12
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
+ import { hashContent, generateRuleId } from '../utils.js';
14
+
15
+ export class CodexAdapter implements RuleFormatAdapter {
16
+ readonly source: RuleSource = 'codex';
17
+
18
+ readonly filePatterns = [
19
+ '.agents/skills/*/SKILL.md',
20
+ 'AGENTS.md',
21
+ ];
22
+
23
+ parse(filePath: string, content: string): UnifiedRule[] {
24
+ if (filePath.includes('SKILL.md')) {
25
+ return this.parseSkillMd(filePath, content);
26
+ }
27
+ if (filePath.endsWith('AGENTS.md')) {
28
+ return this.parseAgentsMd(filePath, content);
29
+ }
30
+ return [];
31
+ }
32
+
33
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
34
+ return rules.map((rule, i) => {
35
+ const skillName = rule.id
36
+ .replace(/^codex:/, '')
37
+ .replace(/[^a-zA-Z0-9-_]/g, '-')
38
+ || `skill-${i}`;
39
+
40
+ const fm: Record<string, unknown> = {
41
+ name: skillName,
42
+ };
43
+
44
+ // Codex needs description to know WHEN to trigger the skill.
45
+ // If no description exists, auto-generate from content (first 120 chars).
46
+ if (rule.description) {
47
+ fm.description = rule.description;
48
+ } else {
49
+ fm.description = this.autoDescription(rule.content);
50
+ }
51
+
52
+ return {
53
+ filePath: `.agents/skills/${skillName}/SKILL.md`,
54
+ content: matter.stringify(rule.content, fm),
55
+ };
56
+ });
57
+ }
58
+
59
+ /** Extract a short description from rule content for Codex skill triggering */
60
+ private autoDescription(content: string): string {
61
+ // Take first meaningful line, strip markdown formatting
62
+ const lines = content.split('\n').map(l => l.trim()).filter(Boolean);
63
+ const first = lines[0]?.replace(/^#+\s*/, '').replace(/^[-*]\s*/, '') || 'Project rules';
64
+ if (first.length <= 120) return first;
65
+ return first.substring(0, 117) + '...';
66
+ }
67
+
68
+ private parseSkillMd(filePath: string, content: string): UnifiedRule[] {
69
+ const { data, content: body } = matter(content);
70
+ const trimmed = body.trim();
71
+ if (!trimmed) return [];
72
+
73
+ return [{
74
+ id: generateRuleId('codex', filePath),
75
+ content: trimmed,
76
+ description: (data.description as string) || undefined,
77
+ source: 'codex',
78
+ scope: 'project',
79
+ priority: 5,
80
+ hash: hashContent(trimmed),
81
+ }];
82
+ }
83
+
84
+ private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
85
+ const trimmed = content.trim();
86
+ if (!trimmed) return [];
87
+
88
+ return [{
89
+ id: generateRuleId('codex', filePath),
90
+ content: trimmed,
91
+ source: 'codex',
92
+ scope: 'project',
93
+ priority: 5,
94
+ hash: hashContent(trimmed),
95
+ }];
96
+ }
97
+ }
@@ -1,124 +1,124 @@
1
- /**
2
- * GitHub Copilot Rule Format Adapter
3
- *
4
- * Parses and generates rules in Copilot's formats:
5
- * - .github/copilot-instructions.md (repository-wide instructions, plain Markdown)
6
- * - .github/instructions/*.instructions.md (path-specific, YAML frontmatter with `applyTo` glob)
7
- *
8
- * Source: https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
9
- */
10
-
11
- import matter from 'gray-matter';
12
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
- import { hashContent, generateRuleId } from '../utils.js';
14
-
15
- export class CopilotAdapter implements RuleFormatAdapter {
16
- readonly source: RuleSource = 'copilot';
17
-
18
- readonly filePatterns = [
19
- '.github/copilot-instructions.md',
20
- '.github/instructions/*.instructions.md',
21
- ];
22
-
23
- parse(filePath: string, content: string): UnifiedRule[] {
24
- // Path-specific instruction files (.github/instructions/*.instructions.md)
25
- if (filePath.includes('.instructions.md') && filePath.includes('.github/instructions')) {
26
- return this.parsePathSpecific(filePath, content);
27
- }
28
- // Repository-wide instructions (.github/copilot-instructions.md)
29
- if (filePath.includes('copilot-instructions.md')) {
30
- return this.parseRepoWide(filePath, content);
31
- }
32
- return [];
33
- }
34
-
35
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
36
- // If only one rule with no path-specific globs, output as copilot-instructions.md
37
- if (rules.length === 1 && (!rules[0].paths || rules[0].paths.length === 0)) {
38
- return [{
39
- filePath: '.github/copilot-instructions.md',
40
- content: rules[0].content,
41
- }];
42
- }
43
-
44
- // Multiple rules → output as path-specific instruction files
45
- return rules.map((rule, i) => {
46
- const fm: Record<string, unknown> = {};
47
-
48
- // Preserve applyTo if available
49
- if (rule.paths && rule.paths.length > 0) {
50
- fm.applyTo = rule.paths.join(',');
51
- }
52
- if (rule.description) {
53
- fm.description = rule.description;
54
- }
55
-
56
- const fileName = rule.id
57
- .replace(/^copilot:/, '')
58
- .replace(/[^a-zA-Z0-9-_]/g, '-')
59
- || `instruction-${i}`;
60
-
61
- const body = Object.keys(fm).length > 0
62
- ? matter.stringify(rule.content, fm)
63
- : rule.content;
64
-
65
- return {
66
- filePath: `.github/instructions/${fileName}.instructions.md`,
67
- content: body,
68
- };
69
- });
70
- }
71
-
72
- /**
73
- * Parse repository-wide .github/copilot-instructions.md
74
- * This is plain Markdown with no frontmatter.
75
- */
76
- private parseRepoWide(filePath: string, content: string): UnifiedRule[] {
77
- const trimmed = content.trim();
78
- if (!trimmed) return [];
79
-
80
- return [{
81
- id: generateRuleId('copilot', filePath),
82
- content: trimmed,
83
- description: 'Repository-wide Copilot instructions',
84
- source: 'copilot',
85
- scope: 'project',
86
- priority: 3,
87
- hash: hashContent(trimmed),
88
- }];
89
- }
90
-
91
- /**
92
- * Parse path-specific .github/instructions/*.instructions.md
93
- * These have YAML frontmatter with `applyTo` glob pattern(s).
94
- */
95
- private parsePathSpecific(filePath: string, content: string): UnifiedRule[] {
96
- const { data, content: body } = matter(content);
97
- const trimmed = body.trim();
98
- if (!trimmed) return [];
99
-
100
- const applyTo = data.applyTo as string | undefined;
101
- const hasApplyTo = !!applyTo;
102
-
103
- const rule: UnifiedRule = {
104
- id: generateRuleId('copilot', filePath),
105
- content: trimmed,
106
- source: 'copilot',
107
- scope: hasApplyTo ? 'path-specific' : 'project',
108
- priority: 5,
109
- hash: hashContent(trimmed),
110
- };
111
-
112
- // Extract applyTo glob pattern(s) → store in paths[]
113
- if (hasApplyTo) {
114
- rule.paths = applyTo!.split(',').map(p => p.trim());
115
- }
116
-
117
- // Extract description if present
118
- if (data.description) {
119
- rule.description = data.description as string;
120
- }
121
-
122
- return [rule];
123
- }
124
- }
1
+ /**
2
+ * GitHub Copilot Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Copilot's formats:
5
+ * - .github/copilot-instructions.md (repository-wide instructions, plain Markdown)
6
+ * - .github/instructions/*.instructions.md (path-specific, YAML frontmatter with `applyTo` glob)
7
+ *
8
+ * Source: https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
9
+ */
10
+
11
+ import matter from 'gray-matter';
12
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
13
+ import { hashContent, generateRuleId } from '../utils.js';
14
+
15
+ export class CopilotAdapter implements RuleFormatAdapter {
16
+ readonly source: RuleSource = 'copilot';
17
+
18
+ readonly filePatterns = [
19
+ '.github/copilot-instructions.md',
20
+ '.github/instructions/*.instructions.md',
21
+ ];
22
+
23
+ parse(filePath: string, content: string): UnifiedRule[] {
24
+ // Path-specific instruction files (.github/instructions/*.instructions.md)
25
+ if (filePath.includes('.instructions.md') && filePath.includes('.github/instructions')) {
26
+ return this.parsePathSpecific(filePath, content);
27
+ }
28
+ // Repository-wide instructions (.github/copilot-instructions.md)
29
+ if (filePath.includes('copilot-instructions.md')) {
30
+ return this.parseRepoWide(filePath, content);
31
+ }
32
+ return [];
33
+ }
34
+
35
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
36
+ // If only one rule with no path-specific globs, output as copilot-instructions.md
37
+ if (rules.length === 1 && (!rules[0].paths || rules[0].paths.length === 0)) {
38
+ return [{
39
+ filePath: '.github/copilot-instructions.md',
40
+ content: rules[0].content,
41
+ }];
42
+ }
43
+
44
+ // Multiple rules → output as path-specific instruction files
45
+ return rules.map((rule, i) => {
46
+ const fm: Record<string, unknown> = {};
47
+
48
+ // Preserve applyTo if available
49
+ if (rule.paths && rule.paths.length > 0) {
50
+ fm.applyTo = rule.paths.join(',');
51
+ }
52
+ if (rule.description) {
53
+ fm.description = rule.description;
54
+ }
55
+
56
+ const fileName = rule.id
57
+ .replace(/^copilot:/, '')
58
+ .replace(/[^a-zA-Z0-9-_]/g, '-')
59
+ || `instruction-${i}`;
60
+
61
+ const body = Object.keys(fm).length > 0
62
+ ? matter.stringify(rule.content, fm)
63
+ : rule.content;
64
+
65
+ return {
66
+ filePath: `.github/instructions/${fileName}.instructions.md`,
67
+ content: body,
68
+ };
69
+ });
70
+ }
71
+
72
+ /**
73
+ * Parse repository-wide .github/copilot-instructions.md
74
+ * This is plain Markdown with no frontmatter.
75
+ */
76
+ private parseRepoWide(filePath: string, content: string): UnifiedRule[] {
77
+ const trimmed = content.trim();
78
+ if (!trimmed) return [];
79
+
80
+ return [{
81
+ id: generateRuleId('copilot', filePath),
82
+ content: trimmed,
83
+ description: 'Repository-wide Copilot instructions',
84
+ source: 'copilot',
85
+ scope: 'project',
86
+ priority: 3,
87
+ hash: hashContent(trimmed),
88
+ }];
89
+ }
90
+
91
+ /**
92
+ * Parse path-specific .github/instructions/*.instructions.md
93
+ * These have YAML frontmatter with `applyTo` glob pattern(s).
94
+ */
95
+ private parsePathSpecific(filePath: string, content: string): UnifiedRule[] {
96
+ const { data, content: body } = matter(content);
97
+ const trimmed = body.trim();
98
+ if (!trimmed) return [];
99
+
100
+ const applyTo = data.applyTo as string | undefined;
101
+ const hasApplyTo = !!applyTo;
102
+
103
+ const rule: UnifiedRule = {
104
+ id: generateRuleId('copilot', filePath),
105
+ content: trimmed,
106
+ source: 'copilot',
107
+ scope: hasApplyTo ? 'path-specific' : 'project',
108
+ priority: 5,
109
+ hash: hashContent(trimmed),
110
+ };
111
+
112
+ // Extract applyTo glob pattern(s) → store in paths[]
113
+ if (hasApplyTo) {
114
+ rule.paths = applyTo!.split(',').map(p => p.trim());
115
+ }
116
+
117
+ // Extract description if present
118
+ if (data.description) {
119
+ rule.description = data.description as string;
120
+ }
121
+
122
+ return [rule];
123
+ }
124
+ }