@phuc1403/musketeer 0.8.0 → 0.10.0

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 (236) hide show
  1. package/INSTALLATION.md +52 -52
  2. package/README.md +49 -49
  3. package/bin/musketeer.js +168 -168
  4. package/manifest.json +333 -301
  5. package/package.json +48 -48
  6. package/src/dotnet-scaffold-copier.js +79 -79
  7. package/src/provisioner/detect.js +93 -93
  8. package/src/self-update.js +77 -77
  9. package/template/.claude/agents/code-reviewer.md +182 -166
  10. package/template/.claude/agents/git-manager.md +18 -18
  11. package/template/.claude/agents/hallmark-auditor.md +78 -78
  12. package/template/.claude/agents/researcher.md +33 -33
  13. package/template/.claude/hooks/block-unsafe-adr-title.cjs +85 -85
  14. package/template/.claude/hooks/git-skill-reminder.cjs +53 -0
  15. package/template/.claude/hooks/init-adr-dir.cjs +173 -173
  16. package/template/.claude/hooks/inject-adr-flags.cjs +94 -94
  17. package/template/.claude/hooks/lib/adr/command-scan.cjs +115 -115
  18. package/template/.claude/hooks/lib/characteristics/checker.cjs +357 -357
  19. package/template/.claude/hooks/lib/colors.cjs +180 -122
  20. package/template/.claude/hooks/lib/git-info-cache.cjs +191 -191
  21. package/template/.claude/hooks/lib/transcript-parser.cjs +300 -277
  22. package/template/.claude/hooks/sync-adr-toc.cjs +146 -146
  23. package/template/.claude/hooks/{usage-context-awareness.cjs → usage-quota-cache-refresh.cjs} +166 -166
  24. package/template/.claude/hooks/validate-characteristics-hook.cjs +66 -66
  25. package/template/.claude/hooks/validate-cml-hook.js +145 -145
  26. package/template/.claude/skills/adr-writer/SKILL.md +48 -48
  27. package/template/.claude/skills/adr-writer/references/adr-example.md +35 -35
  28. package/template/.claude/skills/architecture-characteristic-writer/SKILL.md +215 -215
  29. package/template/.claude/skills/architecture-characteristic-writer/assets/worksheet-template.md +29 -29
  30. package/template/.claude/skills/architecture-characteristic-writer/references/characteristics-catalog.md +40 -40
  31. package/template/.claude/skills/architecture-characteristic-writer/scripts/ranking-table.cjs +171 -171
  32. package/template/.claude/skills/code-review/SKILL.md +201 -54
  33. package/template/.claude/skills/code-review/references/checklist-workflow.md +96 -0
  34. package/template/.claude/skills/code-review/references/checklists/api.md +52 -52
  35. package/template/.claude/skills/code-review/references/checklists/base.md +100 -100
  36. package/template/.claude/skills/code-review/references/checklists/web-app.md +54 -54
  37. package/template/.claude/skills/code-review/references/code-review-reception.md +113 -0
  38. package/template/.claude/skills/code-review/references/codebase-scan-workflow.md +30 -0
  39. package/template/.claude/skills/code-review/references/edge-case-scouting.md +119 -0
  40. package/template/.claude/skills/code-review/references/input-mode-resolution.md +135 -0
  41. package/template/.claude/skills/code-review/references/parallel-review-workflow.md +76 -0
  42. package/template/.claude/skills/code-review/references/requesting-code-review.md +116 -0
  43. package/template/.claude/skills/code-review/references/spec-compliance-review.md +43 -0
  44. package/template/.claude/skills/code-review/references/task-management-reviews.md +140 -0
  45. package/template/.claude/skills/code-review/references/verification-before-completion.md +139 -0
  46. package/template/.claude/skills/context-map/SKILL.md +80 -80
  47. package/template/.claude/skills/context-map/example.cml +106 -106
  48. package/template/.claude/skills/context-map/reference/Bounded Context/Bounded Context.md +40 -40
  49. package/template/.claude/skills/context-map/reference/Bounded Context/businessModel.md +5 -5
  50. package/template/.claude/skills/context-map/reference/Bounded Context/domainVisionStatement.md +2 -2
  51. package/template/.claude/skills/context-map/reference/Bounded Context/evolution.md +5 -5
  52. package/template/.claude/skills/context-map/reference/Bounded Context/implementationTechnology.md +1 -1
  53. package/template/.claude/skills/context-map/reference/Bounded Context/implements.md +1 -1
  54. package/template/.claude/skills/context-map/reference/Bounded Context/knowledgeLevel.md +4 -4
  55. package/template/.claude/skills/context-map/reference/Bounded Context/realizes.md +9 -9
  56. package/template/.claude/skills/context-map/reference/Bounded Context/refines.md +10 -10
  57. package/template/.claude/skills/context-map/reference/Bounded Context/responsibilities.md +26 -26
  58. package/template/.claude/skills/context-map/reference/Bounded Context/type.md +23 -23
  59. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Anticorruption Layer.md +5 -5
  60. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Bounded Context Relationship.md +12 -12
  61. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Conformist.md +5 -5
  62. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Customer-Supplier (C-S).md +22 -22
  63. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Open Host Service.md +4 -4
  64. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Partnership (P).md +13 -13
  65. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Published Language.md +4 -4
  66. package/template/.claude/skills/context-map/reference/Bounded Context Relationship/Shared Kernel (SK).md +12 -12
  67. package/template/.claude/skills/context-map/reference/Context Map.md +62 -62
  68. package/template/.claude/skills/context-map/reference/Domain/Domain.md +30 -30
  69. package/template/.claude/skills/context-map/reference/Domain/supports.md +33 -33
  70. package/template/.claude/skills/context-map/reference/Domain/type.md +3 -3
  71. package/template/.claude/skills/context-map/reference/Semantic Rules.md +32 -32
  72. package/template/.claude/skills/git/SKILL.md +131 -115
  73. package/template/.claude/skills/git/references/branch-management.md +88 -88
  74. package/template/.claude/skills/git/references/commit-standards.md +46 -46
  75. package/template/.claude/skills/git/references/context-efficiency.md +54 -0
  76. package/template/.claude/skills/git/references/gh-cli-guide.md +109 -109
  77. package/template/.claude/skills/git/references/safety-protocols.md +69 -69
  78. package/template/.claude/skills/git/references/workflow-commit.md +58 -58
  79. package/template/.claude/skills/git/references/workflow-merge-pr.md +136 -0
  80. package/template/.claude/skills/git/references/workflow-merge.md +48 -48
  81. package/template/.claude/skills/git/references/workflow-pr.md +58 -58
  82. package/template/.claude/skills/git/references/workflow-push.md +52 -52
  83. package/template/.claude/skills/hallmark/SKILL.md +552 -552
  84. package/template/.claude/skills/hallmark/references/anti-patterns.md +412 -412
  85. package/template/.claude/skills/hallmark/references/assets.md +406 -406
  86. package/template/.claude/skills/hallmark/references/color.md +95 -95
  87. package/template/.claude/skills/hallmark/references/component-cookbook.md +256 -256
  88. package/template/.claude/skills/hallmark/references/components/c1-outlined-chip.md +12 -12
  89. package/template/.claude/skills/hallmark/references/components/c2-inline-form-as-cta.md +16 -16
  90. package/template/.claude/skills/hallmark/references/components/c3-typographic-link.md +8 -8
  91. package/template/.claude/skills/hallmark/references/components/c4-sticky-bottom-bar.md +16 -16
  92. package/template/.claude/skills/hallmark/references/components/f1-bento-grid.md +20 -20
  93. package/template/.claude/skills/hallmark/references/components/f2-sticky-scroll-stack.md +20 -20
  94. package/template/.claude/skills/hallmark/references/components/f3-tabular-spec-sheet.md +11 -11
  95. package/template/.claude/skills/hallmark/references/components/f4-step-sequence.md +11 -11
  96. package/template/.claude/skills/hallmark/references/components/f5-annotated-screenshot.md +11 -11
  97. package/template/.claude/skills/hallmark/references/components/f6-product-card-grid.md +41 -41
  98. package/template/.claude/skills/hallmark/references/components/ft1-mast-headed.md +13 -13
  99. package/template/.claude/skills/hallmark/references/components/ft2-inline-rule-single-line.md +10 -10
  100. package/template/.claude/skills/hallmark/references/components/ft3-index-style-category-list.md +12 -12
  101. package/template/.claude/skills/hallmark/references/components/ft4-dense-typographic.md +10 -10
  102. package/template/.claude/skills/hallmark/references/components/ft5-statement.md +21 -21
  103. package/template/.claude/skills/hallmark/references/components/ft6-letter-close.md +19 -19
  104. package/template/.claude/skills/hallmark/references/components/ft7-newsletter-first.md +27 -27
  105. package/template/.claude/skills/hallmark/references/components/ft8-marquee-scroll.md +25 -25
  106. package/template/.claude/skills/hallmark/references/components/h1-marquee.md +15 -15
  107. package/template/.claude/skills/hallmark/references/components/h2-split-diptych.md +15 -15
  108. package/template/.claude/skills/hallmark/references/components/h3-quote-led.md +11 -11
  109. package/template/.claude/skills/hallmark/references/components/h4-stat-led.md +14 -14
  110. package/template/.claude/skills/hallmark/references/components/h5-letter-hero.md +11 -11
  111. package/template/.claude/skills/hallmark/references/components/h6-photographic-fold.md +16 -16
  112. package/template/.claude/skills/hallmark/references/components/h7-demo-video-clipped-by-viewport-edge.md +27 -27
  113. package/template/.claude/skills/hallmark/references/components/h8-mockup-split-browser-framed.md +23 -23
  114. package/template/.claude/skills/hallmark/references/components/h9-custom-illustration-centerpiece.md +27 -27
  115. package/template/.claude/skills/hallmark/references/components/n1-wordmark-2-links.md +12 -12
  116. package/template/.claude/skills/hallmark/references/components/n10-floating-on-scroll-morph.md +19 -19
  117. package/template/.claude/skills/hallmark/references/components/n2-floating-chip.md +14 -14
  118. package/template/.claude/skills/hallmark/references/components/n3-side-rail.md +14 -14
  119. package/template/.claude/skills/hallmark/references/components/n4-hidden-behind-k.md +9 -9
  120. package/template/.claude/skills/hallmark/references/components/n5-floating-pill.md +28 -28
  121. package/template/.claude/skills/hallmark/references/components/n6-newspaper-masthead.md +24 -24
  122. package/template/.claude/skills/hallmark/references/components/n7-brutal-slab.md +22 -22
  123. package/template/.claude/skills/hallmark/references/components/n8-terminal-command.md +21 -21
  124. package/template/.claude/skills/hallmark/references/components/n9-edge-aligned-minimal.md +17 -17
  125. package/template/.claude/skills/hallmark/references/components/s1-left-margin-numbered.md +15 -15
  126. package/template/.claude/skills/hallmark/references/components/s2-hanging.md +13 -13
  127. package/template/.claude/skills/hallmark/references/components/s3-sticky-pinned.md +19 -19
  128. package/template/.claude/skills/hallmark/references/components/s4-inline-no-break.md +11 -11
  129. package/template/.claude/skills/hallmark/references/components/s5-bottom-anchored.md +13 -13
  130. package/template/.claude/skills/hallmark/references/components/t1-pull-quote-with-marginalia.md +12 -12
  131. package/template/.claude/skills/hallmark/references/components/t2-logo-wall-hairline.md +19 -19
  132. package/template/.claude/skills/hallmark/references/components/t3-single-huge-quote.md +11 -11
  133. package/template/.claude/skills/hallmark/references/components/t4-numbered-stat-strip.md +14 -14
  134. package/template/.claude/skills/hallmark/references/contract.md +24 -24
  135. package/template/.claude/skills/hallmark/references/copy.md +182 -182
  136. package/template/.claude/skills/hallmark/references/custom-craft.md +626 -626
  137. package/template/.claude/skills/hallmark/references/custom-theme.md +329 -329
  138. package/template/.claude/skills/hallmark/references/design-md.md +116 -116
  139. package/template/.claude/skills/hallmark/references/export-formats.md +328 -328
  140. package/template/.claude/skills/hallmark/references/floating-nav.md +89 -89
  141. package/template/.claude/skills/hallmark/references/genres/atmospheric.md +65 -65
  142. package/template/.claude/skills/hallmark/references/genres/editorial.md +70 -70
  143. package/template/.claude/skills/hallmark/references/genres/modern-minimal.md +67 -67
  144. package/template/.claude/skills/hallmark/references/genres/playful.md +65 -65
  145. package/template/.claude/skills/hallmark/references/hero-enrichment.md +474 -474
  146. package/template/.claude/skills/hallmark/references/imagery-kit.md +170 -170
  147. package/template/.claude/skills/hallmark/references/interaction-and-states.md +207 -207
  148. package/template/.claude/skills/hallmark/references/layout-and-space.md +111 -111
  149. package/template/.claude/skills/hallmark/references/macrostructures/01-bento-grid.md +35 -35
  150. package/template/.claude/skills/hallmark/references/macrostructures/02-long-document.md +34 -34
  151. package/template/.claude/skills/hallmark/references/macrostructures/03-marquee-hero.md +31 -31
  152. package/template/.claude/skills/hallmark/references/macrostructures/04-stat-led.md +32 -32
  153. package/template/.claude/skills/hallmark/references/macrostructures/05-workbench.md +32 -32
  154. package/template/.claude/skills/hallmark/references/macrostructures/06-conversational-faq.md +33 -33
  155. package/template/.claude/skills/hallmark/references/macrostructures/07-manifesto.md +32 -32
  156. package/template/.claude/skills/hallmark/references/macrostructures/08-photographic.md +34 -34
  157. package/template/.claude/skills/hallmark/references/macrostructures/09-quote-led.md +32 -32
  158. package/template/.claude/skills/hallmark/references/macrostructures/10-specimen.md +32 -32
  159. package/template/.claude/skills/hallmark/references/macrostructures/11-catalogue.md +23 -23
  160. package/template/.claude/skills/hallmark/references/macrostructures/12-letter.md +23 -23
  161. package/template/.claude/skills/hallmark/references/macrostructures/13-index-first.md +23 -23
  162. package/template/.claude/skills/hallmark/references/macrostructures/14-narrative-workflow.md +23 -23
  163. package/template/.claude/skills/hallmark/references/macrostructures/15-split-studio.md +23 -23
  164. package/template/.claude/skills/hallmark/references/macrostructures/16-feature-stack.md +23 -23
  165. package/template/.claude/skills/hallmark/references/macrostructures/17-type-specimen.md +23 -23
  166. package/template/.claude/skills/hallmark/references/macrostructures/18-portfolio-grid.md +23 -23
  167. package/template/.claude/skills/hallmark/references/macrostructures/19-map-diagram.md +23 -23
  168. package/template/.claude/skills/hallmark/references/macrostructures/20-ecosystem-index.md +23 -23
  169. package/template/.claude/skills/hallmark/references/macrostructures/21-component-playground.md +23 -23
  170. package/template/.claude/skills/hallmark/references/macrostructures.md +89 -89
  171. package/template/.claude/skills/hallmark/references/microinteractions.md +260 -260
  172. package/template/.claude/skills/hallmark/references/motion.md +109 -109
  173. package/template/.claude/skills/hallmark/references/preview-examples.md +49 -49
  174. package/template/.claude/skills/hallmark/references/responsive.md +138 -138
  175. package/template/.claude/skills/hallmark/references/slop-test.md +205 -205
  176. package/template/.claude/skills/hallmark/references/structure.md +164 -164
  177. package/template/.claude/skills/hallmark/references/study.md +511 -511
  178. package/template/.claude/skills/hallmark/references/typography.md +243 -243
  179. package/template/.claude/skills/hallmark/references/verbs/audit.md +25 -25
  180. package/template/.claude/skills/hallmark/references/verbs/redesign.md +269 -269
  181. package/template/.claude/skills/hallmark-loop/SKILL.md +105 -105
  182. package/template/.claude/skills/hallmark-loop/references/auditor-call.md +60 -60
  183. package/template/.claude/skills/hallmark-loop/references/capture.md +78 -78
  184. package/template/.claude/skills/hallmark-loop/references/loop-control.md +79 -79
  185. package/template/.claude/skills/handoff/SKILL.md +15 -15
  186. package/template/.claude/skills/knowledge-crunching/SKILL.md +94 -94
  187. package/template/.claude/skills/research/SKILL.md +69 -69
  188. package/template/.claude/skills/skill-creator/LICENSE.txt +201 -201
  189. package/template/.claude/skills/skill-creator/SKILL.md +154 -149
  190. package/template/.claude/skills/skill-creator/agents/analyzer.md +274 -274
  191. package/template/.claude/skills/skill-creator/agents/comparator.md +202 -202
  192. package/template/.claude/skills/skill-creator/agents/grader.md +223 -223
  193. package/template/.claude/skills/skill-creator/assets/eval_review.html +146 -146
  194. package/template/.claude/skills/skill-creator/eval-viewer/generate_review.py +471 -471
  195. package/template/.claude/skills/skill-creator/eval-viewer/viewer.html +1325 -1325
  196. package/template/.claude/skills/skill-creator/references/benchmark-optimization-guide.md +86 -86
  197. package/template/.claude/skills/skill-creator/references/distribution-guide.md +79 -79
  198. package/template/.claude/skills/skill-creator/references/eval-infrastructure-guide.md +129 -129
  199. package/template/.claude/skills/skill-creator/references/eval-schemas.md +121 -121
  200. package/template/.claude/skills/skill-creator/references/mcp-skills-integration.md +71 -71
  201. package/template/.claude/skills/skill-creator/references/metadata-quality-criteria.md +94 -94
  202. package/template/.claude/skills/skill-creator/references/plugin-marketplace-hosting.md +104 -104
  203. package/template/.claude/skills/skill-creator/references/plugin-marketplace-overview.md +89 -89
  204. package/template/.claude/skills/skill-creator/references/plugin-marketplace-schema.md +93 -93
  205. package/template/.claude/skills/skill-creator/references/plugin-marketplace-sources.md +103 -103
  206. package/template/.claude/skills/skill-creator/references/plugin-marketplace-troubleshooting.md +76 -76
  207. package/template/.claude/skills/skill-creator/references/script-quality-criteria.md +106 -106
  208. package/template/.claude/skills/skill-creator/references/skill-anatomy-and-requirements.md +77 -77
  209. package/template/.claude/skills/skill-creator/references/skill-creation-workflow.md +152 -151
  210. package/template/.claude/skills/skill-creator/references/skill-design-patterns.md +75 -75
  211. package/template/.claude/skills/skill-creator/references/skillmark-benchmark-criteria.md +102 -102
  212. package/template/.claude/skills/skill-creator/references/structure-organization-criteria.md +114 -114
  213. package/template/.claude/skills/skill-creator/references/testing-and-iteration.md +78 -78
  214. package/template/.claude/skills/skill-creator/references/token-efficiency-criteria.md +74 -74
  215. package/template/.claude/skills/skill-creator/references/troubleshooting-guide.md +81 -81
  216. package/template/.claude/skills/skill-creator/references/validation-checklist.md +83 -83
  217. package/template/.claude/skills/skill-creator/references/writing-effective-instructions.md +88 -88
  218. package/template/.claude/skills/skill-creator/references/yaml-frontmatter-reference.md +92 -92
  219. package/template/.claude/skills/skill-creator/scripts/aggregate_benchmark.py +401 -401
  220. package/template/.claude/skills/skill-creator/scripts/encoding_utils.py +36 -36
  221. package/template/.claude/skills/skill-creator/scripts/generate_report.py +326 -326
  222. package/template/.claude/skills/skill-creator/scripts/improve_description.py +248 -248
  223. package/template/.claude/skills/skill-creator/scripts/init_skill.py +360 -360
  224. package/template/.claude/skills/skill-creator/scripts/package_skill.py +143 -143
  225. package/template/.claude/skills/skill-creator/scripts/quick_validate.py +110 -110
  226. package/template/.claude/skills/skill-creator/scripts/run_eval.py +310 -310
  227. package/template/.claude/skills/skill-creator/scripts/run_loop.py +332 -332
  228. package/template/.claude/skills/skill-creator/scripts/utils.py +47 -47
  229. package/template/.claude/skills/tdd/SKILL.md +142 -142
  230. package/template/.claude/skills/tdd/deep-modules.md +15 -15
  231. package/template/.claude/skills/tdd/interface-design.md +31 -31
  232. package/template/.claude/skills/tdd/mocking.md +59 -59
  233. package/template/.claude/skills/tdd/refactoring.md +10 -10
  234. package/template/.claude/skills/tdd/tests.md +61 -61
  235. package/template/.claude/statusline.cjs +0 -0
  236. package/template/.claude/skills/code-review/references/adversarial-review.md +0 -223
