@thedatagrid/docs-kit 0.2.2 → 0.4.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 (204) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +206 -4
  3. package/dist/code/demoFiles.d.ts.map +1 -1
  4. package/dist/code/demoFiles.js +2 -2
  5. package/dist/code/demoFiles.js.map +1 -1
  6. package/dist/code/index.d.ts +1 -0
  7. package/dist/code/index.d.ts.map +1 -1
  8. package/dist/code/index.js +1 -0
  9. package/dist/code/index.js.map +1 -1
  10. package/dist/code/regions.d.ts +2 -1
  11. package/dist/code/regions.d.ts.map +1 -1
  12. package/dist/code/regions.js +12 -8
  13. package/dist/code/regions.js.map +1 -1
  14. package/dist/code/vueBlocks.d.ts +3 -0
  15. package/dist/code/vueBlocks.d.ts.map +1 -0
  16. package/dist/code/vueBlocks.js +29 -0
  17. package/dist/code/vueBlocks.js.map +1 -0
  18. package/dist/demos/build.d.ts +5 -2
  19. package/dist/demos/build.d.ts.map +1 -1
  20. package/dist/demos/build.js +244 -85
  21. package/dist/demos/build.js.map +1 -1
  22. package/dist/demos/compile/core.d.ts +9 -1
  23. package/dist/demos/compile/core.d.ts.map +1 -1
  24. package/dist/demos/compile/core.js +19 -8
  25. package/dist/demos/compile/core.js.map +1 -1
  26. package/dist/demos/compile/vue.d.ts +107 -0
  27. package/dist/demos/compile/vue.d.ts.map +1 -0
  28. package/dist/demos/compile/vue.js +187 -0
  29. package/dist/demos/compile/vue.js.map +1 -0
  30. package/dist/demos/config.d.ts +27 -7
  31. package/dist/demos/config.d.ts.map +1 -1
  32. package/dist/demos/config.js.map +1 -1
  33. package/dist/demos/index.d.ts +3 -2
  34. package/dist/demos/index.d.ts.map +1 -1
  35. package/dist/demos/index.js +1 -0
  36. package/dist/demos/index.js.map +1 -1
  37. package/dist/demos/pages.d.ts +1 -1
  38. package/dist/demos/pages.d.ts.map +1 -1
  39. package/dist/demos/pages.js +4 -1
  40. package/dist/demos/pages.js.map +1 -1
  41. package/dist/demos/runtime/vue.d.ts +3 -0
  42. package/dist/demos/runtime/vue.d.ts.map +1 -0
  43. package/dist/demos/runtime/vue.js +15 -0
  44. package/dist/demos/runtime/vue.js.map +1 -0
  45. package/dist/demos/worker/compile.worker.js +3 -22
  46. package/dist/demos/worker/compile.worker.js.map +1 -1
  47. package/dist/demos/worker/compileVue.worker.d.ts +2 -0
  48. package/dist/demos/worker/compileVue.worker.d.ts.map +1 -0
  49. package/dist/demos/worker/compileVue.worker.js +11 -0
  50. package/dist/demos/worker/compileVue.worker.js.map +1 -0
  51. package/dist/demos/worker/start.d.ts +7 -0
  52. package/dist/demos/worker/start.d.ts.map +1 -0
  53. package/dist/demos/worker/start.js +27 -0
  54. package/dist/demos/worker/start.js.map +1 -0
  55. package/dist/fork/codesandbox.d.ts +15 -1
  56. package/dist/fork/codesandbox.d.ts.map +1 -1
  57. package/dist/fork/codesandbox.js +30 -19
  58. package/dist/fork/codesandbox.js.map +1 -1
  59. package/dist/fork/index.d.ts +18 -0
  60. package/dist/fork/index.d.ts.map +1 -1
  61. package/dist/fork/index.js +18 -0
  62. package/dist/fork/index.js.map +1 -1
  63. package/dist/fork/stackblitz.d.ts +18 -0
  64. package/dist/fork/stackblitz.d.ts.map +1 -0
  65. package/dist/fork/stackblitz.js +98 -0
  66. package/dist/fork/stackblitz.js.map +1 -0
  67. package/dist/frameworks/index.d.ts +4 -0
  68. package/dist/frameworks/index.d.ts.map +1 -0
  69. package/dist/frameworks/index.js +4 -0
  70. package/dist/frameworks/index.js.map +1 -0
  71. package/dist/frameworks/preference.d.ts +10 -0
  72. package/dist/frameworks/preference.d.ts.map +1 -0
  73. package/dist/frameworks/preference.js +34 -0
  74. package/dist/frameworks/preference.js.map +1 -0
  75. package/dist/frameworks/react/FrameworkBanner.d.ts +34 -0
  76. package/dist/frameworks/react/FrameworkBanner.d.ts.map +1 -0
  77. package/dist/frameworks/react/FrameworkBanner.js +50 -0
  78. package/dist/frameworks/react/FrameworkBanner.js.map +1 -0
  79. package/dist/frameworks/react/FrameworkContent.d.ts +21 -0
  80. package/dist/frameworks/react/FrameworkContent.d.ts.map +1 -0
  81. package/dist/frameworks/react/FrameworkContent.js +25 -0
  82. package/dist/frameworks/react/FrameworkContent.js.map +1 -0
  83. package/dist/frameworks/react/FrameworkLinks.d.ts +16 -0
  84. package/dist/frameworks/react/FrameworkLinks.d.ts.map +1 -0
  85. package/dist/frameworks/react/FrameworkLinks.js +50 -0
  86. package/dist/frameworks/react/FrameworkLinks.js.map +1 -0
  87. package/dist/frameworks/react/FrameworkSwitcher.d.ts +27 -0
  88. package/dist/frameworks/react/FrameworkSwitcher.d.ts.map +1 -0
  89. package/dist/frameworks/react/FrameworkSwitcher.js +42 -0
  90. package/dist/frameworks/react/FrameworkSwitcher.js.map +1 -0
  91. package/dist/frameworks/react/index.d.ts +6 -0
  92. package/dist/frameworks/react/index.d.ts.map +1 -0
  93. package/dist/frameworks/react/index.js +6 -0
  94. package/dist/frameworks/react/index.js.map +1 -0
  95. package/dist/frameworks/react/useFrameworkPreference.d.ts +32 -0
  96. package/dist/frameworks/react/useFrameworkPreference.d.ts.map +1 -0
  97. package/dist/frameworks/react/useFrameworkPreference.js +45 -0
  98. package/dist/frameworks/react/useFrameworkPreference.js.map +1 -0
  99. package/dist/frameworks/routeTree.d.ts +24 -0
  100. package/dist/frameworks/routeTree.d.ts.map +1 -0
  101. package/dist/frameworks/routeTree.js +31 -0
  102. package/dist/frameworks/routeTree.js.map +1 -0
  103. package/dist/frameworks/routing.d.ts +105 -0
  104. package/dist/frameworks/routing.d.ts.map +1 -0
  105. package/dist/frameworks/routing.js +142 -0
  106. package/dist/frameworks/routing.js.map +1 -0
  107. package/dist/frameworks/styles.css +104 -0
  108. package/dist/react/Demo.d.ts +12 -0
  109. package/dist/react/Demo.d.ts.map +1 -1
  110. package/dist/react/Demo.js +10 -4
  111. package/dist/react/Demo.js.map +1 -1
  112. package/dist/react/DemoShell.d.ts +5 -1
  113. package/dist/react/DemoShell.d.ts.map +1 -1
  114. package/dist/react/DemoShell.js +9 -6
  115. package/dist/react/DemoShell.js.map +1 -1
  116. package/dist/react/editor.d.ts.map +1 -1
  117. package/dist/react/editor.js +3 -0
  118. package/dist/react/editor.js.map +1 -1
  119. package/dist/react/fork.d.ts +4 -3
  120. package/dist/react/fork.d.ts.map +1 -1
  121. package/dist/react/fork.js +6 -5
  122. package/dist/react/fork.js.map +1 -1
  123. package/dist/react/styles.css +10 -0
  124. package/dist/remark/index.d.ts +2 -0
  125. package/dist/remark/index.d.ts.map +1 -1
  126. package/dist/remark/index.js +2 -0
  127. package/dist/remark/index.js.map +1 -1
  128. package/dist/remark/remarkDemoFences.d.ts +13 -0
  129. package/dist/remark/remarkDemoFences.d.ts.map +1 -1
  130. package/dist/remark/remarkDemoFences.js +48 -4
  131. package/dist/remark/remarkDemoFences.js.map +1 -1
  132. package/dist/remark/remarkFrameworkLinks.d.ts +36 -0
  133. package/dist/remark/remarkFrameworkLinks.d.ts.map +1 -0
  134. package/dist/remark/remarkFrameworkLinks.js +77 -0
  135. package/dist/remark/remarkFrameworkLinks.js.map +1 -0
  136. package/dist/remark/remarkFrameworkText.d.ts +16 -0
  137. package/dist/remark/remarkFrameworkText.d.ts.map +1 -0
  138. package/dist/remark/remarkFrameworkText.js +39 -0
  139. package/dist/remark/remarkFrameworkText.js.map +1 -0
  140. package/dist/showcase/AutomatedDemo.d.ts +46 -0
  141. package/dist/showcase/AutomatedDemo.d.ts.map +1 -0
  142. package/dist/showcase/AutomatedDemo.js +169 -0
  143. package/dist/showcase/AutomatedDemo.js.map +1 -0
  144. package/dist/showcase/LazyShowcase.d.ts +31 -0
  145. package/dist/showcase/LazyShowcase.d.ts.map +1 -0
  146. package/dist/showcase/LazyShowcase.js +51 -0
  147. package/dist/showcase/LazyShowcase.js.map +1 -0
  148. package/dist/showcase/hooks.d.ts +19 -0
  149. package/dist/showcase/hooks.d.ts.map +1 -0
  150. package/dist/showcase/hooks.js +63 -0
  151. package/dist/showcase/hooks.js.map +1 -0
  152. package/dist/showcase/index.d.ts +17 -0
  153. package/dist/showcase/index.d.ts.map +1 -0
  154. package/dist/showcase/index.js +15 -0
  155. package/dist/showcase/index.js.map +1 -0
  156. package/dist/showcase/scripted.d.ts +100 -0
  157. package/dist/showcase/scripted.d.ts.map +1 -0
  158. package/dist/showcase/scripted.js +381 -0
  159. package/dist/showcase/scripted.js.map +1 -0
  160. package/dist/showcase/styles.css +174 -0
  161. package/package.json +34 -4
  162. package/src/code/demoFiles.ts +2 -2
  163. package/src/code/index.ts +1 -0
  164. package/src/code/regions.ts +14 -8
  165. package/src/code/vueBlocks.ts +25 -0
  166. package/src/demos/build.ts +293 -99
  167. package/src/demos/compile/core.ts +27 -7
  168. package/src/demos/compile/vue.ts +259 -0
  169. package/src/demos/config.ts +44 -7
  170. package/src/demos/index.ts +13 -0
  171. package/src/demos/pages.ts +4 -2
  172. package/src/demos/runtime/vue.ts +17 -0
  173. package/src/demos/worker/compile.worker.ts +3 -30
  174. package/src/demos/worker/compileVue.worker.ts +13 -0
  175. package/src/demos/worker/start.ts +35 -0
  176. package/src/fork/codesandbox.ts +43 -21
  177. package/src/fork/index.ts +25 -0
  178. package/src/fork/stackblitz.ts +107 -0
  179. package/src/frameworks/index.ts +21 -0
  180. package/src/frameworks/preference.ts +35 -0
  181. package/src/frameworks/react/FrameworkBanner.tsx +112 -0
  182. package/src/frameworks/react/FrameworkContent.tsx +33 -0
  183. package/src/frameworks/react/FrameworkLinks.tsx +52 -0
  184. package/src/frameworks/react/FrameworkSwitcher.tsx +78 -0
  185. package/src/frameworks/react/index.ts +10 -0
  186. package/src/frameworks/react/useFrameworkPreference.ts +91 -0
  187. package/src/frameworks/routeTree.ts +54 -0
  188. package/src/frameworks/routing.ts +194 -0
  189. package/src/frameworks/styles.css +104 -0
  190. package/src/react/Demo.tsx +21 -2
  191. package/src/react/DemoShell.tsx +15 -7
  192. package/src/react/editor.ts +2 -0
  193. package/src/react/fork.ts +12 -5
  194. package/src/react/styles.css +10 -0
  195. package/src/remark/index.ts +6 -0
  196. package/src/remark/remarkDemoFences.ts +58 -3
  197. package/src/remark/remarkFrameworkLinks.ts +96 -0
  198. package/src/remark/remarkFrameworkText.ts +44 -0
  199. package/src/showcase/AutomatedDemo.tsx +266 -0
  200. package/src/showcase/LazyShowcase.tsx +111 -0
  201. package/src/showcase/hooks.ts +84 -0
  202. package/src/showcase/index.ts +23 -0
  203. package/src/showcase/scripted.ts +533 -0
  204. package/src/showcase/styles.css +174 -0
