@rune-kit/rune 2.10.0 → 2.12.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 (240) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +65 -6
  3. package/commands/rune.md +168 -168
  4. package/compiler/__tests__/detect-invariants.test.js +136 -0
  5. package/compiler/__tests__/doctor-mesh.test.js +229 -0
  6. package/compiler/__tests__/hook-dispatch.test.js +91 -0
  7. package/compiler/__tests__/hooks-antigravity.test.js +118 -0
  8. package/compiler/__tests__/hooks-cursor.test.js +139 -0
  9. package/compiler/__tests__/hooks-install.test.js +305 -0
  10. package/compiler/__tests__/hooks-merge.test.js +204 -0
  11. package/compiler/__tests__/hooks-tiers.test.js +519 -0
  12. package/compiler/__tests__/hooks-windsurf.test.js +115 -0
  13. package/compiler/__tests__/inject-claude-md.test.js +152 -0
  14. package/compiler/__tests__/load-invariants.test.js +408 -0
  15. package/compiler/__tests__/onboard-invariants.test.js +240 -0
  16. package/compiler/adapters/hooks/antigravity.js +140 -0
  17. package/compiler/adapters/hooks/claude.js +166 -0
  18. package/compiler/adapters/hooks/cursor.js +191 -0
  19. package/compiler/adapters/hooks/index.js +82 -0
  20. package/compiler/adapters/hooks/tier-emitter.js +182 -0
  21. package/compiler/adapters/hooks/windsurf.js +202 -0
  22. package/compiler/bin/rune.js +196 -6
  23. package/compiler/commands/hook-dispatch.js +87 -0
  24. package/compiler/commands/hooks/install.js +120 -0
  25. package/compiler/commands/hooks/merge.js +211 -0
  26. package/compiler/commands/hooks/presets.js +116 -0
  27. package/compiler/commands/hooks/status.js +112 -0
  28. package/compiler/commands/hooks/tiers.js +221 -0
  29. package/compiler/commands/hooks/uninstall.js +94 -0
  30. package/compiler/doctor.js +236 -0
  31. package/contexts/dev.md +34 -34
  32. package/contexts/research.md +43 -43
  33. package/contexts/review.md +55 -55
  34. package/extensions/ai-ml/PACK.md +88 -88
  35. package/extensions/ai-ml/skills/ai-agents.md +172 -172
  36. package/extensions/ai-ml/skills/code-sandbox.md +187 -187
  37. package/extensions/ai-ml/skills/deep-research.md +146 -146
  38. package/extensions/ai-ml/skills/embedding-search.md +66 -66
  39. package/extensions/ai-ml/skills/fine-tuning-guide.md +74 -74
  40. package/extensions/ai-ml/skills/llm-architect.md +125 -125
  41. package/extensions/ai-ml/skills/llm-integration.md +64 -64
  42. package/extensions/ai-ml/skills/prompt-patterns.md +72 -72
  43. package/extensions/ai-ml/skills/rag-patterns.md +66 -66
  44. package/extensions/ai-ml/skills/web-extraction.md +114 -114
  45. package/extensions/analytics/PACK.md +92 -92
  46. package/extensions/analytics/skills/ab-testing.md +72 -72
  47. package/extensions/analytics/skills/dashboard-patterns.md +83 -83
  48. package/extensions/analytics/skills/data-validation.md +68 -68
  49. package/extensions/analytics/skills/funnel-analysis.md +81 -81
  50. package/extensions/analytics/skills/sql-patterns.md +57 -57
  51. package/extensions/analytics/skills/statistical-analysis.md +79 -79
  52. package/extensions/analytics/skills/tracking-setup.md +71 -71
  53. package/extensions/backend/PACK.md +104 -104
  54. package/extensions/backend/skills/api-patterns.md +84 -84
  55. package/extensions/backend/skills/async-pipeline.md +193 -193
  56. package/extensions/backend/skills/auth-patterns.md +97 -97
  57. package/extensions/backend/skills/background-jobs.md +133 -133
  58. package/extensions/backend/skills/caching-patterns.md +108 -108
  59. package/extensions/backend/skills/cli-generation.md +133 -133
  60. package/extensions/backend/skills/database-patterns.md +87 -87
  61. package/extensions/backend/skills/middleware-patterns.md +104 -104
  62. package/extensions/chrome-ext/PACK.md +93 -93
  63. package/extensions/chrome-ext/skills/cws-preflight.md +143 -143
  64. package/extensions/chrome-ext/skills/cws-publish.md +104 -104
  65. package/extensions/chrome-ext/skills/ext-ai-integration.md +251 -251
  66. package/extensions/chrome-ext/skills/ext-messaging.md +139 -139
  67. package/extensions/chrome-ext/skills/ext-storage.md +133 -133
  68. package/extensions/chrome-ext/skills/mv3-scaffold.md +164 -164
  69. package/extensions/content/PACK.md +96 -96
  70. package/extensions/content/skills/blog-patterns.md +88 -88
  71. package/extensions/content/skills/cms-integration.md +131 -131
  72. package/extensions/content/skills/content-scoring.md +107 -107
  73. package/extensions/content/skills/i18n.md +83 -83
  74. package/extensions/content/skills/mdx-authoring.md +137 -137
  75. package/extensions/content/skills/reference.md +1014 -1014
  76. package/extensions/content/skills/seo-patterns.md +67 -67
  77. package/extensions/content/skills/video-repurpose.md +153 -153
  78. package/extensions/devops/PACK.md +101 -101
  79. package/extensions/devops/skills/chaos-testing.md +67 -67
  80. package/extensions/devops/skills/ci-cd.md +75 -75
  81. package/extensions/devops/skills/docker.md +58 -58
  82. package/extensions/devops/skills/edge-serverless.md +163 -163
  83. package/extensions/devops/skills/infra-as-code.md +158 -158
  84. package/extensions/devops/skills/kubernetes.md +110 -110
  85. package/extensions/devops/skills/monitoring.md +57 -57
  86. package/extensions/devops/skills/server-setup.md +64 -64
  87. package/extensions/devops/skills/ssl-domain.md +42 -42
  88. package/extensions/ecommerce/PACK.md +116 -116
  89. package/extensions/ecommerce/skills/cart-system.md +79 -79
  90. package/extensions/ecommerce/skills/inventory-mgmt.md +102 -102
  91. package/extensions/ecommerce/skills/order-management.md +126 -126
  92. package/extensions/ecommerce/skills/payment-integration.md +472 -472
  93. package/extensions/ecommerce/skills/shopify-dev.md +69 -69
  94. package/extensions/ecommerce/skills/subscription-billing.md +93 -93
  95. package/extensions/ecommerce/skills/tax-compliance.md +117 -117
  96. package/extensions/gamedev/PACK.md +142 -142
  97. package/extensions/gamedev/skills/asset-pipeline.md +74 -74
  98. package/extensions/gamedev/skills/audio-system.md +129 -129
  99. package/extensions/gamedev/skills/camera-system.md +87 -87
  100. package/extensions/gamedev/skills/ecs.md +98 -98
  101. package/extensions/gamedev/skills/game-loops.md +72 -72
  102. package/extensions/gamedev/skills/input-system.md +199 -199
  103. package/extensions/gamedev/skills/multiplayer.md +180 -180
  104. package/extensions/gamedev/skills/particles.md +105 -105
  105. package/extensions/gamedev/skills/physics-engine.md +89 -89
  106. package/extensions/gamedev/skills/scene-management.md +146 -146
  107. package/extensions/gamedev/skills/threejs-patterns.md +90 -90
  108. package/extensions/gamedev/skills/webgl.md +71 -71
  109. package/extensions/mobile/PACK.md +106 -106
  110. package/extensions/mobile/skills/app-store-connect.md +152 -152
  111. package/extensions/mobile/skills/app-store-prep.md +66 -66
  112. package/extensions/mobile/skills/deep-linking.md +109 -109
  113. package/extensions/mobile/skills/flutter.md +60 -60
  114. package/extensions/mobile/skills/ios-build-pipeline.md +142 -142
  115. package/extensions/mobile/skills/native-bridge.md +66 -66
  116. package/extensions/mobile/skills/ota-updates.md +97 -97
  117. package/extensions/mobile/skills/push-notifications.md +111 -111
  118. package/extensions/mobile/skills/react-native.md +82 -82
  119. package/extensions/saas/PACK.md +116 -116
  120. package/extensions/saas/skills/billing-integration.md +200 -200
  121. package/extensions/saas/skills/feature-flags.md +130 -130
  122. package/extensions/saas/skills/multi-tenant.md +103 -103
  123. package/extensions/saas/skills/onboarding-flow.md +139 -139
  124. package/extensions/saas/skills/subscription-flow.md +95 -95
  125. package/extensions/saas/skills/team-management.md +144 -144
  126. package/extensions/security/PACK.md +99 -99
  127. package/extensions/security/skills/api-security.md +140 -140
  128. package/extensions/security/skills/compliance.md +68 -68
  129. package/extensions/security/skills/owasp-audit.md +64 -64
  130. package/extensions/security/skills/pentest-patterns.md +77 -77
  131. package/extensions/security/skills/secret-mgmt.md +65 -65
  132. package/extensions/security/skills/supply-chain.md +65 -65
  133. package/extensions/trading/PACK.md +80 -80
  134. package/extensions/trading/skills/chart-components.md +55 -55
  135. package/extensions/trading/skills/experiment-loop.md +125 -125
  136. package/extensions/trading/skills/fintech-patterns.md +47 -47
  137. package/extensions/trading/skills/indicator-library.md +58 -58
  138. package/extensions/trading/skills/quant-analysis.md +111 -111
  139. package/extensions/trading/skills/realtime-data.md +58 -58
  140. package/extensions/trading/skills/trade-logic.md +104 -104
  141. package/extensions/ui/PACK.md +130 -130
  142. package/extensions/ui/skills/a11y-audit.md +91 -91
  143. package/extensions/ui/skills/animation-patterns.md +127 -127
  144. package/extensions/ui/skills/component-patterns.md +100 -100
  145. package/extensions/ui/skills/design-decision.md +108 -108
  146. package/extensions/ui/skills/design-system.md +68 -68
  147. package/extensions/ui/skills/landing-patterns.md +155 -155
  148. package/extensions/ui/skills/palette-picker.md +173 -173
  149. package/extensions/ui/skills/react-health.md +90 -90
  150. package/extensions/ui/skills/type-system.md +125 -125
  151. package/extensions/ui/skills/web-vitals.md +153 -153
  152. package/extensions/zalo/PACK.md +145 -145
  153. package/extensions/zalo/skills/zalo-oa-mcp.md +317 -317
  154. package/extensions/zalo/skills/zalo-oa-messaging.md +429 -429
  155. package/extensions/zalo/skills/zalo-oa-setup.md +236 -236
  156. package/extensions/zalo/skills/zalo-oa-webhook.md +189 -189
  157. package/extensions/zalo/skills/zalo-personal-messaging.md +194 -194
  158. package/extensions/zalo/skills/zalo-personal-setup.md +153 -153
  159. package/extensions/zalo/skills/zalo-rate-guard.md +219 -219
  160. package/hooks/auto-format/index.cjs +48 -48
  161. package/hooks/hooks.json +111 -111
  162. package/hooks/post-session-reflect/index.cjs +189 -189
  163. package/hooks/pre-compact/index.cjs +95 -95
  164. package/hooks/run-hook.cmd +1 -1
  165. package/hooks/secrets-scan/index.cjs +100 -100
  166. package/hooks/session-start/index.cjs +71 -71
  167. package/hooks/typecheck/index.cjs +65 -65
  168. package/package.json +63 -63
  169. package/references/ui-pro-max-data/LICENSE-UI-PRO-MAX +21 -21
  170. package/references/ui-pro-max-data/charts.csv +26 -26
  171. package/references/ui-pro-max-data/colors.csv +161 -161
  172. package/references/ui-pro-max-data/styles.csv +68 -68
  173. package/references/ui-pro-max-data/typography.csv +74 -74
  174. package/references/ui-pro-max-data/ui-reasoning.csv +162 -162
  175. package/references/ui-pro-max-data/ux-guidelines.csv +99 -99
  176. package/skills/adversary/SKILL.md +283 -283
  177. package/skills/asset-creator/SKILL.md +157 -157
  178. package/skills/audit/SKILL.md +147 -2
  179. package/skills/autopsy/SKILL.md +335 -335
  180. package/skills/ba/SKILL.md +85 -1
  181. package/skills/brainstorm/SKILL.md +380 -342
  182. package/skills/browser-pilot/SKILL.md +169 -168
  183. package/skills/constraint-check/SKILL.md +165 -165
  184. package/skills/context-engine/SKILL.md +408 -404
  185. package/skills/cook/SKILL.md +917 -863
  186. package/skills/db/SKILL.md +273 -273
  187. package/skills/debug/SKILL.md +465 -465
  188. package/skills/dependency-doctor/SKILL.md +265 -235
  189. package/skills/deploy/SKILL.md +274 -231
  190. package/skills/design/DESIGN-REFERENCE.md +365 -365
  191. package/skills/design/SKILL.md +590 -589
  192. package/skills/doc-processor/SKILL.md +254 -254
  193. package/skills/docs/SKILL.md +374 -374
  194. package/skills/docs-seeker/SKILL.md +178 -177
  195. package/skills/fix/SKILL.md +332 -330
  196. package/skills/git/SKILL.md +339 -339
  197. package/skills/hallucination-guard/SKILL.md +220 -219
  198. package/skills/incident/SKILL.md +254 -253
  199. package/skills/integrity-check/SKILL.md +169 -169
  200. package/skills/journal/SKILL.md +241 -240
  201. package/skills/launch/SKILL.md +344 -344
  202. package/skills/logic-guardian/SKILL.md +269 -251
  203. package/skills/marketing/SKILL.md +351 -289
  204. package/skills/mcp-builder/SKILL.md +425 -425
  205. package/skills/neural-memory/SKILL.md +359 -362
  206. package/skills/onboard/SKILL.md +432 -403
  207. package/skills/onboard/references/invariants-template.md +76 -0
  208. package/skills/onboard/scripts/detect-invariants.js +439 -0
  209. package/skills/onboard/scripts/inject-claude-md.js +150 -0
  210. package/skills/onboard/scripts/onboard-invariants.js +194 -0
  211. package/skills/perf/SKILL.md +347 -346
  212. package/skills/plan/SKILL.md +435 -428
  213. package/skills/preflight/SKILL.md +415 -415
  214. package/skills/problem-solver/SKILL.md +380 -284
  215. package/skills/rescue/SKILL.md +474 -474
  216. package/skills/research/SKILL.md +4 -0
  217. package/skills/retro/SKILL.md +3 -1
  218. package/skills/review/SKILL.md +614 -588
  219. package/skills/review-intake/SKILL.md +249 -249
  220. package/skills/safeguard/SKILL.md +200 -200
  221. package/skills/sast/SKILL.md +190 -190
  222. package/skills/scaffold/SKILL.md +328 -287
  223. package/skills/scope-guard/SKILL.md +183 -180
  224. package/skills/scout/SKILL.md +269 -263
  225. package/skills/sentinel/SKILL.md +384 -381
  226. package/skills/sentinel-env/SKILL.md +254 -254
  227. package/skills/sequential-thinking/SKILL.md +234 -234
  228. package/skills/session-bridge/SKILL.md +595 -543
  229. package/skills/session-bridge/scripts/load-invariants.js +397 -0
  230. package/skills/skill-forge/SKILL.md +581 -581
  231. package/skills/skill-router/SKILL.md +3 -0
  232. package/skills/slides/SKILL.md +19 -0
  233. package/skills/surgeon/SKILL.md +215 -215
  234. package/skills/team/SKILL.md +557 -537
  235. package/skills/test/SKILL.md +620 -614
  236. package/skills/trend-scout/SKILL.md +145 -145
  237. package/skills/verification/SKILL.md +334 -326
  238. package/skills/video-creator/SKILL.md +201 -201
  239. package/skills/watchdog/SKILL.md +168 -168
  240. package/skills/worktree/SKILL.md +140 -140
