memorix 1.2.0 → 1.2.2

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 (212) hide show
  1. package/CHANGELOG.md +30 -1
  2. package/README.md +18 -4
  3. package/README.zh-CN.md +18 -4
  4. package/TEAM.md +86 -86
  5. package/dist/cli/index.js +15919 -14055
  6. package/dist/cli/index.js.map +1 -1
  7. package/dist/index.js +1997 -1021
  8. package/dist/index.js.map +1 -1
  9. package/dist/maintenance-runner.d.ts +1 -1
  10. package/dist/maintenance-runner.js +8481 -8005
  11. package/dist/maintenance-runner.js.map +1 -1
  12. package/dist/memcode-runtime/CHANGELOG.md +30 -1
  13. package/dist/sdk.d.ts +7 -2
  14. package/dist/sdk.js +2022 -1024
  15. package/dist/sdk.js.map +1 -1
  16. package/dist/types.d.ts +49 -1
  17. package/dist/types.js.map +1 -1
  18. package/docs/1.2.2-MEMORY-CONTROL-PLANE.md +434 -0
  19. package/docs/AGENT_OPERATOR_PLAYBOOK.md +4 -0
  20. package/docs/API_REFERENCE.md +27 -5
  21. package/docs/DESIGN_DECISIONS.md +357 -357
  22. package/docs/DEVELOPMENT.md +4 -0
  23. package/docs/README.md +1 -1
  24. package/docs/SETUP.md +7 -1
  25. package/docs/dev-log/progress.txt +91 -11
  26. package/docs/knowledge/workflows/memorix-release.md +57 -0
  27. package/package.json +1 -1
  28. package/plugins/codex/memorix/.codex-plugin/plugin.json +1 -1
  29. package/src/audit/index.ts +156 -156
  30. package/src/cli/command-guide.ts +192 -0
  31. package/src/cli/commands/audit-list.ts +89 -89
  32. package/src/cli/commands/audit.ts +9 -4
  33. package/src/cli/commands/background.ts +659 -659
  34. package/src/cli/commands/cleanup.ts +5 -1
  35. package/src/cli/commands/codegraph.ts +17 -8
  36. package/src/cli/commands/context.ts +3 -2
  37. package/src/cli/commands/doctor.ts +4 -2
  38. package/src/cli/commands/explain.ts +9 -3
  39. package/src/cli/commands/formation.ts +48 -48
  40. package/src/cli/commands/git-hook-install.ts +111 -111
  41. package/src/cli/commands/handoff.ts +75 -61
  42. package/src/cli/commands/hooks-status.ts +63 -63
  43. package/src/cli/commands/identity.ts +116 -0
  44. package/src/cli/commands/ingest-commit.ts +153 -153
  45. package/src/cli/commands/ingest-image.ts +71 -69
  46. package/src/cli/commands/ingest-log.ts +180 -180
  47. package/src/cli/commands/ingest.ts +44 -44
  48. package/src/cli/commands/integrate-shared.ts +15 -15
  49. package/src/cli/commands/knowledge.ts +40 -0
  50. package/src/cli/commands/lock.ts +93 -92
  51. package/src/cli/commands/memory.ts +58 -21
  52. package/src/cli/commands/message.ts +123 -118
  53. package/src/cli/commands/operator-shared.ts +98 -3
  54. package/src/cli/commands/poll.ts +74 -64
  55. package/src/cli/commands/purge-all-memory.ts +85 -85
  56. package/src/cli/commands/purge-project-memory.ts +83 -83
  57. package/src/cli/commands/reasoning.ts +135 -121
  58. package/src/cli/commands/retention.ts +9 -4
  59. package/src/cli/commands/serve-http.ts +22 -43
  60. package/src/cli/commands/serve-shared.ts +118 -118
  61. package/src/cli/commands/session.ts +29 -3
  62. package/src/cli/commands/setup.ts +9 -3
  63. package/src/cli/commands/skills.ts +124 -119
  64. package/src/cli/commands/status.ts +4 -3
  65. package/src/cli/commands/task.ts +193 -184
  66. package/src/cli/commands/team.ts +14 -10
  67. package/src/cli/commands/transfer.ts +108 -55
  68. package/src/cli/commands/uninstall-project-artifacts.ts +85 -85
  69. package/src/cli/identity.ts +89 -0
  70. package/src/cli/index.ts +96 -19
  71. package/src/cli/invocation.ts +115 -0
  72. package/src/cli/tui/ChatView.tsx +234 -234
  73. package/src/cli/tui/CommandBar.tsx +312 -312
  74. package/src/cli/tui/ContextRail.tsx +118 -118
  75. package/src/cli/tui/HeaderBar.tsx +72 -72
  76. package/src/cli/tui/LogoBanner.tsx +51 -51
  77. package/src/cli/tui/Sidebar.tsx +179 -179
  78. package/src/cli/tui/chat-service.ts +41 -18
  79. package/src/cli/tui/data.ts +23 -44
  80. package/src/cli/tui/index.ts +41 -41
  81. package/src/cli/tui/markdown-render.tsx +371 -371
  82. package/src/cli/tui/operator-context.ts +60 -0
  83. package/src/cli/tui/use-mouse.ts +157 -157
  84. package/src/cli/tui/useNavigation.ts +56 -56
  85. package/src/cli/tui/views/MemoryView.tsx +10 -8
  86. package/src/cli/update-checker.ts +211 -211
  87. package/src/cli/version.ts +7 -7
  88. package/src/cli/workbench.ts +1 -1
  89. package/src/codegraph/auto-context.ts +34 -17
  90. package/src/codegraph/context-pack.ts +1 -0
  91. package/src/codegraph/current-facts.ts +19 -1
  92. package/src/codegraph/project-context.ts +2 -0
  93. package/src/codegraph/task-lens.ts +49 -5
  94. package/src/compact/engine.ts +26 -10
  95. package/src/compact/index-format.ts +25 -2
  96. package/src/compact/token-budget.ts +74 -74
  97. package/src/dashboard/project-classification.ts +64 -64
  98. package/src/dashboard/server.ts +58 -52
  99. package/src/embedding/fastembed-provider.ts +142 -142
  100. package/src/embedding/transformers-provider.ts +111 -111
  101. package/src/git/extractor.ts +209 -209
  102. package/src/git/hooks-path.ts +85 -85
  103. package/src/hooks/admission.ts +117 -0
  104. package/src/hooks/handler.ts +98 -91
  105. package/src/hooks/pattern-detector.ts +173 -173
  106. package/src/hooks/significance-filter.ts +250 -250
  107. package/src/knowledge/claims.ts +51 -1
  108. package/src/knowledge/context-assembly.ts +97 -0
  109. package/src/knowledge/types.ts +1 -0
  110. package/src/knowledge/workflows.ts +34 -3
  111. package/src/knowledge/workset.ts +179 -10
  112. package/src/llm/memory-manager.ts +328 -328
  113. package/src/llm/provider.ts +885 -885
  114. package/src/llm/quality.ts +248 -248
  115. package/src/memory/admission.ts +57 -0
  116. package/src/memory/attribution-guard.ts +249 -249
  117. package/src/memory/auto-relations.ts +21 -0
  118. package/src/memory/consolidation.ts +13 -2
  119. package/src/memory/disclosure-policy.ts +140 -135
  120. package/src/memory/entity-extractor.ts +197 -197
  121. package/src/memory/export-import.ts +11 -3
  122. package/src/memory/formation/evaluate.ts +217 -217
  123. package/src/memory/formation/extract.ts +361 -361
  124. package/src/memory/formation/index.ts +417 -417
  125. package/src/memory/formation/resolve.ts +344 -344
  126. package/src/memory/formation/types.ts +315 -315
  127. package/src/memory/freshness.ts +122 -122
  128. package/src/memory/graph-context.ts +8 -2
  129. package/src/memory/graph-scope.ts +46 -0
  130. package/src/memory/graph.ts +197 -197
  131. package/src/memory/observations.ts +162 -4
  132. package/src/memory/quality-audit.ts +2 -0
  133. package/src/memory/refs.ts +94 -94
  134. package/src/memory/retention.ts +22 -2
  135. package/src/memory/secret-filter.ts +79 -79
  136. package/src/memory/session.ts +5 -2
  137. package/src/memory/visibility.ts +80 -0
  138. package/src/multimodal/image-loader.ts +143 -143
  139. package/src/orchestrate/adapters/claude-stream.ts +192 -192
  140. package/src/orchestrate/adapters/claude.ts +111 -111
  141. package/src/orchestrate/adapters/codex-stream.ts +134 -134
  142. package/src/orchestrate/adapters/codex.ts +41 -41
  143. package/src/orchestrate/adapters/gemini-stream.ts +166 -166
  144. package/src/orchestrate/adapters/gemini.ts +42 -42
  145. package/src/orchestrate/adapters/index.ts +73 -73
  146. package/src/orchestrate/adapters/opencode-stream.ts +143 -143
  147. package/src/orchestrate/adapters/opencode.ts +47 -47
  148. package/src/orchestrate/adapters/spawn-helper.ts +286 -286
  149. package/src/orchestrate/adapters/types.ts +77 -77
  150. package/src/orchestrate/capability-router.ts +284 -284
  151. package/src/orchestrate/context-compact.ts +188 -188
  152. package/src/orchestrate/cost-tracker.ts +219 -219
  153. package/src/orchestrate/error-recovery.ts +191 -191
  154. package/src/orchestrate/evidence.ts +140 -140
  155. package/src/orchestrate/ledger.ts +110 -110
  156. package/src/orchestrate/memorix-bridge.ts +378 -340
  157. package/src/orchestrate/output-budget.ts +80 -80
  158. package/src/orchestrate/permission.ts +152 -152
  159. package/src/orchestrate/pipeline-trace.ts +131 -131
  160. package/src/orchestrate/prompt-builder.ts +155 -155
  161. package/src/orchestrate/ring-buffer.ts +37 -37
  162. package/src/orchestrate/task-graph.ts +389 -389
  163. package/src/orchestrate/verify-gate.ts +33 -10
  164. package/src/orchestrate/worktree.ts +232 -232
  165. package/src/project/aliases.ts +374 -374
  166. package/src/project/detector.ts +268 -268
  167. package/src/rules/adapters/claude-code.ts +99 -99
  168. package/src/rules/adapters/codex.ts +97 -97
  169. package/src/rules/adapters/copilot.ts +124 -124
  170. package/src/rules/adapters/cursor.ts +114 -114
  171. package/src/rules/adapters/kiro.ts +126 -126
  172. package/src/rules/adapters/trae.ts +56 -56
  173. package/src/rules/adapters/windsurf.ts +83 -83
  174. package/src/rules/syncer.ts +235 -235
  175. package/src/runtime/control-plane-maintenance.ts +1 -0
  176. package/src/runtime/isolated-maintenance.ts +1 -0
  177. package/src/runtime/lifecycle.ts +18 -0
  178. package/src/runtime/maintenance-jobs.ts +1 -0
  179. package/src/runtime/maintenance-runner.ts +2 -0
  180. package/src/runtime/project-maintenance.ts +89 -0
  181. package/src/sdk.ts +334 -304
  182. package/src/search/intent-detector.ts +289 -289
  183. package/src/search/query-expansion.ts +52 -52
  184. package/src/server/formation-timeout.ts +27 -27
  185. package/src/server.ts +334 -93
  186. package/src/skills/mini-skills.ts +386 -386
  187. package/src/store/chat-store.ts +119 -119
  188. package/src/store/graph-store.ts +249 -249
  189. package/src/store/mini-skill-store.ts +349 -349
  190. package/src/store/orama-store.ts +61 -6
  191. package/src/store/persistence-json.ts +212 -212
  192. package/src/store/persistence.ts +291 -291
  193. package/src/store/project-affinity.ts +195 -195
  194. package/src/store/sqlite-db.ts +23 -1
  195. package/src/store/sqlite-store.ts +12 -2
  196. package/src/team/event-bus.ts +76 -76
  197. package/src/team/file-locks.ts +173 -173
  198. package/src/team/handoff.ts +168 -161
  199. package/src/team/messages.ts +203 -203
  200. package/src/team/poll.ts +132 -132
  201. package/src/team/tasks.ts +211 -211
  202. package/src/types.ts +51 -0
  203. package/src/wiki/generator.ts +2 -0
  204. package/src/workspace/mcp-adapters/codex.ts +191 -191
  205. package/src/workspace/mcp-adapters/copilot.ts +105 -105
  206. package/src/workspace/mcp-adapters/cursor.ts +53 -53
  207. package/src/workspace/mcp-adapters/kiro.ts +64 -64
  208. package/src/workspace/mcp-adapters/opencode.ts +123 -123
  209. package/src/workspace/mcp-adapters/trae.ts +134 -134
  210. package/src/workspace/mcp-adapters/windsurf.ts +91 -91
  211. package/src/workspace/sanitizer.ts +60 -60
  212. package/src/workspace/workflow-sync.ts +131 -131