@@ -1,66 +1,66 @@
1
- #!/usr/bin/env node
2
- // PostToolUse validation hook for the two architecture-characteristic documents.
3
- //
4
- // .claude/settings.json calls this after every Write/Edit/MultiEdit. If the
5
- // edited file is the ranking or the worksheet, both are checked together — the
6
- // worksheet is a derivation of the ranking, so neither can be judged alone.
7
- //
8
- // Hook exit-code contract:
9
- // exit 0 -> ok (stdout shown in transcript)
10
- // exit 2 -> blocking error (stderr fed back to Claude to fix)
11
- // An unrelated edit, a missing file, or an unparseable payload all exit 0.
12
- //
13
- // Only structure is checked. The ranking ORDER is the architect's call and is
14
- // never second-guessed here.
15
-
16
- const fs = require('fs');
17
- const path = require('path');
18
-
19
- const RANKING = 'docs/architecture-characteristics-ranking.md';
20
- const WORKSHEET = 'docs/architecture-characteristics.md';
21
-
22
- function read(root, rel) {
23
- try {
24
- return fs.readFileSync(path.join(root, rel), 'utf8');
25
- } catch {
26
- return null;
27
- }
28
- }
29
-
30
- try {
31
- const root = process.env.CLAUDE_PROJECT_DIR || process.cwd();
32
- const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
33
- const edited = payload?.tool_input?.file_path;
34
-
35
- if (!edited) process.exit(0);
36
-
37
- // Windows resolves paths case-insensitively, so the same document can arrive
38
- // spelled several ways. Comparing case-sensitively there would let an edit
39
- // slip past the gate unchecked, which is worse than checking one file twice.
40
- const fold = (p) => (process.platform === 'win32' ? p.toLowerCase() : p);
41
- const rel = path.relative(root, path.resolve(root, edited)).split(path.sep).join('/');
42
- if (fold(rel) !== fold(RANKING) && fold(rel) !== fold(WORKSHEET)) process.exit(0);
43
-
44
- const { check } = require('./lib/characteristics/checker.cjs');
45
- const ranking = read(root, RANKING);
46
-
47
- // Editing the ranking alone, before any worksheet exists, is the normal path
48
- // through Phase A: `read` returns null and the worksheet rules stay quiet.
49
- const worksheet = read(root, WORKSHEET);
50
-
51
- const errors = check({ ranking, worksheet });
52
-
53
- if (errors.length) {
54
- process.stderr.write(
55
- `Architecture characteristics: ${errors.length} structural problem(s) in ${rel}\n\n` +
56
- errors.map((e) => ` - ${e}`).join('\n') +
57
- '\n\nFix the file. These are mechanical rules, not judgement calls: the ranking must ' +
58
- 'cover the catalog exactly once each, every Reason must name the row directly below it, ' +
59
- 'and the worksheet must derive from the top 7.\n'
60
- );
61
- process.exit(2);
62
- }
63
- } catch {
64
- /* fail open — a structure checker must never be the thing that breaks a session */
65
- }
66
- process.exit(0);
1
+ #!/usr/bin/env node
2
+ // PostToolUse validation hook for the two architecture-characteristic documents.
3
+ //
4
+ // .claude/settings.json calls this after every Write/Edit/MultiEdit. If the
5
+ // edited file is the ranking or the worksheet, both are checked together — the
6
+ // worksheet is a derivation of the ranking, so neither can be judged alone.
7
+ //
8
+ // Hook exit-code contract:
9
+ // exit 0 -> ok (stdout shown in transcript)
10
+ // exit 2 -> blocking error (stderr fed back to Claude to fix)
11
+ // An unrelated edit, a missing file, or an unparseable payload all exit 0.
12
+ //
13
+ // Only structure is checked. The ranking ORDER is the architect's call and is
14
+ // never second-guessed here.
15
+
16
+ const fs = require('fs');
17
+ const path = require('path');
18
+
19
+ const RANKING = 'docs/architecture-characteristics-ranking.md';
20
+ const WORKSHEET = 'docs/architecture-characteristics.md';
21
+
22
+ function read(root, rel) {
23
+ try {
24
+ return fs.readFileSync(path.join(root, rel), 'utf8');
25
+ } catch {
26
+ return null;
27
+ }
28
+ }
29
+
30
+ try {
31
+ const root = process.env.CLAUDE_PROJECT_DIR || process.cwd();
32
+ const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
33
+ const edited = payload?.tool_input?.file_path;
34
+
35
+ if (!edited) process.exit(0);
36
+
37
+ // Windows resolves paths case-insensitively, so the same document can arrive
38
+ // spelled several ways. Comparing case-sensitively there would let an edit
39
+ // slip past the gate unchecked, which is worse than checking one file twice.
40
+ const fold = (p) => (process.platform === 'win32' ? p.toLowerCase() : p);
41
+ const rel = path.relative(root, path.resolve(root, edited)).split(path.sep).join('/');
42
+ if (fold(rel) !== fold(RANKING) && fold(rel) !== fold(WORKSHEET)) process.exit(0);
43
+
44
+ const { check } = require('./lib/characteristics/checker.cjs');
45
+ const ranking = read(root, RANKING);
46
+
47
+ // Editing the ranking alone, before any worksheet exists, is the normal path
48
+ // through Phase A: `read` returns null and the worksheet rules stay quiet.
49
+ const worksheet = read(root, WORKSHEET);
50
+
51
+ const errors = check({ ranking, worksheet });
52
+
53
+ if (errors.length) {
54
+ process.stderr.write(
55
+ `Architecture characteristics: ${errors.length} structural problem(s) in ${rel}\n\n` +
56
+ errors.map((e) => ` - ${e}`).join('\n') +
57
+ '\n\nFix the file. These are mechanical rules, not judgement calls: the ranking must ' +
58
+ 'cover the catalog exactly once each, every Reason must name the row directly below it, ' +
59
+ 'and the worksheet must derive from the top 7.\n'
60
+ );
61
+ process.exit(2);
62
+ }
63
+ } catch {
64
+ /* fail open — a structure checker must never be the thing that breaks a session */
65
+ }
66
+ process.exit(0);
@@ -1,145 +1,145 @@
1
- #!/usr/bin/env node
2
- // PostToolUse validation hook for Context Mapper `.cml` files (cross-platform).
3
- //
4
- // .claude/settings.json calls this as `node validate-cml-hook.js` after every
5
- // Write/Edit. It
6
- // reads the PostToolUse payload from stdin, and if the edited file is a .cml,
7
- // validates it with the Context Mapper CLI and speaks the hook exit-code
8
- // contract:
9
- // exit 0 -> ok (stdout shown in transcript)
10
- // exit 2 -> blocking error (stderr fed back to Claude to fix)
11
- // A non-.cml edit / missing file / unparseable payload all exit 0.
12
- //
13
- // Bootstrap installs Context Mapper CLI 6.12+ into ~/.context-mapper-cli/ (Java
14
- // 8+ required) on first run. The run path is unified (java -classpath <lib>/*
15
- // MainClass); only archive extraction branches by platform. Override the
16
- // install location with CONTEXT_MAPPER_HOME.
17
-
18
- const os = require('os');
19
- const path = require('path');
20
- const fs = require('fs');
21
- const { spawnSync } = require('child_process');
22
-
23
- const VERSION = '6.12.0';
24
- const MAIN_CLASS = 'org.contextmapper.cli.ContextMapperCLI';
25
- const isWin = process.platform === 'win32';
26
- const installDir = process.env.CONTEXT_MAPPER_HOME || path.join(os.homedir(), '.context-mapper-cli');
27
- const distDir = path.join(installDir, `context-mapper-cli-${VERSION}`);
28
- const libDir = path.join(distDir, 'lib');
29
-
30
- function fail(code, msg) {
31
- process.stderr.write(msg + '\n');
32
- process.exit(code);
33
- }
34
-
35
- function isInstalled() {
36
- try {
37
- return fs.readdirSync(libDir).some((f) => f.endsWith('.jar'));
38
- } catch {
39
- return false;
40
- }
41
- }
42
-
43
- function hasJava() {
44
- const r = spawnSync('java', ['-version'], { stdio: 'ignore' });
45
- return !r.error && r.status === 0;
46
- }
47
-
48
- async function bootstrap() {
49
- if (!hasJava()) fail(2, 'Java 8+ is required (e.g. Temurin LTS). Install Java, then retry.');
50
-
51
- process.stderr.write(`Bootstrapping Context Mapper CLI ${VERSION} into ${installDir} ...\n`);
52
- fs.mkdirSync(installDir, { recursive: true });
53
-
54
- // Extraction must be platform-specific: Windows `tar` (Git's GNU tar) cannot
55
- // read .zip and mangles `C:\` paths as remote host:path, so we use the .zip +
56
- // Expand-Archive there, and the .tar + `tar` on macOS/Linux. The run path
57
- // (java -classpath) stays unified.
58
- const ext = isWin ? 'zip' : 'tar';
59
- const archive = path.join(installDir, `cli-${VERSION}.${ext}`);
60
- const url = `https://repo1.maven.org/maven2/org/contextmapper/context-mapper-cli/${VERSION}/context-mapper-cli-${VERSION}.${ext}`;
61
-
62
- let res;
63
- try {
64
- res = await fetch(url);
65
- } catch (e) {
66
- fail(3, `Download failed: ${e.message}\nURL: ${url}`);
67
- }
68
- if (!res.ok) fail(3, `Download failed: HTTP ${res.status}\nURL: ${url}`);
69
- fs.writeFileSync(archive, Buffer.from(await res.arrayBuffer()));
70
-
71
- const ex = isWin
72
- ? spawnSync('powershell.exe', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
73
- `Expand-Archive -LiteralPath '${archive}' -DestinationPath '${installDir}' -Force`], { stdio: 'inherit' })
74
- : spawnSync('tar', ['-xf', archive, '-C', installDir], { stdio: 'inherit' });
75
- if (ex.error || ex.status !== 0) {
76
- fail(4, `Extraction failed. Inspect ${installDir} manually.`);
77
- }
78
- fs.rmSync(archive, { force: true });
79
-
80
- if (!isInstalled()) fail(4, `Bootstrap failed: no jars under ${libDir} after extract. Inspect ${installDir} manually.`);
81
- }
82
-
83
- // Run the CLI's main class and capture its output. The JVM expands the `lib/*`
84
- // wildcard itself, so we pass it as one literal classpath entry (no shell -> no
85
- // shell glob expansion).
86
- function runJava(args, cwd) {
87
- const classpath = path.join(libDir, '*');
88
- const res = spawnSync('java', ['-classpath', classpath, MAIN_CLASS, ...args], {
89
- cwd,
90
- stdio: 'pipe',
91
- encoding: 'utf8',
92
- });
93
- if (res.error) {
94
- if (res.error.code === 'ENOENT') fail(2, 'Java 8+ is required (e.g. Temurin LTS). Install Java, then retry.');
95
- fail(1, `Failed to launch java: ${res.error.message}`);
96
- }
97
- return res;
98
- }
99
-
100
- // --- Hook mode: validate the .cml named in a PostToolUse stdin payload -------
101
- function runHook() {
102
- let raw = '';
103
- try {
104
- raw = fs.readFileSync(0, 'utf8'); // fd 0 = stdin
105
- } catch {
106
- process.exit(0);
107
- }
108
- if (!raw.trim()) process.exit(0);
109
-
110
- let payload;
111
- try {
112
- payload = JSON.parse(raw);
113
- } catch {
114
- process.exit(0); // nothing actionable
115
- }
116
-
117
- const filePath = payload?.tool_input?.file_path;
118
- if (!filePath || !/\.cml$/i.test(filePath) || !fs.existsSync(filePath)) {
119
- process.exit(0);
120
- }
121
-
122
- const name = path.basename(filePath);
123
- // cwd = the file's directory so the bare filename resolves (relative-path gotcha).
124
- const res = runJava(['validate', '-i', name], path.dirname(filePath));
125
- const output = `${res.stdout || ''}${res.stderr || ''}`.trim();
126
-
127
- // Two failure modes: parse failures throw a Java exception and exit non-zero;
128
- // semantic-validation failures print uppercase "ERROR ..." lines (possibly
129
- // while still exiting 0). Match ERROR case-sensitively so the success line
130
- // ("...without errors.") is not a false positive; WARNING lines (intentional
131
- // ACL, or JVM sun.misc.Unsafe deprecation noise) are allowed.
132
- const hasErrorLine = output.split(/\r?\n/).some((l) => /ERROR/.test(l));
133
-
134
- if (res.status !== 0 || hasErrorLine) {
135
- process.stderr.write(`CML validation FAILED for ${name}\n${output}\n`);
136
- process.exit(2);
137
- }
138
- process.stdout.write(`CML validation passed for ${name}\n${output}\n`);
139
- process.exit(0);
140
- }
141
-
142
- (async () => {
143
- if (!isInstalled()) await bootstrap();
144
- runHook();
145
- })();
1
+ #!/usr/bin/env node
2
+ // PostToolUse validation hook for Context Mapper `.cml` files (cross-platform).
3
+ //
4
+ // .claude/settings.json calls this as `node validate-cml-hook.js` after every
5
+ // Write/Edit. It
6
+ // reads the PostToolUse payload from stdin, and if the edited file is a .cml,
7
+ // validates it with the Context Mapper CLI and speaks the hook exit-code
8
+ // contract:
9
+ // exit 0 -> ok (stdout shown in transcript)
10
+ // exit 2 -> blocking error (stderr fed back to Claude to fix)
11
+ // A non-.cml edit / missing file / unparseable payload all exit 0.
12
+ //
13
+ // Bootstrap installs Context Mapper CLI 6.12+ into ~/.context-mapper-cli/ (Java
14
+ // 8+ required) on first run. The run path is unified (java -classpath <lib>/*
15
+ // MainClass); only archive extraction branches by platform. Override the
16
+ // install location with CONTEXT_MAPPER_HOME.
17
+
18
+ const os = require('os');
19
+ const path = require('path');
20
+ const fs = require('fs');
21
+ const { spawnSync } = require('child_process');
22
+
23
+ const VERSION = '6.12.0';
24
+ const MAIN_CLASS = 'org.contextmapper.cli.ContextMapperCLI';
25
+ const isWin = process.platform === 'win32';
26
+ const installDir = process.env.CONTEXT_MAPPER_HOME || path.join(os.homedir(), '.context-mapper-cli');
27
+ const distDir = path.join(installDir, `context-mapper-cli-${VERSION}`);
28
+ const libDir = path.join(distDir, 'lib');
29
+
30
+ function fail(code, msg) {
31
+ process.stderr.write(msg + '\n');
32
+ process.exit(code);
33
+ }
34
+
35
+ function isInstalled() {
36
+ try {
37
+ return fs.readdirSync(libDir).some((f) => f.endsWith('.jar'));
38
+ } catch {
39
+ return false;
40
+ }
41
+ }
42
+
43
+ function hasJava() {
44
+ const r = spawnSync('java', ['-version'], { stdio: 'ignore' });
45
+ return !r.error && r.status === 0;
46
+ }
47
+
48
+ async function bootstrap() {
49
+ if (!hasJava()) fail(2, 'Java 8+ is required (e.g. Temurin LTS). Install Java, then retry.');
50
+
51
+ process.stderr.write(`Bootstrapping Context Mapper CLI ${VERSION} into ${installDir} ...\n`);
52
+ fs.mkdirSync(installDir, { recursive: true });
53
+
54
+ // Extraction must be platform-specific: Windows `tar` (Git's GNU tar) cannot
55
+ // read .zip and mangles `C:\` paths as remote host:path, so we use the .zip +
56
+ // Expand-Archive there, and the .tar + `tar` on macOS/Linux. The run path
57
+ // (java -classpath) stays unified.
58
+ const ext = isWin ? 'zip' : 'tar';
59
+ const archive = path.join(installDir, `cli-${VERSION}.${ext}`);
60
+ const url = `https://repo1.maven.org/maven2/org/contextmapper/context-mapper-cli/${VERSION}/context-mapper-cli-${VERSION}.${ext}`;
61
+
62
+ let res;
63
+ try {
64
+ res = await fetch(url);
65
+ } catch (e) {
66
+ fail(3, `Download failed: ${e.message}\nURL: ${url}`);
67
+ }
68
+ if (!res.ok) fail(3, `Download failed: HTTP ${res.status}\nURL: ${url}`);
69
+ fs.writeFileSync(archive, Buffer.from(await res.arrayBuffer()));
70
+
71
+ const ex = isWin
72
+ ? spawnSync('powershell.exe', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
73
+ `Expand-Archive -LiteralPath '${archive}' -DestinationPath '${installDir}' -Force`], { stdio: 'inherit' })
74
+ : spawnSync('tar', ['-xf', archive, '-C', installDir], { stdio: 'inherit' });
75
+ if (ex.error || ex.status !== 0) {
76
+ fail(4, `Extraction failed. Inspect ${installDir} manually.`);
77
+ }
78
+ fs.rmSync(archive, { force: true });
79
+
80
+ if (!isInstalled()) fail(4, `Bootstrap failed: no jars under ${libDir} after extract. Inspect ${installDir} manually.`);
81
+ }
82
+
83
+ // Run the CLI's main class and capture its output. The JVM expands the `lib/*`
84
+ // wildcard itself, so we pass it as one literal classpath entry (no shell -> no
85
+ // shell glob expansion).
86
+ function runJava(args, cwd) {
87
+ const classpath = path.join(libDir, '*');
88
+ const res = spawnSync('java', ['-classpath', classpath, MAIN_CLASS, ...args], {
89
+ cwd,
90
+ stdio: 'pipe',
91
+ encoding: 'utf8',
92
+ });
93
+ if (res.error) {
94
+ if (res.error.code === 'ENOENT') fail(2, 'Java 8+ is required (e.g. Temurin LTS). Install Java, then retry.');
95
+ fail(1, `Failed to launch java: ${res.error.message}`);
96
+ }
97
+ return res;
98
+ }
99
+
100
+ // --- Hook mode: validate the .cml named in a PostToolUse stdin payload -------
101
+ function runHook() {
102
+ let raw = '';
103
+ try {
104
+ raw = fs.readFileSync(0, 'utf8'); // fd 0 = stdin
105
+ } catch {
106
+ process.exit(0);
107
+ }
108
+ if (!raw.trim()) process.exit(0);
109
+
110
+ let payload;
111
+ try {
112
+ payload = JSON.parse(raw);
113
+ } catch {
114
+ process.exit(0); // nothing actionable
115
+ }
116
+
117
+ const filePath = payload?.tool_input?.file_path;
118
+ if (!filePath || !/\.cml$/i.test(filePath) || !fs.existsSync(filePath)) {
119
+ process.exit(0);
120
+ }
121
+
122
+ const name = path.basename(filePath);
123
+ // cwd = the file's directory so the bare filename resolves (relative-path gotcha).
124
+ const res = runJava(['validate', '-i', name], path.dirname(filePath));
125
+ const output = `${res.stdout || ''}${res.stderr || ''}`.trim();
126
+
127
+ // Two failure modes: parse failures throw a Java exception and exit non-zero;
128
+ // semantic-validation failures print uppercase "ERROR ..." lines (possibly
129
+ // while still exiting 0). Match ERROR case-sensitively so the success line
130
+ // ("...without errors.") is not a false positive; WARNING lines (intentional
131
+ // ACL, or JVM sun.misc.Unsafe deprecation noise) are allowed.
132
+ const hasErrorLine = output.split(/\r?\n/).some((l) => /ERROR/.test(l));
133
+
134
+ if (res.status !== 0 || hasErrorLine) {
135
+ process.stderr.write(`CML validation FAILED for ${name}\n${output}\n`);
136
+ process.exit(2);
137
+ }
138
+ process.stdout.write(`CML validation passed for ${name}\n${output}\n`);
139
+ process.exit(0);
140
+ }
141
+
142
+ (async () => {
143
+ if (!isInstalled()) await bootstrap();
144
+ runHook();
145
+ })();
@@ -1,48 +1,48 @@
1
- ---
2
- name: adr-writer
3
- description: Write and manage Architecture Decision Records (ADRs) following structured methodology with proper numbering, status tracking, governance, and conversational writing style.
4
- ---
5
-
6
- # ADR Writer
7
-
8
- Write Architecture Decision Records — the log of "architecturally significant" decisions affecting structure, non-functional characteristics, dependencies, interfaces, or construction techniques.
9
-
10
- **Scope:** Create, update, and supersede ADRs. Does NOT implement the decisions themselves.
11
-
12
- ## Workflow
13
-
14
- 1. **Read the context.** `docs/architecture-characteristics.md` — every Decision is justified against these, with trade-offs framed as which are favored vs. sacrificed. If it is missing, read `.claude/skills/architecture-characteristic-writer/SKILL.md` and use its questions to gather the driving characteristics from the user before going on. Then read `docs/adr/README.md` for the decisions already recorded — one ADR's Consequences are often the next one's Context.
15
-
16
- 2. **Research before suggesting** — REQUIRED whenever a technology, vendor, product, version, or price is in play. Invoke `/research`; never propose options from memory, it goes stale. Confirm each option still exists and is supported today. Report in one pass, source and verdict per option.
17
-
18
- 3. **Challenge the proposal — be harsh.** REQUIRED whenever the user proposes a specific option. Do not rubber-stamp it:
19
- - **State why** — the concrete reasons, not familiarity or preference.
20
- - **Score it against each driving and implicit characteristic** — does it *serve*, *ignore*, or *actively harm* it?
21
- - **Give a verdict** — suitable / suitable-with-trade-offs / unsuitable. If it conflicts with a driving characteristic, say so plainly and recommend the better fit, even when that is not what was asked for.
22
- - Continue only once it survives, or the user overrides knowing the trade-off — record that override as a Consequence.
23
-
24
- 4. **Create the file.** From the repo root:
25
- ```bash
26
- adr new -q -- "Use X for Z"
27
- ```
28
- - `-q` is required on every call. Without it an ambiguous `-s` prompts on stdin and hangs the session; with it, that case errors instead.
29
- - `adr new` prints nothing. Run `adr list` (last line is the new file) or read `docs/adr/README.md` — never guess the number or slug.
30
- - Never use uppercase `STATUS` in a title. It is substituted after the title is inserted, so "Use STATUS codes" silently becomes "Use Accepted codes" and leaves the real Status unset. Lowercase is fine.
31
- - Superseding — always the full padded stem, never a bare number. `-s` matches by substring: with `-q` an *ambiguous* match errors, but a single *wrong* match still succeeds silently. Writes the cross-link into both ADRs' `## Status`:
32
- ```bash
33
- adr new -q -s 0002-use-mysql-for-persistence -- "…"
34
- ```
35
-
36
- 5. **Write the ADR.** Replace every `{…}` placeholder — nothing else. `adr new` has already written the number, title, `Accepted` status, and any supersede/link lines; leave all of them alone. Section Guidance below covers what each section needs. An Accepted ADR is immutable — to change it, write a new ADR that supersedes it.
37
-
38
- ## Writing Style
39
-
40
- - **Calibrate against `references/adr-example.md`** — re-read it before drafting; it is the target for terseness. Cut any section markedly longer than its equivalent.
41
- - **Match `references/adr-template.md` exactly.** Use only the sections it defines. No invented sections or fields; research citations go inline in the Decision.
42
-
43
- ## Section Guidance
44
-
45
- - **Title** — reveal the *decision*, not the topic: "Use X for Z". Bad: "Gmail Polling for Ingestion". Good: "Use Cloud Scheduler Polling for Gmail Ingestion".
46
- - **Context** — value-neutral, tensions explicit. No alternatives here, and no notes about what is *not* being decided.
47
- - **Decision** — record the WHY, not the HOW — omit libraries, drivers, and wiring.
48
- - **Consequences** — both `### Positive` and `### Negative` required. Consider team, infrastructure, cost, and one-way doors.
1
+ ---
2
+ name: adr-writer
3
+ description: Write and manage Architecture Decision Records (ADRs) following structured methodology with proper numbering, status tracking, governance, and conversational writing style.
4
+ ---
5
+
6
+ # ADR Writer
7
+
8
+ Write Architecture Decision Records — the log of "architecturally significant" decisions affecting structure, non-functional characteristics, dependencies, interfaces, or construction techniques.
9
+
10
+ **Scope:** Create, update, and supersede ADRs. Does NOT implement the decisions themselves.
11
+
12
+ ## Workflow
13
+
14
+ 1. **Read the context.** `docs/architecture-characteristics.md` — every Decision is justified against these, with trade-offs framed as which are favored vs. sacrificed. If it is missing, read `.claude/skills/architecture-characteristic-writer/SKILL.md` and use its questions to gather the driving characteristics from the user before going on. Then read `docs/adr/README.md` for the decisions already recorded — one ADR's Consequences are often the next one's Context.
15
+
16
+ 2. **Research before suggesting** — REQUIRED whenever a technology, vendor, product, version, or price is in play. Invoke `/research`; never propose options from memory, it goes stale. Confirm each option still exists and is supported today. Report in one pass, source and verdict per option.
17
+
18
+ 3. **Challenge the proposal — be harsh.** REQUIRED whenever the user proposes a specific option. Do not rubber-stamp it:
19
+ - **State why** — the concrete reasons, not familiarity or preference.
20
+ - **Score it against each driving and implicit characteristic** — does it *serve*, *ignore*, or *actively harm* it?
21
+ - **Give a verdict** — suitable / suitable-with-trade-offs / unsuitable. If it conflicts with a driving characteristic, say so plainly and recommend the better fit, even when that is not what was asked for.
22
+ - Continue only once it survives, or the user overrides knowing the trade-off — record that override as a Consequence.
23
+
24
+ 4. **Create the file.** From the repo root:
25
+ ```bash
26
+ adr new -q -- "Use X for Z"
27
+ ```
28
+ - `-q` is required on every call. Without it an ambiguous `-s` prompts on stdin and hangs the session; with it, that case errors instead.
29
+ - `adr new` prints nothing. Run `adr list` (last line is the new file) or read `docs/adr/README.md` — never guess the number or slug.
30
+ - Never use uppercase `STATUS` in a title. It is substituted after the title is inserted, so "Use STATUS codes" silently becomes "Use Accepted codes" and leaves the real Status unset. Lowercase is fine.
31
+ - Superseding — always the full padded stem, never a bare number. `-s` matches by substring: with `-q` an *ambiguous* match errors, but a single *wrong* match still succeeds silently. Writes the cross-link into both ADRs' `## Status`:
32
+ ```bash
33
+ adr new -q -s 0002-use-mysql-for-persistence -- "…"
34
+ ```
35
+
36
+ 5. **Write the ADR.** Replace every `{…}` placeholder — nothing else. `adr new` has already written the number, title, `Accepted` status, and any supersede/link lines; leave all of them alone. Section Guidance below covers what each section needs. An Accepted ADR is immutable — to change it, write a new ADR that supersedes it.
37
+
38
+ ## Writing Style
39
+
40
+ - **Calibrate against `references/adr-example.md`** — re-read it before drafting; it is the target for terseness. Cut any section markedly longer than its equivalent.
41
+ - **Match `references/adr-template.md` exactly.** Use only the sections it defines. No invented sections or fields; research citations go inline in the Decision.
42
+
43
+ ## Section Guidance
44
+
45
+ - **Title** — reveal the *decision*, not the topic: "Use X for Z". Bad: "Gmail Polling for Ingestion". Good: "Use Cloud Scheduler Polling for Gmail Ingestion".
46
+ - **Context** — value-neutral, tensions explicit. No alternatives here, and no notes about what is *not* being decided.
47
+ - **Decision** — record the WHY, not the HOW — omit libraries, drivers, and wiring.
48
+ - **Consequences** — both `### Positive` and `### Negative` required. Consider team, infrastructure, cost, and one-way doors.
@@ -1,35 +1,35 @@
1
- # ADR Example
2
-
3
- Reference example of a well-written ADR.
4
-
5
- Filename: docs/adr/0012-use-of-queues-for-asynchronous-messaging-between-order-and-downstream-services.md — heading number unpadded, filename four-digit padded.
6
-
7
- ```markdown
8
- # 12: Use of Queues for Asynchronous Messaging Between Order and Downstream Services
9
-
10
- ## Status
11
- Accepted
12
-
13
- ## Context
14
- The trading service must inform downstream services (namely the notification and analytics services, for now) about new items available for sale and about all transactions. This can be done through synchronous messaging (using REST) or asynchronous messaging (using queues or topics).
15
-
16
- ## Decision
17
- We will use queues for asynchronous messaging between the trading and downstream services.
18
-
19
- Using queues makes the system more extensible, since each queue can deliver a different kind of message. Furthermore, since the trading service is acutely aware of any and all subscribers, adding a new consumer involves modifying it — which improves the security of the system.
20
-
21
- ## Consequences
22
-
23
- ### Positive
24
- - System is more extensible via separate queues per message type
25
- - Security improved — trading service controls subscriber access
26
-
27
- ### Negative
28
- - Higher degree of coupling between services
29
- - Queuing infrastructure must be provisioned and clustered for HA
30
- - Adding new downstream services requires modifications to trading service
31
-
32
- ## Governance
33
- - Code reviews on all queue consumer/producer changes
34
- - Infrastructure monitoring for queue health and message delivery
35
-
1
+ # ADR Example
2
+
3
+ Reference example of a well-written ADR.
4
+
5
+ Filename: docs/adr/0012-use-of-queues-for-asynchronous-messaging-between-order-and-downstream-services.md — heading number unpadded, filename four-digit padded.
6
+
7
+ ```markdown
8
+ # 12: Use of Queues for Asynchronous Messaging Between Order and Downstream Services
9
+
10
+ ## Status
11
+ Accepted
12
+
13
+ ## Context
14
+ The trading service must inform downstream services (namely the notification and analytics services, for now) about new items available for sale and about all transactions. This can be done through synchronous messaging (using REST) or asynchronous messaging (using queues or topics).
15
+
16
+ ## Decision
17
+ We will use queues for asynchronous messaging between the trading and downstream services.
18
+
19
+ Using queues makes the system more extensible, since each queue can deliver a different kind of message. Furthermore, since the trading service is acutely aware of any and all subscribers, adding a new consumer involves modifying it — which improves the security of the system.
20
+
21
+ ## Consequences
22
+
23
+ ### Positive
24
+ - System is more extensible via separate queues per message type
25
+ - Security improved — trading service controls subscriber access
26
+
27
+ ### Negative
28
+ - Higher degree of coupling between services
29
+ - Queuing infrastructure must be provisioned and clustered for HA
30
+ - Adding new downstream services requires modifications to trading service
31
+
32
+ ## Governance
33
+ - Code reviews on all queue consumer/producer changes
34
+ - Infrastructure monitoring for queue health and message delivery
35
+