@@ -1,83 +1,83 @@
1
- ---
2
- name: "i18n"
3
- pack: "@rune/content"
4
- description: "Locale routing, translations, hreflang, RTL support, date/number formatting, content translation workflows, language detection."
5
- model: sonnet
6
- tools: [Read, Edit, Write, Grep, Glob, Bash]
7
- ---
8
-
9
- # i18n
10
-
11
- Internationalization — locale routing, translation management, RTL support, date/number formatting, content translation workflows, language detection.
12
-
13
- #### Workflow
14
-
15
- **Step 1 — Detect i18n setup**
16
- Use Grep to find i18n libraries: `next-intl`, `i18next`, `react-intl`, `@formatjs`, `lingui`, `paraglide`. Use Glob to find translation files: `locales/`, `messages/`, `translations/`, `*.json` in locale directories. Read the i18n configuration to understand: supported locales, default locale, routing strategy, and translation loading method.
17
-
18
- **Step 2 — Audit i18n correctness**
19
- Check for: missing translations (keys present in default locale but not in others), no fallback chain (missing key shows raw key to user), locale not in URL (breaks SEO — Google can't index per-locale pages), no `hreflang` tags (search engines don't know about locale variants), hardcoded strings in components (bypassing translation system), date/number formatting without locale context (`toLocaleDateString()` without explicit locale), and no RTL support for Arabic/Hebrew locales.
20
-
21
- **Step 3 — Emit i18n patterns**
22
- Emit: type-safe translation keys with IDE autocomplete, locale routing middleware, `hreflang` tag generator, date/number formatting utilities, missing translation detection script, and RTL-aware layout component.
23
-
24
- #### Example
25
-
26
- ```typescript
27
- // next-intl — type-safe translations with locale routing (Next.js App Router)
28
- // messages/en.json: { "home": { "title": "Welcome", "posts": "Latest {count, plural, one {post} other {posts}}" } }
29
- // messages/vi.json: { "home": { "title": "Chao mung", "posts": "{count} bai viet moi nhat" } }
30
-
31
- // middleware.ts — locale routing
32
- import createMiddleware from 'next-intl/middleware';
33
-
34
- export default createMiddleware({
35
- locales: ['en', 'vi', 'ja'],
36
- defaultLocale: 'en',
37
- localePrefix: 'as-needed', // /en/about → /about (default), /vi/about stays
38
- });
39
-
40
- export const config = { matcher: ['/((?!api|_next|.*\\..*).*)'] };
41
-
42
- // Hreflang tags — app/[locale]/layout.tsx
43
- function HreflangTags({ locale, path }: { locale: string; path: string }) {
44
- const locales = ['en', 'vi', 'ja'];
45
- return (
46
- <>
47
- {locales.map(l => (
48
- <link key={l} rel="alternate" hrefLang={l} href={`${process.env.SITE_URL}/${l}${path}`} />
49
- ))}
50
- <link rel="alternate" hrefLang="x-default" href={`${process.env.SITE_URL}${path}`} />
51
- </>
52
- );
53
- }
54
-
55
- // Type-safe translations in components
56
- import { useTranslations } from 'next-intl';
57
-
58
- function HomePage() {
59
- const t = useTranslations('home');
60
- return <h1>{t('title')}</h1>; // IDE autocomplete for keys
61
- }
62
-
63
- // CI script — detect missing translation keys
64
- // scripts/check-translations.ts
65
- import en from '../messages/en.json';
66
- import vi from '../messages/vi.json';
67
-
68
- function flattenKeys(obj: Record<string, unknown>, prefix = ''): string[] {
69
- return Object.entries(obj).flatMap(([k, v]) =>
70
- typeof v === 'object' && v !== null
71
- ? flattenKeys(v as Record<string, unknown>, `${prefix}${k}.`)
72
- : [`${prefix}${k}`]
73
- );
74
- }
75
-
76
- const enKeys = new Set(flattenKeys(en));
77
- const viKeys = new Set(flattenKeys(vi));
78
- const missing = [...enKeys].filter(k => !viKeys.has(k));
79
- if (missing.length) {
80
- console.error('Missing vi translations:', missing);
81
- process.exit(1);
82
- }
83
- ```
1
+ ---
2
+ name: "i18n"
3
+ pack: "@rune/content"
4
+ description: "Locale routing, translations, hreflang, RTL support, date/number formatting, content translation workflows, language detection."
5
+ model: sonnet
6
+ tools: [Read, Edit, Write, Grep, Glob, Bash]
7
+ ---
8
+
9
+ # i18n
10
+
11
+ Internationalization — locale routing, translation management, RTL support, date/number formatting, content translation workflows, language detection.
12
+
13
+ #### Workflow
14
+
15
+ **Step 1 — Detect i18n setup**
16
+ Use Grep to find i18n libraries: `next-intl`, `i18next`, `react-intl`, `@formatjs`, `lingui`, `paraglide`. Use Glob to find translation files: `locales/`, `messages/`, `translations/`, `*.json` in locale directories. Read the i18n configuration to understand: supported locales, default locale, routing strategy, and translation loading method.
17
+
18
+ **Step 2 — Audit i18n correctness**
19
+ Check for: missing translations (keys present in default locale but not in others), no fallback chain (missing key shows raw key to user), locale not in URL (breaks SEO — Google can't index per-locale pages), no `hreflang` tags (search engines don't know about locale variants), hardcoded strings in components (bypassing translation system), date/number formatting without locale context (`toLocaleDateString()` without explicit locale), and no RTL support for Arabic/Hebrew locales.
20
+
21
+ **Step 3 — Emit i18n patterns**
22
+ Emit: type-safe translation keys with IDE autocomplete, locale routing middleware, `hreflang` tag generator, date/number formatting utilities, missing translation detection script, and RTL-aware layout component.
23
+
24
+ #### Example
25
+
26
+ ```typescript
27
+ // next-intl — type-safe translations with locale routing (Next.js App Router)
28
+ // messages/en.json: { "home": { "title": "Welcome", "posts": "Latest {count, plural, one {post} other {posts}}" } }
29
+ // messages/vi.json: { "home": { "title": "Chao mung", "posts": "{count} bai viet moi nhat" } }
30
+
31
+ // middleware.ts — locale routing
32
+ import createMiddleware from 'next-intl/middleware';
33
+
34
+ export default createMiddleware({
35
+ locales: ['en', 'vi', 'ja'],
36
+ defaultLocale: 'en',
37
+ localePrefix: 'as-needed', // /en/about → /about (default), /vi/about stays
38
+ });
39
+
40
+ export const config = { matcher: ['/((?!api|_next|.*\\..*).*)'] };
41
+
42
+ // Hreflang tags — app/[locale]/layout.tsx
43
+ function HreflangTags({ locale, path }: { locale: string; path: string }) {
44
+ const locales = ['en', 'vi', 'ja'];
45
+ return (
46
+ <>
47
+ {locales.map(l => (
48
+ <link key={l} rel="alternate" hrefLang={l} href={`${process.env.SITE_URL}/${l}${path}`} />
49
+ ))}
50
+ <link rel="alternate" hrefLang="x-default" href={`${process.env.SITE_URL}${path}`} />
51
+ </>
52
+ );
53
+ }
54
+
55
+ // Type-safe translations in components
56
+ import { useTranslations } from 'next-intl';
57
+
58
+ function HomePage() {
59
+ const t = useTranslations('home');
60
+ return <h1>{t('title')}</h1>; // IDE autocomplete for keys
61
+ }
62
+
63
+ // CI script — detect missing translation keys
64
+ // scripts/check-translations.ts
65
+ import en from '../messages/en.json';
66
+ import vi from '../messages/vi.json';
67
+
68
+ function flattenKeys(obj: Record<string, unknown>, prefix = ''): string[] {
69
+ return Object.entries(obj).flatMap(([k, v]) =>
70
+ typeof v === 'object' && v !== null
71
+ ? flattenKeys(v as Record<string, unknown>, `${prefix}${k}.`)
72
+ : [`${prefix}${k}`]
73
+ );
74
+ }
75
+
76
+ const enKeys = new Set(flattenKeys(en));
77
+ const viKeys = new Set(flattenKeys(vi));
78
+ const missing = [...enKeys].filter(k => !viKeys.has(k));
79
+ if (missing.length) {
80
+ console.error('Missing vi translations:', missing);
81
+ process.exit(1);
82
+ }
83
+ ```
@@ -1,137 +1,137 @@
1
- ---
2
- name: "mdx-authoring"
3
- pack: "@rune/content"
4
- description: "Custom components in markdown, code blocks with syntax highlighting, interactive examples, table of contents generation."
5
- model: sonnet
6
- tools: [Read, Edit, Write, Grep, Glob, Bash]
7
- ---
8
-
9
- # mdx-authoring
10
-
11
- MDX authoring patterns — custom components in markdown, code blocks with syntax highlighting, interactive examples, table of contents generation.
12
-
13
- #### Workflow
14
-
15
- **Step 1 — Detect MDX setup**
16
- Use Grep to find MDX configuration: `@next/mdx`, `mdx-bundler`, `next-mdx-remote`, `contentlayer`, `rehype`, `remark`. Read the MDX pipeline config to understand: compilation method, custom components registered, and remark/rehype plugin chain.
17
-
18
- **Step 2 — Audit MDX pipeline**
19
- Check for: no custom component fallback (missing component crashes build), code blocks without syntax highlighting (plain text), no table of contents generation (long articles hard to navigate), missing image optimization in MDX (raw `<img>` tags), no frontmatter validation (typos in dates or categories silently pass), and no interactive component sandboxing.
20
-
21
- **Step 3 — Emit MDX patterns**
22
- Emit: MDX component registry with fallback for missing components, code block with syntax highlighting (Shiki or Prism), auto-generated TOC from headings, frontmatter schema validation, and callout/admonition components.
23
-
24
- #### Example — Component Registry
25
-
26
- ```tsx
27
- // MDX component registry with safe fallback
28
- import { type MDXComponents } from 'mdx/types';
29
- import { Callout } from '@/components/callout';
30
- import { CodeBlock } from '@/components/code-block';
31
- import Image from 'next/image';
32
-
33
- export function useMDXComponents(): MDXComponents {
34
- return {
35
- img: ({ src, alt, ...props }) => (
36
- <Image src={src!} alt={alt || ''} width={800} height={400} className="rounded-lg" {...props} />
37
- ),
38
- pre: ({ children, ...props }) => <CodeBlock {...props}>{children}</CodeBlock>,
39
- Callout,
40
- };
41
- }
42
-
43
- // Auto-generated TOC from MDX content
44
- interface TocItem { id: string; text: string; level: number }
45
-
46
- function extractToc(raw: string): TocItem[] {
47
- const headingRegex = /^(#{2,4})\s+(.+)$/gm;
48
- const items: TocItem[] = [];
49
- let match;
50
- while ((match = headingRegex.exec(raw))) {
51
- const text = match[2].replace(/[`*_~]/g, '');
52
- items.push({ id: text.toLowerCase().replace(/\s+/g, '-'), text, level: match[1].length });
53
- }
54
- return items;
55
- }
56
-
57
- // Callout component for MDX
58
- function Callout({ type = 'info', children }: { type?: 'info' | 'warning' | 'error'; children: React.ReactNode }) {
59
- const styles = { info: 'bg-blue-50 border-blue-400', warning: 'bg-amber-50 border-amber-400', error: 'bg-red-50 border-red-400' };
60
- return <div className={`border-l-4 p-4 my-4 rounded-r ${styles[type]}`}>{children}</div>;
61
- }
62
- ```
63
-
64
- #### Example — Shiki Syntax Highlighting
65
-
66
- ```typescript
67
- // rehype-shiki integration in contentlayer or next.config.mjs
68
- import { rehypeShiki } from '@shikijs/rehype';
69
- import { defineDocumentType, makeSource } from 'contentlayer/source-files';
70
-
71
- export default makeSource({
72
- mdxOptions: {
73
- rehypePlugins: [
74
- [rehypeShiki, {
75
- themes: { light: 'github-light', dark: 'github-dark' },
76
- addLanguageClass: true,
77
- }],
78
- ],
79
- },
80
- });
81
-
82
- // CodeBlock component with copy-to-clipboard
83
- 'use client';
84
- import { useState } from 'react';
85
-
86
- export function CodeBlock({ children, className }: { children: React.ReactNode; className?: string }) {
87
- const [copied, setCopied] = useState(false);
88
- const code = typeof children === 'string' ? children : '';
89
-
90
- async function copy() {
91
- await navigator.clipboard.writeText(code);
92
- setCopied(true);
93
- setTimeout(() => setCopied(false), 2000);
94
- }
95
-
96
- return (
97
- <div className="relative group">
98
- <pre className={className}>{children}</pre>
99
- <button
100
- onClick={copy}
101
- aria-label="Copy code"
102
- className="absolute top-2 right-2 opacity-0 group-hover:opacity-100 transition-opacity px-2 py-1 text-xs bg-gray-700 text-white rounded"
103
- >
104
- {copied ? 'Copied!' : 'Copy'}
105
- </button>
106
- </div>
107
- );
108
- }
109
- ```
110
-
111
- #### Example — Frontmatter Validation
112
-
113
- ```typescript
114
- // contentlayer.config.ts — Zod-like validation via defineDocumentType
115
- import { defineDocumentType } from 'contentlayer/source-files';
116
-
117
- export const Post = defineDocumentType(() => ({
118
- name: 'Post',
119
- filePathPattern: 'posts/**/*.mdx',
120
- contentType: 'mdx',
121
- fields: {
122
- title: { type: 'string', required: true },
123
- date: { type: 'date', required: true },
124
- status: { type: 'enum', options: ['draft', 'published'], required: true },
125
- tags: { type: 'list', of: { type: 'string' }, default: [] },
126
- excerpt:{ type: 'string', required: false },
127
- ogImage:{ type: 'string', required: false },
128
- },
129
- computedFields: {
130
- url: { type: 'string', resolve: d => `/blog/${d._raw.flattenedPath.replace('posts/', '')}` },
131
- readingTime: { type: 'string', resolve: d => {
132
- const words = d.body.raw.split(/\s+/).length;
133
- return `${Math.ceil(words / 238)} min read`;
134
- }},
135
- },
136
- }));
137
- ```
1
+ ---
2
+ name: "mdx-authoring"
3
+ pack: "@rune/content"
4
+ description: "Custom components in markdown, code blocks with syntax highlighting, interactive examples, table of contents generation."
5
+ model: sonnet
6
+ tools: [Read, Edit, Write, Grep, Glob, Bash]
7
+ ---
8
+
9
+ # mdx-authoring
10
+
11
+ MDX authoring patterns — custom components in markdown, code blocks with syntax highlighting, interactive examples, table of contents generation.
12
+
13
+ #### Workflow
14
+
15
+ **Step 1 — Detect MDX setup**
16
+ Use Grep to find MDX configuration: `@next/mdx`, `mdx-bundler`, `next-mdx-remote`, `contentlayer`, `rehype`, `remark`. Read the MDX pipeline config to understand: compilation method, custom components registered, and remark/rehype plugin chain.
17
+
18
+ **Step 2 — Audit MDX pipeline**
19
+ Check for: no custom component fallback (missing component crashes build), code blocks without syntax highlighting (plain text), no table of contents generation (long articles hard to navigate), missing image optimization in MDX (raw `<img>` tags), no frontmatter validation (typos in dates or categories silently pass), and no interactive component sandboxing.
20
+
21
+ **Step 3 — Emit MDX patterns**
22
+ Emit: MDX component registry with fallback for missing components, code block with syntax highlighting (Shiki or Prism), auto-generated TOC from headings, frontmatter schema validation, and callout/admonition components.
23
+
24
+ #### Example — Component Registry
25
+
26
+ ```tsx
27
+ // MDX component registry with safe fallback
28
+ import { type MDXComponents } from 'mdx/types';
29
+ import { Callout } from '@/components/callout';
30
+ import { CodeBlock } from '@/components/code-block';
31
+ import Image from 'next/image';
32
+
33
+ export function useMDXComponents(): MDXComponents {
34
+ return {
35
+ img: ({ src, alt, ...props }) => (
36
+ <Image src={src!} alt={alt || ''} width={800} height={400} className="rounded-lg" {...props} />
37
+ ),
38
+ pre: ({ children, ...props }) => <CodeBlock {...props}>{children}</CodeBlock>,
39
+ Callout,
40
+ };
41
+ }
42
+
43
+ // Auto-generated TOC from MDX content
44
+ interface TocItem { id: string; text: string; level: number }
45
+
46
+ function extractToc(raw: string): TocItem[] {
47
+ const headingRegex = /^(#{2,4})\s+(.+)$/gm;
48
+ const items: TocItem[] = [];
49
+ let match;
50
+ while ((match = headingRegex.exec(raw))) {
51
+ const text = match[2].replace(/[`*_~]/g, '');
52
+ items.push({ id: text.toLowerCase().replace(/\s+/g, '-'), text, level: match[1].length });
53
+ }
54
+ return items;
55
+ }
56
+
57
+ // Callout component for MDX
58
+ function Callout({ type = 'info', children }: { type?: 'info' | 'warning' | 'error'; children: React.ReactNode }) {
59
+ const styles = { info: 'bg-blue-50 border-blue-400', warning: 'bg-amber-50 border-amber-400', error: 'bg-red-50 border-red-400' };
60
+ return <div className={`border-l-4 p-4 my-4 rounded-r ${styles[type]}`}>{children}</div>;
61
+ }
62
+ ```
63
+
64
+ #### Example — Shiki Syntax Highlighting
65
+
66
+ ```typescript
67
+ // rehype-shiki integration in contentlayer or next.config.mjs
68
+ import { rehypeShiki } from '@shikijs/rehype';
69
+ import { defineDocumentType, makeSource } from 'contentlayer/source-files';
70
+
71
+ export default makeSource({
72
+ mdxOptions: {
73
+ rehypePlugins: [
74
+ [rehypeShiki, {
75
+ themes: { light: 'github-light', dark: 'github-dark' },
76
+ addLanguageClass: true,
77
+ }],
78
+ ],
79
+ },
80
+ });
81
+
82
+ // CodeBlock component with copy-to-clipboard
83
+ 'use client';
84
+ import { useState } from 'react';
85
+
86
+ export function CodeBlock({ children, className }: { children: React.ReactNode; className?: string }) {
87
+ const [copied, setCopied] = useState(false);
88
+ const code = typeof children === 'string' ? children : '';
89
+
90
+ async function copy() {
91
+ await navigator.clipboard.writeText(code);
92
+ setCopied(true);
93
+ setTimeout(() => setCopied(false), 2000);
94
+ }
95
+
96
+ return (
97
+ <div className="relative group">
98
+ <pre className={className}>{children}</pre>
99
+ <button
100
+ onClick={copy}
101
+ aria-label="Copy code"
102
+ className="absolute top-2 right-2 opacity-0 group-hover:opacity-100 transition-opacity px-2 py-1 text-xs bg-gray-700 text-white rounded"
103
+ >
104
+ {copied ? 'Copied!' : 'Copy'}
105
+ </button>
106
+ </div>
107
+ );
108
+ }
109
+ ```
110
+
111
+ #### Example — Frontmatter Validation
112
+
113
+ ```typescript
114
+ // contentlayer.config.ts — Zod-like validation via defineDocumentType
115
+ import { defineDocumentType } from 'contentlayer/source-files';
116
+
117
+ export const Post = defineDocumentType(() => ({
118
+ name: 'Post',
119
+ filePathPattern: 'posts/**/*.mdx',
120
+ contentType: 'mdx',
121
+ fields: {
122
+ title: { type: 'string', required: true },
123
+ date: { type: 'date', required: true },
124
+ status: { type: 'enum', options: ['draft', 'published'], required: true },
125
+ tags: { type: 'list', of: { type: 'string' }, default: [] },
126
+ excerpt:{ type: 'string', required: false },
127
+ ogImage:{ type: 'string', required: false },
128
+ },
129
+ computedFields: {
130
+ url: { type: 'string', resolve: d => `/blog/${d._raw.flattenedPath.replace('posts/', '')}` },
131
+ readingTime: { type: 'string', resolve: d => {
132
+ const words = d.body.raw.split(/\s+/).length;
133
+ return `${Math.ceil(words / 238)} min read`;
134
+ }},
135
+ },
136
+ }));
137
+ ```