@@ -1,114 +1,114 @@
1
- /**
2
- * Cursor Rule Format Adapter
3
- *
4
- * Parses and generates rules in Cursor's formats:
5
- * - .cursor/rules/*.mdc (Markdown + frontmatter with description, alwaysApply, globs)
6
- * - .cursorrules (legacy plain text)
7
- * - AGENTS.md (pure Markdown)
8
- *
9
- * Source: Cursor official documentation on Project Rules.
10
- */
11
-
12
- import matter from 'gray-matter';
13
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
14
- import { hashContent, generateRuleId } from '../utils.js';
15
-
16
- export class CursorAdapter implements RuleFormatAdapter {
17
- readonly source: RuleSource = 'cursor';
18
-
19
- readonly filePatterns = [
20
- '.cursor/rules/*.mdc',
21
- '.cursorrules',
22
- 'AGENTS.md',
23
- ];
24
-
25
- parse(filePath: string, content: string): UnifiedRule[] {
26
- if (filePath.endsWith('.mdc')) {
27
- return this.parseMdc(filePath, content);
28
- }
29
- if (filePath === '.cursorrules' || filePath.endsWith('/.cursorrules')) {
30
- return this.parseLegacy(filePath, content);
31
- }
32
- if (filePath.endsWith('AGENTS.md')) {
33
- return this.parseAgentsMd(filePath, content);
34
- }
35
- return [];
36
- }
37
-
38
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
39
- return rules.map((rule, i) => {
40
- const fm: Record<string, unknown> = {};
41
- if (rule.description) fm.description = rule.description;
42
- if (rule.alwaysApply !== undefined) fm.alwaysApply = rule.alwaysApply;
43
- if (rule.paths && rule.paths.length > 0) fm.globs = rule.paths;
44
-
45
- const fileName = rule.id
46
- .replace(/^cursor:/, '')
47
- .replace(/[^a-zA-Z0-9-_]/g, '-')
48
- || `rule-${i}`;
49
-
50
- const body = Object.keys(fm).length > 0
51
- ? matter.stringify(rule.content, fm)
52
- : rule.content;
53
-
54
- return {
55
- filePath: `.cursor/rules/${fileName}.mdc`,
56
- content: body,
57
- };
58
- });
59
- }
60
-
61
- private parseMdc(filePath: string, content: string): UnifiedRule[] {
62
- const { data, content: body } = matter(content);
63
- const trimmed = body.trim();
64
- if (!trimmed) return [];
65
-
66
- const globs = data.globs as string[] | undefined;
67
- const hasGlobs = Array.isArray(globs) && globs.length > 0;
68
- const alwaysApply = data.alwaysApply === true;
69
-
70
- let scope: UnifiedRule['scope'] = 'project';
71
- if (alwaysApply) scope = 'global';
72
- else if (hasGlobs) scope = 'path-specific';
73
-
74
- return [{
75
- id: generateRuleId('cursor', filePath),
76
- content: trimmed,
77
- description: data.description as string | undefined,
78
- source: 'cursor',
79
- scope,
80
- paths: hasGlobs ? globs : undefined,
81
- alwaysApply,
82
- priority: alwaysApply ? 10 : 5,
83
- hash: hashContent(trimmed),
84
- }];
85
- }
86
-
87
- private parseLegacy(filePath: string, content: string): UnifiedRule[] {
88
- const trimmed = content.trim();
89
- if (!trimmed) return [];
90
-
91
- return [{
92
- id: generateRuleId('cursor', filePath),
93
- content: trimmed,
94
- source: 'cursor',
95
- scope: 'project',
96
- priority: 3,
97
- hash: hashContent(trimmed),
98
- }];
99
- }
100
-
101
- private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
102
- const trimmed = content.trim();
103
- if (!trimmed) return [];
104
-
105
- return [{
106
- id: generateRuleId('cursor', filePath),
107
- content: trimmed,
108
- source: 'cursor',
109
- scope: 'project',
110
- priority: 5,
111
- hash: hashContent(trimmed),
112
- }];
113
- }
114
- }
1
+ /**
2
+ * Cursor Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Cursor's formats:
5
+ * - .cursor/rules/*.mdc (Markdown + frontmatter with description, alwaysApply, globs)
6
+ * - .cursorrules (legacy plain text)
7
+ * - AGENTS.md (pure Markdown)
8
+ *
9
+ * Source: Cursor official documentation on Project Rules.
10
+ */
11
+
12
+ import matter from 'gray-matter';
13
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
14
+ import { hashContent, generateRuleId } from '../utils.js';
15
+
16
+ export class CursorAdapter implements RuleFormatAdapter {
17
+ readonly source: RuleSource = 'cursor';
18
+
19
+ readonly filePatterns = [
20
+ '.cursor/rules/*.mdc',
21
+ '.cursorrules',
22
+ 'AGENTS.md',
23
+ ];
24
+
25
+ parse(filePath: string, content: string): UnifiedRule[] {
26
+ if (filePath.endsWith('.mdc')) {
27
+ return this.parseMdc(filePath, content);
28
+ }
29
+ if (filePath === '.cursorrules' || filePath.endsWith('/.cursorrules')) {
30
+ return this.parseLegacy(filePath, content);
31
+ }
32
+ if (filePath.endsWith('AGENTS.md')) {
33
+ return this.parseAgentsMd(filePath, content);
34
+ }
35
+ return [];
36
+ }
37
+
38
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
39
+ return rules.map((rule, i) => {
40
+ const fm: Record<string, unknown> = {};
41
+ if (rule.description) fm.description = rule.description;
42
+ if (rule.alwaysApply !== undefined) fm.alwaysApply = rule.alwaysApply;
43
+ if (rule.paths && rule.paths.length > 0) fm.globs = rule.paths;
44
+
45
+ const fileName = rule.id
46
+ .replace(/^cursor:/, '')
47
+ .replace(/[^a-zA-Z0-9-_]/g, '-')
48
+ || `rule-${i}`;
49
+
50
+ const body = Object.keys(fm).length > 0
51
+ ? matter.stringify(rule.content, fm)
52
+ : rule.content;
53
+
54
+ return {
55
+ filePath: `.cursor/rules/${fileName}.mdc`,
56
+ content: body,
57
+ };
58
+ });
59
+ }
60
+
61
+ private parseMdc(filePath: string, content: string): UnifiedRule[] {
62
+ const { data, content: body } = matter(content);
63
+ const trimmed = body.trim();
64
+ if (!trimmed) return [];
65
+
66
+ const globs = data.globs as string[] | undefined;
67
+ const hasGlobs = Array.isArray(globs) && globs.length > 0;
68
+ const alwaysApply = data.alwaysApply === true;
69
+
70
+ let scope: UnifiedRule['scope'] = 'project';
71
+ if (alwaysApply) scope = 'global';
72
+ else if (hasGlobs) scope = 'path-specific';
73
+
74
+ return [{
75
+ id: generateRuleId('cursor', filePath),
76
+ content: trimmed,
77
+ description: data.description as string | undefined,
78
+ source: 'cursor',
79
+ scope,
80
+ paths: hasGlobs ? globs : undefined,
81
+ alwaysApply,
82
+ priority: alwaysApply ? 10 : 5,
83
+ hash: hashContent(trimmed),
84
+ }];
85
+ }
86
+
87
+ private parseLegacy(filePath: string, content: string): UnifiedRule[] {
88
+ const trimmed = content.trim();
89
+ if (!trimmed) return [];
90
+
91
+ return [{
92
+ id: generateRuleId('cursor', filePath),
93
+ content: trimmed,
94
+ source: 'cursor',
95
+ scope: 'project',
96
+ priority: 3,
97
+ hash: hashContent(trimmed),
98
+ }];
99
+ }
100
+
101
+ private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
102
+ const trimmed = content.trim();
103
+ if (!trimmed) return [];
104
+
105
+ return [{
106
+ id: generateRuleId('cursor', filePath),
107
+ content: trimmed,
108
+ source: 'cursor',
109
+ scope: 'project',
110
+ priority: 5,
111
+ hash: hashContent(trimmed),
112
+ }];
113
+ }
114
+ }
@@ -1,126 +1,126 @@
1
- /**
2
- * Kiro Rule Format Adapter
3
- *
4
- * Parses and generates rules in Kiro's formats:
5
- * - .kiro/steering/*.md (Markdown steering rules with optional frontmatter)
6
- * - AGENTS.md (always included, pure Markdown)
7
- *
8
- * Source: Kiro official documentation on Steering Rules.
9
- * https://kiro.dev/docs/steering/
10
- *
11
- * Kiro uses ".kiro/steering/" for project-level rules
12
- * and "~/.kiro/steering/" for user-level (global) rules.
13
- *
14
- * Frontmatter inclusion modes:
15
- * - always (default): loaded into every interaction
16
- * - fileMatch + fileMatchPattern: conditional on file globs
17
- * - manual: on-demand via #name in chat
18
- * - auto + name + description: auto-included when relevant
19
- */
20
-
21
- import matter from 'gray-matter';
22
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
23
- import { hashContent, generateRuleId } from '../utils.js';
24
-
25
- /** Kiro inclusion mode values */
26
- type KiroInclusion = 'always' | 'fileMatch' | 'manual' | 'auto';
27
-
28
- export class KiroAdapter implements RuleFormatAdapter {
29
- readonly source: RuleSource = 'kiro';
30
-
31
- readonly filePatterns = [
32
- '.kiro/steering/*.md',
33
- 'AGENTS.md',
34
- ];
35
-
36
- parse(filePath: string, content: string): UnifiedRule[] {
37
- if (filePath.includes('.kiro/steering/')) {
38
- return this.parseSteeringRule(filePath, content);
39
- }
40
- if (filePath.endsWith('AGENTS.md')) {
41
- return this.parseAgentsMd(filePath, content);
42
- }
43
- return [];
44
- }
45
-
46
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
47
- return rules.map((rule, i) => {
48
- const fm: Record<string, unknown> = {};
49
- if (rule.description) fm.description = rule.description;
50
-
51
- // Map unified scope → Kiro inclusion mode
52
- if (rule.paths && rule.paths.length > 0) {
53
- fm.inclusion = 'fileMatch';
54
- fm.fileMatchPattern = rule.paths.length === 1
55
- ? rule.paths[0]
56
- : rule.paths;
57
- } else if (rule.alwaysApply) {
58
- fm.inclusion = 'always';
59
- }
60
-
61
- const fileName = rule.id
62
- .replace(/^kiro:/, '')
63
- .replace(/[^a-zA-Z0-9-_]/g, '-')
64
- || `rule-${i}`;
65
-
66
- const body = Object.keys(fm).length > 0
67
- ? matter.stringify(rule.content, fm)
68
- : rule.content;
69
-
70
- return {
71
- filePath: `.kiro/steering/${fileName}.md`,
72
- content: body,
73
- };
74
- });
75
- }
76
-
77
- private parseSteeringRule(filePath: string, content: string): UnifiedRule[] {
78
- const { data, content: body } = matter(content);
79
- const trimmed = body.trim();
80
- if (!trimmed) return [];
81
-
82
- // Kiro uses "inclusion" field: always | fileMatch | manual | auto
83
- const inclusion = (data.inclusion as KiroInclusion | undefined) ?? 'always';
84
- const alwaysApply = inclusion === 'always' || inclusion === 'auto';
85
-
86
- // fileMatchPattern can be a string or string[]
87
- let paths: string[] | undefined;
88
- if (inclusion === 'fileMatch' && data.fileMatchPattern) {
89
- paths = Array.isArray(data.fileMatchPattern)
90
- ? data.fileMatchPattern
91
- : [data.fileMatchPattern];
92
- }
93
-
94
- let scope: UnifiedRule['scope'] = 'project';
95
- if (alwaysApply) scope = 'global';
96
- else if (paths && paths.length > 0) scope = 'path-specific';
97
-
98
- return [{
99
- id: generateRuleId('kiro', filePath),
100
- content: trimmed,
101
- description: data.description as string | undefined,
102
- source: 'kiro',
103
- scope,
104
- paths,
105
- alwaysApply,
106
- priority: alwaysApply ? 10 : 5,
107
- hash: hashContent(trimmed),
108
- }];
109
- }
110
-
111
- private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
112
- const trimmed = content.trim();
113
- if (!trimmed) return [];
114
-
115
- return [{
116
- id: generateRuleId('kiro', filePath),
117
- content: trimmed,
118
- source: 'kiro',
119
- scope: 'project',
120
- alwaysApply: true,
121
- priority: 10,
122
- hash: hashContent(trimmed),
123
- }];
124
- }
125
- }
126
-
1
+ /**
2
+ * Kiro Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Kiro's formats:
5
+ * - .kiro/steering/*.md (Markdown steering rules with optional frontmatter)
6
+ * - AGENTS.md (always included, pure Markdown)
7
+ *
8
+ * Source: Kiro official documentation on Steering Rules.
9
+ * https://kiro.dev/docs/steering/
10
+ *
11
+ * Kiro uses ".kiro/steering/" for project-level rules
12
+ * and "~/.kiro/steering/" for user-level (global) rules.
13
+ *
14
+ * Frontmatter inclusion modes:
15
+ * - always (default): loaded into every interaction
16
+ * - fileMatch + fileMatchPattern: conditional on file globs
17
+ * - manual: on-demand via #name in chat
18
+ * - auto + name + description: auto-included when relevant
19
+ */
20
+
21
+ import matter from 'gray-matter';
22
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
23
+ import { hashContent, generateRuleId } from '../utils.js';
24
+
25
+ /** Kiro inclusion mode values */
26
+ type KiroInclusion = 'always' | 'fileMatch' | 'manual' | 'auto';
27
+
28
+ export class KiroAdapter implements RuleFormatAdapter {
29
+ readonly source: RuleSource = 'kiro';
30
+
31
+ readonly filePatterns = [
32
+ '.kiro/steering/*.md',
33
+ 'AGENTS.md',
34
+ ];
35
+
36
+ parse(filePath: string, content: string): UnifiedRule[] {
37
+ if (filePath.includes('.kiro/steering/')) {
38
+ return this.parseSteeringRule(filePath, content);
39
+ }
40
+ if (filePath.endsWith('AGENTS.md')) {
41
+ return this.parseAgentsMd(filePath, content);
42
+ }
43
+ return [];
44
+ }
45
+
46
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
47
+ return rules.map((rule, i) => {
48
+ const fm: Record<string, unknown> = {};
49
+ if (rule.description) fm.description = rule.description;
50
+
51
+ // Map unified scope → Kiro inclusion mode
52
+ if (rule.paths && rule.paths.length > 0) {
53
+ fm.inclusion = 'fileMatch';
54
+ fm.fileMatchPattern = rule.paths.length === 1
55
+ ? rule.paths[0]
56
+ : rule.paths;
57
+ } else if (rule.alwaysApply) {
58
+ fm.inclusion = 'always';
59
+ }
60
+
61
+ const fileName = rule.id
62
+ .replace(/^kiro:/, '')
63
+ .replace(/[^a-zA-Z0-9-_]/g, '-')
64
+ || `rule-${i}`;
65
+
66
+ const body = Object.keys(fm).length > 0
67
+ ? matter.stringify(rule.content, fm)
68
+ : rule.content;
69
+
70
+ return {
71
+ filePath: `.kiro/steering/${fileName}.md`,
72
+ content: body,
73
+ };
74
+ });
75
+ }
76
+
77
+ private parseSteeringRule(filePath: string, content: string): UnifiedRule[] {
78
+ const { data, content: body } = matter(content);
79
+ const trimmed = body.trim();
80
+ if (!trimmed) return [];
81
+
82
+ // Kiro uses "inclusion" field: always | fileMatch | manual | auto
83
+ const inclusion = (data.inclusion as KiroInclusion | undefined) ?? 'always';
84
+ const alwaysApply = inclusion === 'always' || inclusion === 'auto';
85
+
86
+ // fileMatchPattern can be a string or string[]
87
+ let paths: string[] | undefined;
88
+ if (inclusion === 'fileMatch' && data.fileMatchPattern) {
89
+ paths = Array.isArray(data.fileMatchPattern)
90
+ ? data.fileMatchPattern
91
+ : [data.fileMatchPattern];
92
+ }
93
+
94
+ let scope: UnifiedRule['scope'] = 'project';
95
+ if (alwaysApply) scope = 'global';
96
+ else if (paths && paths.length > 0) scope = 'path-specific';
97
+
98
+ return [{
99
+ id: generateRuleId('kiro', filePath),
100
+ content: trimmed,
101
+ description: data.description as string | undefined,
102
+ source: 'kiro',
103
+ scope,
104
+ paths,
105
+ alwaysApply,
106
+ priority: alwaysApply ? 10 : 5,
107
+ hash: hashContent(trimmed),
108
+ }];
109
+ }
110
+
111
+ private parseAgentsMd(filePath: string, content: string): UnifiedRule[] {
112
+ const trimmed = content.trim();
113
+ if (!trimmed) return [];
114
+
115
+ return [{
116
+ id: generateRuleId('kiro', filePath),
117
+ content: trimmed,
118
+ source: 'kiro',
119
+ scope: 'project',
120
+ alwaysApply: true,
121
+ priority: 10,
122
+ hash: hashContent(trimmed),
123
+ }];
124
+ }
125
+ }
126
+
@@ -1,56 +1,56 @@
1
- /**
2
- * Trae IDE Rule Format Adapter
3
- *
4
- * Parses and generates rules in Trae's format:
5
- * - .trae/rules/project_rules.md (project-level rules, plain Markdown)
6
- *
7
- * Trae also supports user-level rules (user_rules.md) created via the UI,
8
- * but those are managed by Trae itself and not project-scoped.
9
- *
10
- * Rules are plain Markdown — no frontmatter, no special syntax.
11
- * Project rules override personal rules when there are conflicts.
12
- *
13
- * Source: https://docs.trae.ai/ide/rules
14
- */
15
-
16
- import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
17
- import { hashContent, generateRuleId } from '../utils.js';
18
-
19
- export class TraeAdapter implements RuleFormatAdapter {
20
- readonly source: RuleSource = 'trae';
21
-
22
- readonly filePatterns = [
23
- '.trae/rules/project_rules.md',
24
- '.trae/rules/*.md',
25
- ];
26
-
27
- parse(filePath: string, content: string): UnifiedRule[] {
28
- const trimmed = content.trim();
29
- if (!trimmed) return [];
30
-
31
- const isProjectRules = filePath.includes('project_rules.md');
32
-
33
- return [{
34
- id: generateRuleId('trae', filePath),
35
- content: trimmed,
36
- description: isProjectRules ? 'Trae project rules' : undefined,
37
- source: 'trae',
38
- scope: 'project',
39
- alwaysApply: true,
40
- priority: isProjectRules ? 10 : 5,
41
- hash: hashContent(trimmed),
42
- }];
43
- }
44
-
45
- generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
46
- if (rules.length === 0) return [];
47
-
48
- // Trae uses a single project_rules.md file — merge all rules into one
49
- const combined = rules.map(r => r.content).join('\n\n---\n\n');
50
-
51
- return [{
52
- filePath: '.trae/rules/project_rules.md',
53
- content: combined,
54
- }];
55
- }
56
- }
1
+ /**
2
+ * Trae IDE Rule Format Adapter
3
+ *
4
+ * Parses and generates rules in Trae's format:
5
+ * - .trae/rules/project_rules.md (project-level rules, plain Markdown)
6
+ *
7
+ * Trae also supports user-level rules (user_rules.md) created via the UI,
8
+ * but those are managed by Trae itself and not project-scoped.
9
+ *
10
+ * Rules are plain Markdown — no frontmatter, no special syntax.
11
+ * Project rules override personal rules when there are conflicts.
12
+ *
13
+ * Source: https://docs.trae.ai/ide/rules
14
+ */
15
+
16
+ import type { RuleFormatAdapter, UnifiedRule, RuleSource } from '../../types.js';
17
+ import { hashContent, generateRuleId } from '../utils.js';
18
+
19
+ export class TraeAdapter implements RuleFormatAdapter {
20
+ readonly source: RuleSource = 'trae';
21
+
22
+ readonly filePatterns = [
23
+ '.trae/rules/project_rules.md',
24
+ '.trae/rules/*.md',
25
+ ];
26
+
27
+ parse(filePath: string, content: string): UnifiedRule[] {
28
+ const trimmed = content.trim();
29
+ if (!trimmed) return [];
30
+
31
+ const isProjectRules = filePath.includes('project_rules.md');
32
+
33
+ return [{
34
+ id: generateRuleId('trae', filePath),
35
+ content: trimmed,
36
+ description: isProjectRules ? 'Trae project rules' : undefined,
37
+ source: 'trae',
38
+ scope: 'project',
39
+ alwaysApply: true,
40
+ priority: isProjectRules ? 10 : 5,
41
+ hash: hashContent(trimmed),
42
+ }];
43
+ }
44
+
45
+ generate(rules: UnifiedRule[]): { filePath: string; content: string }[] {
46
+ if (rules.length === 0) return [];
47
+
48
+ // Trae uses a single project_rules.md file — merge all rules into one
49
+ const combined = rules.map(r => r.content).join('\n\n---\n\n');
50
+
51
+ return [{
52
+ filePath: '.trae/rules/project_rules.md',
53
+ content: combined,
54
+ }];
55
+ }
56
+ }