package/src/code/index.ts CHANGED
@@ -20,6 +20,7 @@ export {
20
20
  type HighlightSpec,
21
21
  } from './highlightSpec.ts';
22
22
  export { formatLineRanges, parseLineRanges } from './lineRanges.ts';
23
+ export { vueBlockLang } from './vueBlocks.ts';
23
24
  export {
24
25
  DEMO_HEIGHTS,
25
26
  parseDemoHeight,
@@ -130,12 +130,17 @@ export function sliceRegion(source: string, spec: string, context: string): Slic
130
130
  return extracted;
131
131
  }
132
132
 
133
- /** Whole-line `// #highlight label`, `/* #highlight label *\/` or `{/* #highlight label *\/}`. */
134
- const HIGHLIGHT_START_RE = /^\s*(?:\/\/\s*#highlight\b(.*)|\{?\/\*\s*#highlight\b(.*?)\*\/\}?)\s*$/;
135
- const HIGHLIGHT_END_RE = /^\s*(?:\/\/\s*#endhighlight\b.*|\{?\/\*\s*#endhighlight\b.*?\*\/\}?)\s*$/;
136
- /** Trailing `code // #highlight label` (or a `/* … *\/` / `{/* … *\/}` comment) after code. */
133
+ /**
134
+ * Whole-line `// #highlight label`, `/* #highlight label *\/`, `{/* #highlight label *\/}`
135
+ * or, in HTML and Vue templates, `<!-- #highlight label -->`.
136
+ */
137
+ const HIGHLIGHT_START_RE =
138
+ /^\s*(?:\/\/\s*#highlight\b(.*)|\{?\/\*\s*#highlight\b(.*?)\*\/\}?|<!--\s*#highlight\b(.*?)-->)\s*$/;
139
+ const HIGHLIGHT_END_RE =
140
+ /^\s*(?:\/\/\s*#endhighlight\b.*|\{?\/\*\s*#endhighlight\b.*?\*\/\}?|<!--\s*#endhighlight\b.*?-->)\s*$/;
141
+ /** Trailing `code // #highlight label` (or a `/* … *\/`, `{/* … *\/}` or `<!-- … -->` comment) after code. */
137
142
  const HIGHLIGHT_INLINE_RE =
138
- /^(.*?\S)\s*(?:\/\/\s*#highlight\b(.*)|\{\/\*\s*#highlight\b(.*?)\*\/\}|\/\*\s*#highlight\b(.*?)\*\/)\s*$/;
143
+ /^(.*?\S)\s*(?:\/\/\s*#highlight\b(.*)|\{\/\*\s*#highlight\b(.*?)\*\/\}|\/\*\s*#highlight\b(.*?)\*\/|<!--\s*#highlight\b(.*?)-->)\s*$/;
139
144
 
140
145
  function isRegionMarker(line: string): boolean {
141
146
  return REGION_MARKERS.some((re) => re.start.test(line) || re.end.test(line));
@@ -155,7 +160,8 @@ export type CodeWithMarkers = SlicedRange & {
155
160
  * With a label, the opening marker becomes an empty highlighted line that
156
161
  * shows the label; without one it is removed.
157
162
  * - `code // #highlight label` highlights that single line.
158
- * - `/* … *\/` and `{/* … *\/}` (JSX children) work for both forms.
163
+ * - `/* … *\/`, `{/* … *\/}` (JSX children) and `<!-- … -->` (HTML, Vue templates)
164
+ * work for both forms.
159
165
  * - `#region` / `#endregion` lines are dropped, so full-file views don't show them.
160
166
  *
161
167
  * `originalLines` (from `sliceRegion`) is kept in step with the removed lines.
@@ -198,7 +204,7 @@ export function extractCodeMarkers(
198
204
  `${context}: the \`#highlight\` on line ${block.fileLine} has no code line before the \`#highlight\` on line ${fileLine}`,
199
205
  );
200
206
  }
201
- const label = (start[1] ?? start[2] ?? '').trim();
207
+ const label = (start[1] ?? start[2] ?? start[3] ?? '').trim();
202
208
  if (label) {
203
209
  // the label row keeps the marker's indentation, so the label lines up with the block
204
210
  kept.push(/^\s*/.exec(text)![0]);
@@ -223,7 +229,7 @@ export function extractCodeMarkers(
223
229
  const inline = HIGHLIGHT_INLINE_RE.exec(text);
224
230
  kept.push(inline ? inline[1] : text);
225
231
  keptLines.push(fileLine);
226
- if (inline) mark((inline[2] ?? inline[3] ?? inline[4] ?? '').trim());
232
+ if (inline) mark((inline[2] ?? inline[3] ?? inline[4] ?? inline[5] ?? '').trim());
227
233
  if (block) {
228
234
  mark('');
229
235
  if (block.nextLineOnly && text.trim()) block = null;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Which block of a Vue single-file component a line belongs to, as a shiki
3
+ * language: a region sliced out of a `.vue` file is highlighted as what it
4
+ * is (script code, template markup or CSS), not as a whole component.
5
+ */
6
+ const BLOCK_OPEN_RE = /^<(script|template|style)\b([^>]*)>/;
7
+
8
+ /** `line` is 1-based. Lines outside every block (or a whole-file view) are `vue`. */
9
+ export function vueBlockLang(source: string, line: number): string {
10
+ const lines = source.split('\n');
11
+ let current: { tag: string; attrs: string } | null = null;
12
+ for (let index = 0; index < Math.min(line, lines.length); index++) {
13
+ const open = BLOCK_OPEN_RE.exec(lines[index]);
14
+ if (open) {
15
+ current = { tag: open[1], attrs: open[2] };
16
+ continue;
17
+ }
18
+ if (current && lines[index].startsWith(`</${current.tag}>`)) current = null;
19
+ }
20
+ if (!current) return 'vue';
21
+ if (current.tag === 'template') return 'vue-html';
22
+ const lang = /\blang=["']([\w-]+)["']/.exec(current.attrs)?.[1];
23
+ if (current.tag === 'style') return lang ?? 'css';
24
+ return lang ?? 'js';
25
+ }