@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.
- package/CHANGELOG.md +30 -0
- package/README.md +206 -4
- package/dist/code/demoFiles.d.ts.map +1 -1
- package/dist/code/demoFiles.js +2 -2
- package/dist/code/demoFiles.js.map +1 -1
- package/dist/code/index.d.ts +1 -0
- package/dist/code/index.d.ts.map +1 -1
- package/dist/code/index.js +1 -0
- package/dist/code/index.js.map +1 -1
- package/dist/code/regions.d.ts +2 -1
- package/dist/code/regions.d.ts.map +1 -1
- package/dist/code/regions.js +12 -8
- package/dist/code/regions.js.map +1 -1
- package/dist/code/vueBlocks.d.ts +3 -0
- package/dist/code/vueBlocks.d.ts.map +1 -0
- package/dist/code/vueBlocks.js +29 -0
- package/dist/code/vueBlocks.js.map +1 -0
- package/dist/demos/build.d.ts +5 -2
- package/dist/demos/build.d.ts.map +1 -1
- package/dist/demos/build.js +244 -85
- package/dist/demos/build.js.map +1 -1
- package/dist/demos/compile/core.d.ts +9 -1
- package/dist/demos/compile/core.d.ts.map +1 -1
- package/dist/demos/compile/core.js +19 -8
- package/dist/demos/compile/core.js.map +1 -1
- package/dist/demos/compile/vue.d.ts +107 -0
- package/dist/demos/compile/vue.d.ts.map +1 -0
- package/dist/demos/compile/vue.js +187 -0
- package/dist/demos/compile/vue.js.map +1 -0
- package/dist/demos/config.d.ts +27 -7
- package/dist/demos/config.d.ts.map +1 -1
- package/dist/demos/config.js.map +1 -1
- package/dist/demos/index.d.ts +3 -2
- package/dist/demos/index.d.ts.map +1 -1
- package/dist/demos/index.js +1 -0
- package/dist/demos/index.js.map +1 -1
- package/dist/demos/pages.d.ts +1 -1
- package/dist/demos/pages.d.ts.map +1 -1
- package/dist/demos/pages.js +4 -1
- package/dist/demos/pages.js.map +1 -1
- package/dist/demos/runtime/vue.d.ts +3 -0
- package/dist/demos/runtime/vue.d.ts.map +1 -0
- package/dist/demos/runtime/vue.js +15 -0
- package/dist/demos/runtime/vue.js.map +1 -0
- package/dist/demos/worker/compile.worker.js +3 -22
- package/dist/demos/worker/compile.worker.js.map +1 -1
- package/dist/demos/worker/compileVue.worker.d.ts +2 -0
- package/dist/demos/worker/compileVue.worker.d.ts.map +1 -0
- package/dist/demos/worker/compileVue.worker.js +11 -0
- package/dist/demos/worker/compileVue.worker.js.map +1 -0
- package/dist/demos/worker/start.d.ts +7 -0
- package/dist/demos/worker/start.d.ts.map +1 -0
- package/dist/demos/worker/start.js +27 -0
- package/dist/demos/worker/start.js.map +1 -0
- package/dist/fork/codesandbox.d.ts +15 -1
- package/dist/fork/codesandbox.d.ts.map +1 -1
- package/dist/fork/codesandbox.js +30 -19
- package/dist/fork/codesandbox.js.map +1 -1
- package/dist/fork/index.d.ts +18 -0
- package/dist/fork/index.d.ts.map +1 -1
- package/dist/fork/index.js +18 -0
- package/dist/fork/index.js.map +1 -1
- package/dist/fork/stackblitz.d.ts +18 -0
- package/dist/fork/stackblitz.d.ts.map +1 -0
- package/dist/fork/stackblitz.js +98 -0
- package/dist/fork/stackblitz.js.map +1 -0
- package/dist/frameworks/index.d.ts +4 -0
- package/dist/frameworks/index.d.ts.map +1 -0
- package/dist/frameworks/index.js +4 -0
- package/dist/frameworks/index.js.map +1 -0
- package/dist/frameworks/preference.d.ts +10 -0
- package/dist/frameworks/preference.d.ts.map +1 -0
- package/dist/frameworks/preference.js +34 -0
- package/dist/frameworks/preference.js.map +1 -0
- package/dist/frameworks/react/FrameworkBanner.d.ts +34 -0
- package/dist/frameworks/react/FrameworkBanner.d.ts.map +1 -0
- package/dist/frameworks/react/FrameworkBanner.js +50 -0
- package/dist/frameworks/react/FrameworkBanner.js.map +1 -0
- package/dist/frameworks/react/FrameworkContent.d.ts +21 -0
- package/dist/frameworks/react/FrameworkContent.d.ts.map +1 -0
- package/dist/frameworks/react/FrameworkContent.js +25 -0
- package/dist/frameworks/react/FrameworkContent.js.map +1 -0
- package/dist/frameworks/react/FrameworkLinks.d.ts +16 -0
- package/dist/frameworks/react/FrameworkLinks.d.ts.map +1 -0
- package/dist/frameworks/react/FrameworkLinks.js +50 -0
- package/dist/frameworks/react/FrameworkLinks.js.map +1 -0
- package/dist/frameworks/react/FrameworkSwitcher.d.ts +27 -0
- package/dist/frameworks/react/FrameworkSwitcher.d.ts.map +1 -0
- package/dist/frameworks/react/FrameworkSwitcher.js +42 -0
- package/dist/frameworks/react/FrameworkSwitcher.js.map +1 -0
- package/dist/frameworks/react/index.d.ts +6 -0
- package/dist/frameworks/react/index.d.ts.map +1 -0
- package/dist/frameworks/react/index.js +6 -0
- package/dist/frameworks/react/index.js.map +1 -0
- package/dist/frameworks/react/useFrameworkPreference.d.ts +32 -0
- package/dist/frameworks/react/useFrameworkPreference.d.ts.map +1 -0
- package/dist/frameworks/react/useFrameworkPreference.js +45 -0
- package/dist/frameworks/react/useFrameworkPreference.js.map +1 -0
- package/dist/frameworks/routeTree.d.ts +24 -0
- package/dist/frameworks/routeTree.d.ts.map +1 -0
- package/dist/frameworks/routeTree.js +31 -0
- package/dist/frameworks/routeTree.js.map +1 -0
- package/dist/frameworks/routing.d.ts +105 -0
- package/dist/frameworks/routing.d.ts.map +1 -0
- package/dist/frameworks/routing.js +142 -0
- package/dist/frameworks/routing.js.map +1 -0
- package/dist/frameworks/styles.css +104 -0
- package/dist/react/Demo.d.ts +12 -0
- package/dist/react/Demo.d.ts.map +1 -1
- package/dist/react/Demo.js +10 -4
- package/dist/react/Demo.js.map +1 -1
- package/dist/react/DemoShell.d.ts +5 -1
- package/dist/react/DemoShell.d.ts.map +1 -1
- package/dist/react/DemoShell.js +9 -6
- package/dist/react/DemoShell.js.map +1 -1
- package/dist/react/editor.d.ts.map +1 -1
- package/dist/react/editor.js +3 -0
- package/dist/react/editor.js.map +1 -1
- package/dist/react/fork.d.ts +4 -3
- package/dist/react/fork.d.ts.map +1 -1
- package/dist/react/fork.js +6 -5
- package/dist/react/fork.js.map +1 -1
- package/dist/react/styles.css +10 -0
- package/dist/remark/index.d.ts +2 -0
- package/dist/remark/index.d.ts.map +1 -1
- package/dist/remark/index.js +2 -0
- package/dist/remark/index.js.map +1 -1
- package/dist/remark/remarkDemoFences.d.ts +13 -0
- package/dist/remark/remarkDemoFences.d.ts.map +1 -1
- package/dist/remark/remarkDemoFences.js +48 -4
- package/dist/remark/remarkDemoFences.js.map +1 -1
- package/dist/remark/remarkFrameworkLinks.d.ts +36 -0
- package/dist/remark/remarkFrameworkLinks.d.ts.map +1 -0
- package/dist/remark/remarkFrameworkLinks.js +77 -0
- package/dist/remark/remarkFrameworkLinks.js.map +1 -0
- package/dist/remark/remarkFrameworkText.d.ts +16 -0
- package/dist/remark/remarkFrameworkText.d.ts.map +1 -0
- package/dist/remark/remarkFrameworkText.js +39 -0
- package/dist/remark/remarkFrameworkText.js.map +1 -0
- package/dist/showcase/AutomatedDemo.d.ts +46 -0
- package/dist/showcase/AutomatedDemo.d.ts.map +1 -0
- package/dist/showcase/AutomatedDemo.js +169 -0
- package/dist/showcase/AutomatedDemo.js.map +1 -0
- package/dist/showcase/LazyShowcase.d.ts +31 -0
- package/dist/showcase/LazyShowcase.d.ts.map +1 -0
- package/dist/showcase/LazyShowcase.js +51 -0
- package/dist/showcase/LazyShowcase.js.map +1 -0
- package/dist/showcase/hooks.d.ts +19 -0
- package/dist/showcase/hooks.d.ts.map +1 -0
- package/dist/showcase/hooks.js +63 -0
- package/dist/showcase/hooks.js.map +1 -0
- package/dist/showcase/index.d.ts +17 -0
- package/dist/showcase/index.d.ts.map +1 -0
- package/dist/showcase/index.js +15 -0
- package/dist/showcase/index.js.map +1 -0
- package/dist/showcase/scripted.d.ts +100 -0
- package/dist/showcase/scripted.d.ts.map +1 -0
- package/dist/showcase/scripted.js +381 -0
- package/dist/showcase/scripted.js.map +1 -0
- package/dist/showcase/styles.css +174 -0
- package/package.json +34 -4
- package/src/code/demoFiles.ts +2 -2
- package/src/code/index.ts +1 -0
- package/src/code/regions.ts +14 -8
- package/src/code/vueBlocks.ts +25 -0
- package/src/demos/build.ts +293 -99
- package/src/demos/compile/core.ts +27 -7
- package/src/demos/compile/vue.ts +259 -0
- package/src/demos/config.ts +44 -7
- package/src/demos/index.ts +13 -0
- package/src/demos/pages.ts +4 -2
- package/src/demos/runtime/vue.ts +17 -0
- package/src/demos/worker/compile.worker.ts +3 -30
- package/src/demos/worker/compileVue.worker.ts +13 -0
- package/src/demos/worker/start.ts +35 -0
- package/src/fork/codesandbox.ts +43 -21
- package/src/fork/index.ts +25 -0
- package/src/fork/stackblitz.ts +107 -0
- package/src/frameworks/index.ts +21 -0
- package/src/frameworks/preference.ts +35 -0
- package/src/frameworks/react/FrameworkBanner.tsx +112 -0
- package/src/frameworks/react/FrameworkContent.tsx +33 -0
- package/src/frameworks/react/FrameworkLinks.tsx +52 -0
- package/src/frameworks/react/FrameworkSwitcher.tsx +78 -0
- package/src/frameworks/react/index.ts +10 -0
- package/src/frameworks/react/useFrameworkPreference.ts +91 -0
- package/src/frameworks/routeTree.ts +54 -0
- package/src/frameworks/routing.ts +194 -0
- package/src/frameworks/styles.css +104 -0
- package/src/react/Demo.tsx +21 -2
- package/src/react/DemoShell.tsx +15 -7
- package/src/react/editor.ts +2 -0
- package/src/react/fork.ts +12 -5
- package/src/react/styles.css +10 -0
- package/src/remark/index.ts +6 -0
- package/src/remark/remarkDemoFences.ts +58 -3
- package/src/remark/remarkFrameworkLinks.ts +96 -0
- package/src/remark/remarkFrameworkText.ts +44 -0
- package/src/showcase/AutomatedDemo.tsx +266 -0
- package/src/showcase/LazyShowcase.tsx +111 -0
- package/src/showcase/hooks.ts +84 -0
- package/src/showcase/index.ts +23 -0
- package/src/showcase/scripted.ts +533 -0
- package/src/showcase/styles.css +174 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @thedatagrid/docs-kit
|
|
2
2
|
|
|
3
|
+
## 0.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 424b8af: Vue demos, and docs per framework.
|
|
8
|
+
|
|
9
|
+
- **Vue adapter.** `frameworks: { vue: { … } }` in `docs-kit.config` builds a sibling `foo.demo.vue` next to `foo.demo.tsx` into `<outDir>/_vue`, with its own import map (`vue`, `vue/jsx-runtime`, the library), runtime and manifest. Single-file components are compiled with `@vue/compiler-sfc` (`<script>` / `<script setup>` in JS or TS, `<template>`, plain or `scoped` CSS); library source uses Vue's automatic JSX. `vue` and `@vue/compiler-sfc` are optional peer dependencies, loaded only for a Vue framework. A config without `frameworks` builds what it built before.
|
|
10
|
+
- **Editing Vue demos.** A second compile worker with the Vue compiler's browser build; `compileDemo(esbuild, request, options, { vue })` for servers and tests. `.vue` tabs use `@codemirror/lang-vue`.
|
|
11
|
+
- **Forks.** Vue demos fork to StackBlitz: `stackBlitzForm` / `vueProjectFiles` build a Vite + Vue + TypeScript project that keeps the folder structure. `forkForm(files, { framework })` picks the target (CodeSandbox for React, StackBlitz for Vue).
|
|
12
|
+
- **Markers in templates.** `<!-- #highlight label -->`, `<!-- #endhighlight -->` and trailing `<!-- #highlight -->`. A region of a `.vue` file is highlighted as its block (`vueBlockLang`).
|
|
13
|
+
- **`remarkDemoFences`: `siblings`.** On a page of another framework, `file="foo.demo.tsx"` shows `foo.demo.vue`. A fence without a sibling keeps its file and gets `fallback="true"`; `<Demo>` then uses `context.fallback.manifest` and shows `context.fallback.notice` on the card. `neutral` on a fence opts out.
|
|
14
|
+
- **`/frameworks`.** `defineFrameworks`, `createHasPage`, `resolveFrameworkLink`, `resolveSwitchTarget`, `resolveNavigation`, `mapRouteTree`, and the stored preference.
|
|
15
|
+
- **`/remark`.** `remarkFrameworkLinks` maps links written in the default form to the page's framework, marks fallbacks with `data-framework-fallback`, and fails the build on a link with no page in any framework. `remarkFrameworkText` applies literal replacements (the package name) to prose.
|
|
16
|
+
- **`/frameworks/react`** and **`/frameworks/styles.css`.** `FrameworkSwitcher`, `FrameworkBanner`, `FrameworkLinks`, `useFrameworkPreference`, `createFrameworkContent`.
|
|
17
|
+
- `routeForPage` may return `null` (no docs link for that demo). `include` in the config is now applied.
|
|
18
|
+
|
|
19
|
+
## 0.3.0
|
|
20
|
+
|
|
21
|
+
### Minor Changes
|
|
22
|
+
|
|
23
|
+
- 48356c6: New `/showcase` subpath, for live demos on marketing pages that play by themselves and can be taken over.
|
|
24
|
+
|
|
25
|
+
- `AutomatedDemo`: runs a script that drives the live component with a fake cursor while it is in view. The first real interaction hands control to the visitor, and a "replay" pill starts the show again. It does not start on touch devices, small viewports or with reduced motion.
|
|
26
|
+
- The scripted cursor toolkit: `createScriptedCursor` (`moveTo`, `moveToElement`, `hover`, `click`, `drag`, `setLabel`), `sleep`, `waitFor`, `tween`, `fling`, `dispatchClickSequence`, `dispatchHover`. Everything is cancelled through one `AbortSignal`.
|
|
27
|
+
- `LazyShowcase`: a poster first, then the live demo, imported when its container is near the viewport and the page is idle.
|
|
28
|
+
- Hooks: `useInView`, `usePageVisible`, `usePrefersReducedMotion`, `useMediaQuery`.
|
|
29
|
+
- Styles in `@thedatagrid/docs-kit/showcase/styles.css`, themed with `--showcase-*` custom properties.
|
|
30
|
+
|
|
31
|
+
It only depends on React, and a test keeps it from importing anything else.
|
|
32
|
+
|
|
3
33
|
## 0.2.2
|
|
4
34
|
|
|
5
35
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -7,22 +7,31 @@ documentation sites:
|
|
|
7
7
|
`#region`s and `// #highlight` comment markers;
|
|
8
8
|
- **live demos** prebuilt with esbuild into static iframe pages (fast first
|
|
9
9
|
view, no in-browser bundler on page load), with one shared import map for
|
|
10
|
-
the product library and React;
|
|
10
|
+
the product library and the framework: React, and Vue single-file components;
|
|
11
11
|
- **editable demos**: CodeMirror plus an in-browser esbuild-wasm rebuild of the
|
|
12
12
|
demo's own files (or a remote compile server);
|
|
13
|
-
- **
|
|
13
|
+
- **forks** to CodeSandbox (React) and StackBlitz (Vue) that keep the demo's folder structure;
|
|
14
|
+
- **docs per framework**: one URL tree per framework, links written once and
|
|
15
|
+
mapped at build time, a switcher that remembers the visitor's choice;
|
|
16
|
+
- **showcase demos** for marketing pages: a scripted cursor that drives a live
|
|
17
|
+
component until the visitor takes over, and a poster-first lazy loader.
|
|
14
18
|
|
|
15
19
|
One package, with subpath exports:
|
|
16
20
|
|
|
17
21
|
| Subpath | What |
|
|
18
22
|
|---|---|
|
|
19
23
|
| `/code` | regions, highlight markers, shiki transformers and `highlightCode`, demo file collection |
|
|
20
|
-
| `/remark` | `remarkDemoFences`: `file=` / `region=` / `live` / `lines` / `height` fences |
|
|
24
|
+
| `/remark` | `remarkDemoFences`: `file=` / `region=` / `live` / `lines` / `height` fences; `remarkFrameworkLinks`, `remarkFrameworkText` |
|
|
21
25
|
| `/demos` | the demo builder (`buildDemos`, `docs-kit demos` CLI), config types, `compileDemo` |
|
|
22
26
|
| `/demos/client` | browser-side compilers (`browser` worker or `remote`) |
|
|
23
27
|
| `/react` | `Demo` (server component), `DemoShell` (client card), `createDemoComponents` |
|
|
24
28
|
| `/react/styles.css` | the card styles (CSS custom properties) |
|
|
25
|
-
| `/fork` | CodeSandbox
|
|
29
|
+
| `/fork` | fork payloads: CodeSandbox for React demos, StackBlitz (Vite) for Vue demos |
|
|
30
|
+
| `/frameworks` | framework routing: path mapping, link and switch targets, sidebar mapping, the stored preference |
|
|
31
|
+
| `/frameworks/react` | `FrameworkSwitcher`, `FrameworkBanner`, `FrameworkLinks`, `createFrameworkContent` |
|
|
32
|
+
| `/frameworks/styles.css` | their styles (same CSS custom properties) |
|
|
33
|
+
| `/showcase` | `AutomatedDemo`, `LazyShowcase`, the scripted cursor toolkit and its hooks |
|
|
34
|
+
| `/showcase/styles.css` | the cursor, pill and poster styles (CSS custom properties) |
|
|
26
35
|
|
|
27
36
|
## Fences
|
|
28
37
|
|
|
@@ -102,6 +111,64 @@ Every bare import found in the demos becomes an import-map entry. They are
|
|
|
102
111
|
built in one split esbuild pass, so React exists once. Configured libraries
|
|
103
112
|
come from source, so the docs can show features before they ship.
|
|
104
113
|
|
|
114
|
+
### Vue demos
|
|
115
|
+
|
|
116
|
+
A framework under `frameworks` is built next to the primary one, from sibling
|
|
117
|
+
files: `basic.demo.vue` next to `basic.demo.tsx`.
|
|
118
|
+
|
|
119
|
+
```js
|
|
120
|
+
export default {
|
|
121
|
+
libraries: { '@acme/grid-react': { entry: '../source/src/index.tsx' } },
|
|
122
|
+
// …
|
|
123
|
+
frameworks: {
|
|
124
|
+
vue: {
|
|
125
|
+
libraries: { '@acme/grid-vue': { entry: '../source/src/index.vue.tsx' } },
|
|
126
|
+
stubImports: [/^@acme\/grid-vue\/.*\.css$/],
|
|
127
|
+
bootstrap: 'src/demo-bootstrap-vue.ts',
|
|
128
|
+
routeForPage: (pagePath) => `/vue/${pagePath}`, // the demo's "see it in the docs" link
|
|
129
|
+
fork: { dependencies: { '@acme/grid-vue': '1.2.3' }, entryPrelude: "import '@acme/grid-vue/index.css';" },
|
|
130
|
+
},
|
|
131
|
+
},
|
|
132
|
+
};
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
- The primary framework keeps `public/gen/demos` and its URLs. Vue goes to
|
|
136
|
+
`public/gen/demos/_vue`, with its own import map (`vue`, `vue/jsx-runtime`,
|
|
137
|
+
the library), runtime and `manifest.json`.
|
|
138
|
+
- `libraries`, `include`, `stubImports`, `bootstrap`, `css` and `fork` belong
|
|
139
|
+
to a framework, so Vue starts without them. Everything else (`define`,
|
|
140
|
+
themes, `fenceDefaults`, …) is shared.
|
|
141
|
+
- Single-file components are compiled with `@vue/compiler-sfc`: `<script>` and
|
|
142
|
+
`<script setup>` in JS or TS, `<template>`, plain-CSS `<style>` (also
|
|
143
|
+
`scoped`). Preprocessors (`lang="scss"`, pug), `src=` blocks and CSS modules
|
|
144
|
+
fail the build with a message. Library source and `.tsx` files that a demo
|
|
145
|
+
imports are compiled with Vue's automatic JSX.
|
|
146
|
+
- `vue` and `@vue/compiler-sfc` are **optional peer dependencies**: install
|
|
147
|
+
them in the site (`npm i vue && npm i -D @vue/compiler-sfc`). A site without
|
|
148
|
+
a Vue framework never loads them.
|
|
149
|
+
- Editing works the same: a second compile worker, with the Vue compiler's
|
|
150
|
+
browser build, is loaded on the first edit of a Vue demo.
|
|
151
|
+
- **fork** opens a Vite + Vue + TypeScript project on StackBlitz (it runs in
|
|
152
|
+
the browser, with no sign-in). `fork.dependencies`, `entryPrelude` and
|
|
153
|
+
`styles` apply as for React.
|
|
154
|
+
- Type-check the components with `vue-tsc` (see `fixtures/site/tsconfig.vue.json`).
|
|
155
|
+
|
|
156
|
+
In a `.vue` file, markers also work as HTML comments, for the template:
|
|
157
|
+
|
|
158
|
+
```vue
|
|
159
|
+
<template>
|
|
160
|
+
<!-- #region grid -->
|
|
161
|
+
<!-- #highlight the DataSource holds the data -->
|
|
162
|
+
<DataSource :data="rows" primaryKey="id">
|
|
163
|
+
<Grid :columns="columns" /> <!-- #highlight -->
|
|
164
|
+
</DataSource>
|
|
165
|
+
<!-- #endregion -->
|
|
166
|
+
</template>
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
A region of a component is highlighted as the block it comes from (script,
|
|
170
|
+
template or style).
|
|
171
|
+
|
|
105
172
|
## Rendering (Next.js)
|
|
106
173
|
|
|
107
174
|
```tsx
|
|
@@ -121,6 +188,88 @@ createDemoComponents({ contentDir, folder: page.folderPath, manifest: 'public/ge
|
|
|
121
188
|
- `banInlineCode` is on by default;
|
|
122
189
|
- `staticFences: 'shiki-meta' | 'card'`. Use `shiki-meta` with `@shikijs/rehype` and `fenceTransformers()` from `/code`.
|
|
123
190
|
|
|
191
|
+
## Docs per framework
|
|
192
|
+
|
|
193
|
+
The default framework keeps its URLs (`/docs/...`). Every other framework has
|
|
194
|
+
its own tree under a prefix (`/vue/docs/...`). Pages and links are written
|
|
195
|
+
once, in the default form.
|
|
196
|
+
|
|
197
|
+
```ts
|
|
198
|
+
import { createHasPage, defineFrameworks, mapRouteTree } from '@thedatagrid/docs-kit/frameworks';
|
|
199
|
+
|
|
200
|
+
export const frameworksConfig = {
|
|
201
|
+
default: 'react',
|
|
202
|
+
frameworks: { react: { label: 'React', prefix: '' }, vue: { label: 'Vue', prefix: '/vue' } },
|
|
203
|
+
roots: ['/docs'], // everything else (blog, pricing) is shared
|
|
204
|
+
};
|
|
205
|
+
export const frameworks = defineFrameworks(frameworksConfig);
|
|
206
|
+
// which pages each framework has, by neutral path; no list = every page
|
|
207
|
+
export const hasPage = createHasPage({ vue: ['/docs', '/docs/learn/getting-started'] });
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
Rendering a page for a framework:
|
|
211
|
+
|
|
212
|
+
```tsx
|
|
213
|
+
remarkPlugins: [
|
|
214
|
+
// the package name in prose, inline code and link URLs
|
|
215
|
+
remarkFrameworkText({ replacements: framework === 'vue' ? { '@acme/grid-react': '@acme/grid-vue' } : {} }),
|
|
216
|
+
// /docs/x → /vue/docs/x; a page Vue doesn't have → the React page, marked
|
|
217
|
+
// data-framework-fallback="react"; no page in any framework → build error
|
|
218
|
+
remarkFrameworkLinks({ frameworks, framework, hasPage, jsxAttributes: { Card: ['path'] } }),
|
|
219
|
+
remarkDemoFences({
|
|
220
|
+
contentDir,
|
|
221
|
+
folder,
|
|
222
|
+
// file="basic.demo.tsx" shows basic.demo.vue on the Vue page
|
|
223
|
+
siblings: framework === 'vue' ? { '.demo.tsx': '.demo.vue', '.snippet.tsx': ['.snippet.vue', '.snippet.vue.ts'] } : undefined,
|
|
224
|
+
}),
|
|
225
|
+
];
|
|
226
|
+
|
|
227
|
+
// MDX components
|
|
228
|
+
createDemoComponents({
|
|
229
|
+
contentDir,
|
|
230
|
+
folder,
|
|
231
|
+
manifest: framework === 'vue' ? 'public/gen/demos/_vue/manifest.json' : 'public/gen/demos/manifest.json',
|
|
232
|
+
// a fence without a sibling shows the React demo, with this notice on the card
|
|
233
|
+
fallback: framework === 'vue' ? { manifest: 'public/gen/demos/manifest.json', notice: 'React only for now' } : undefined,
|
|
234
|
+
});
|
|
235
|
+
// <FrameworkContent framework="vue"> … </FrameworkContent> for what differs
|
|
236
|
+
const FrameworkContent = createFrameworkContent(framework);
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
A fence whose code is the same for every framework opts out of the sibling
|
|
240
|
+
lookup (and the notice) with `neutral`.
|
|
241
|
+
|
|
242
|
+
The sidebar: `mapRouteTree(frameworks, routes, 'vue', hasPage)` points every
|
|
243
|
+
entry at the framework's page. A page it doesn't have keeps its entry, links to
|
|
244
|
+
the framework that has it and gets `fallbackFramework` (or pass
|
|
245
|
+
`onFallback` / `missing: 'hide'`).
|
|
246
|
+
|
|
247
|
+
In the layout (client components, from `/frameworks/react`):
|
|
248
|
+
|
|
249
|
+
```tsx
|
|
250
|
+
import '@thedatagrid/docs-kit/frameworks/styles.css';
|
|
251
|
+
|
|
252
|
+
<FrameworkSwitcher config={frameworksConfig} pages={pages} pathname={pathname} navigate={router.push} />
|
|
253
|
+
<FrameworkBanner config={frameworksConfig} pages={pages} pathname={pathname} navigate={router.push} />
|
|
254
|
+
<FrameworkLinks config={frameworksConfig} pages={pages} navigate={router.push} />
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
- **`FrameworkSwitcher`**: each option links to the same page in that
|
|
258
|
+
framework, or to the nearest parent that exists there. Clicking one stores
|
|
259
|
+
the choice in `localStorage` (`storageKey`, default `docs-framework`).
|
|
260
|
+
- **`FrameworkLinks`** makes navigation follow a stored choice: a click on a
|
|
261
|
+
docs link of another framework goes to the visitor's framework when the page
|
|
262
|
+
exists there. Without a stored choice, a Vue page keeps its visitors in the
|
|
263
|
+
Vue docs, and nothing else is rewritten.
|
|
264
|
+
- **`FrameworkBanner`** shows when a page's framework isn't the visitor's: a
|
|
265
|
+
link to the page in their framework, or a notice that it doesn't exist there
|
|
266
|
+
yet. It never redirects, so shared links stay stable and crawlers see one
|
|
267
|
+
page per URL.
|
|
268
|
+
|
|
269
|
+
Styling: `.dk-framework-switcher`, `.dk-framework-option`,
|
|
270
|
+
`.dk-framework-banner*`, and `a[data-framework-fallback]::after` for the
|
|
271
|
+
fallback badge, whose text is `--dk-framework-fallback-label`.
|
|
272
|
+
|
|
124
273
|
## Editing
|
|
125
274
|
|
|
126
275
|
The card's **edit** button lazy-loads CodeMirror. Each change is rebuilt by
|
|
@@ -219,6 +368,59 @@ with unscoped `!important` rules on `.cm-*` classes, such as
|
|
|
219
368
|
`.cm-gutters { … !important }` written for another editor, still overrides
|
|
220
369
|
them. Scope those rules to their own editor (e.g. `.sp-wrapper .cm-gutters`).
|
|
221
370
|
|
|
371
|
+
## Showcase demos
|
|
372
|
+
|
|
373
|
+
`/showcase` is for a live demo on a marketing page that plays by itself and
|
|
374
|
+
can be taken over. It knows nothing about the product: it only needs React.
|
|
375
|
+
Import `@thedatagrid/docs-kit/showcase/styles.css` once.
|
|
376
|
+
|
|
377
|
+
```tsx
|
|
378
|
+
'use client';
|
|
379
|
+
import { AutomatedDemo, sleep, type ShowcaseScriptContext } from '@thedatagrid/docs-kit/showcase';
|
|
380
|
+
import '@thedatagrid/docs-kit/showcase/styles.css';
|
|
381
|
+
|
|
382
|
+
async function run({ root, cursor, signal }: ShowcaseScriptContext) {
|
|
383
|
+
const header = root.querySelector<HTMLElement>('[data-column="price"]')!;
|
|
384
|
+
await cursor.moveToElement(header, signal);
|
|
385
|
+
await cursor.click(signal, header); // dispatches a real pointer + click sequence
|
|
386
|
+
await sleep(2000, signal);
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
<AutomatedDemo ready={gridIsReady} run={run} reset={resetDemoState} waitForSelector=".grid-cell">
|
|
390
|
+
<LiveGrid />
|
|
391
|
+
</AutomatedDemo>;
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
- `AutomatedDemo` runs `run` in a loop while the demo is in view and the tab
|
|
395
|
+
is visible, calling `reset` before each pass. The first real interaction
|
|
396
|
+
(pointer, wheel, touch or key) stops the script and leaves the demo as it
|
|
397
|
+
is; a "replay" pill starts it again. It never starts on touch devices, under
|
|
398
|
+
`minViewportWidth` (768 by default) or with reduced motion.
|
|
399
|
+
- Every helper takes the `signal` and throws `ScriptCancelled` when the show is
|
|
400
|
+
stopped, so a script needs no cleanup code. A script that throws anything
|
|
401
|
+
else ends the show quietly.
|
|
402
|
+
- The cursor: `moveTo`, `moveToElement`, `hover`, `click`, `drag`, `setLabel`.
|
|
403
|
+
Also exported: `sleep`, `waitFor`, `tween`, `fling` (an inertial scroll),
|
|
404
|
+
`dispatchClickSequence`, `dispatchHover`, and the hooks `useInView`,
|
|
405
|
+
`usePageVisible`, `usePrefersReducedMotion`, `useMediaQuery`.
|
|
406
|
+
- `LazyShowcase` paints a `poster` first, imports the live demo when its
|
|
407
|
+
container is near the viewport and the page is idle, and cross-fades to it
|
|
408
|
+
once the demo calls `onReady`. Give it a `height` (or a className that sets
|
|
409
|
+
one) so nothing shifts.
|
|
410
|
+
|
|
411
|
+
```tsx
|
|
412
|
+
<LazyShowcase
|
|
413
|
+
load={() => import('./HeroDemo')}
|
|
414
|
+
props={{ autoplay: true }}
|
|
415
|
+
poster={<img src="/hero-poster.webp" alt="" />}
|
|
416
|
+
height={640}
|
|
417
|
+
/>
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
Theme it with `--showcase-accent`, `--showcase-pill-bg`, `--showcase-pill-fg`,
|
|
421
|
+
`--showcase-pill-border` and `--showcase-z` (the base z-index of the cursor
|
|
422
|
+
layer).
|
|
423
|
+
|
|
222
424
|
## Editor extension (VS Code, Cursor)
|
|
223
425
|
|
|
224
426
|
The package includes a small extension, **docs-kit links**. In a docs page, Cmd/Ctrl+click
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"demoFiles.d.ts","sourceRoot":"","sources":["../../src/code/demoFiles.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,kBAAkB,
|
|
1
|
+
{"version":3,"file":"demoFiles.d.ts","sourceRoot":"","sources":["../../src/code/demoFiles.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,kBAAkB,UAAsE,CAAC;AAetG,MAAM,MAAM,cAAc,GAAG;IAC3B,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc,EAAE,CAmBpE;AAED,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/code/demoFiles.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import fs from 'node:fs';
|
|
2
2
|
import path from 'node:path';
|
|
3
3
|
const IMPORT_RE = /(?:import|export)\s[^'"]*?from\s+['"](\.\.?\/[^'"]+)['"]|import\s*\(?\s*['"](\.\.?\/[^'"]+)['"]/g;
|
|
4
|
-
export const RESOLVE_EXTENSIONS = ['', '.tsx', '.ts', '.jsx', '.js', '.mjs', '.css', '.json'];
|
|
4
|
+
export const RESOLVE_EXTENSIONS = ['', '.tsx', '.ts', '.jsx', '.js', '.mjs', '.vue', '.css', '.json'];
|
|
5
5
|
function resolveRelativeImport(fromDir, specifier) {
|
|
6
6
|
const base = path.resolve(fromDir, specifier);
|
|
7
7
|
for (const ext of RESOLVE_EXTENSIONS) {
|
|
@@ -30,7 +30,7 @@ export function collectDemoFiles(entryFile) {
|
|
|
30
30
|
visited.add(filePath);
|
|
31
31
|
const source = fs.readFileSync(filePath, 'utf8');
|
|
32
32
|
ordered.push({ filePath, source });
|
|
33
|
-
if (!/\.(?:[cm]?[jt]sx
|
|
33
|
+
if (!/\.(?:[cm]?[jt]sx?|vue)$/.test(filePath))
|
|
34
34
|
return;
|
|
35
35
|
for (const match of source.matchAll(IMPORT_RE)) {
|
|
36
36
|
const specifier = match[1] ?? match[2];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"demoFiles.js","sourceRoot":"","sources":["../../src/code/demoFiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,SAAS,GACb,kGAAkG,CAAC;AAErG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"demoFiles.js","sourceRoot":"","sources":["../../src/code/demoFiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,SAAS,GACb,kGAAkG,CAAC;AAErG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtG,SAAS,qBAAqB,CAAC,OAAe,EAAE,SAAiB;IAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9C,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACrC,MAAM,SAAS,GAAG,IAAI,GAAG,GAAG,CAAC;QAC7B,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE;YAAE,OAAO,SAAS,CAAC;IACpF,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,EAAE,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAiB;IAChD,MAAM,OAAO,GAAqB,EAAE,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAE,EAAE;QACjC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;YAAE,OAAO;QAClC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjD,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QACnC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO;QACtD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAC1E,IAAI,QAAQ;gBAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACH,CAAC,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,CAAC;IACjB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/code/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export { applySourceReplacements, dedent, extractCodeMarkers, listRegionNames, sliceRegion, stripCodeMarkers, type CodeWithMarkers, type SlicedRange, } from './regions.ts';
|
|
2
2
|
export { HEIGHT_META_RE, HIGHLIGHT_META_RE, LINES_META_RE, ORIGINAL_LINES_META_RE, formatHighlightSpec, parseHighlightMeta, parseHighlightSpec, type HighlightAnnotation, type HighlightSpec, } from './highlightSpec.ts';
|
|
3
3
|
export { formatLineRanges, parseLineRanges } from './lineRanges.ts';
|
|
4
|
+
export { vueBlockLang } from './vueBlocks.ts';
|
|
4
5
|
export { DEMO_HEIGHTS, parseDemoHeight, type DemoHeight, type DemoHeightName, type DemoHeights, } from './heights.ts';
|
|
5
6
|
export { DEFAULT_CODE_THEMES, dirnameOf, fenceTransformers, highlightCode, joinPath, langForFile, matchImportedFile, transformerHeightMeta, transformerImportFileLinks, transformerLineHighlight, transformerLineNumbers, type CodeThemes, type HighlightOptions, } from './shiki.ts';
|
|
6
7
|
export { collectDemoFiles, RESOLVE_EXTENSIONS, type DemoSourceFile } from './demoFiles.ts';
|
package/dist/code/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/code/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,mBAAmB,EACxB,KAAK,aAAa,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EACL,YAAY,EACZ,eAAe,EACf,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,EACtB,KAAK,UAAU,EACf,KAAK,gBAAgB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/code/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,mBAAmB,EACxB,KAAK,aAAa,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,WAAW,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,EACtB,KAAK,UAAU,EACf,KAAK,gBAAgB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/code/index.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export { applySourceReplacements, dedent, extractCodeMarkers, listRegionNames, sliceRegion, stripCodeMarkers, } from "./regions.js";
|
|
2
2
|
export { HEIGHT_META_RE, HIGHLIGHT_META_RE, LINES_META_RE, ORIGINAL_LINES_META_RE, formatHighlightSpec, parseHighlightMeta, parseHighlightSpec, } from "./highlightSpec.js";
|
|
3
3
|
export { formatLineRanges, parseLineRanges } from "./lineRanges.js";
|
|
4
|
+
export { vueBlockLang } from "./vueBlocks.js";
|
|
4
5
|
export { DEMO_HEIGHTS, parseDemoHeight, } from "./heights.js";
|
|
5
6
|
export { DEFAULT_CODE_THEMES, dirnameOf, fenceTransformers, highlightCode, joinPath, langForFile, matchImportedFile, transformerHeightMeta, transformerImportFileLinks, transformerLineHighlight, transformerLineNumbers, } from "./shiki.js";
|
|
6
7
|
export { collectDemoFiles, RESOLVE_EXTENSIONS } from "./demoFiles.js";
|
package/dist/code/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/code/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,gBAAgB,GAGjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,GAGnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EACL,YAAY,EACZ,eAAe,GAIhB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,GAGvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAuB,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/code/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,MAAM,EACN,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,gBAAgB,GAGjB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,GAGnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,GAIhB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,mBAAmB,EACnB,SAAS,EACT,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,WAAW,EACX,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,GAGvB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAuB,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/code/regions.d.ts
CHANGED
|
@@ -32,7 +32,8 @@ export type CodeWithMarkers = SlicedRange & {
|
|
|
32
32
|
* With a label, the opening marker becomes an empty highlighted line that
|
|
33
33
|
* shows the label; without one it is removed.
|
|
34
34
|
* - `code // #highlight label` highlights that single line.
|
|
35
|
-
* - `/* …
|
|
35
|
+
* - `/* … *\/`, `{/* … *\/}` (JSX children) and `<!-- … -->` (HTML, Vue templates)
|
|
36
|
+
* work for both forms.
|
|
36
37
|
* - `#region` / `#endregion` lines are dropped, so full-file views don't show them.
|
|
37
38
|
*
|
|
38
39
|
* `originalLines` (from `sliceRegion`) is kept in step with the removed lines.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"regions.d.ts","sourceRoot":"","sources":["../../src/code/regions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAyCF,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAM9C;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CASxD;AAqCD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CAgBtF;
|
|
1
|
+
{"version":3,"file":"regions.d.ts","sourceRoot":"","sources":["../../src/code/regions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAyCF,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAM9C;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CASxD;AAqCD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,CAgBtF;AAkBD,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C,kGAAkG;IAClG,SAAS,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,MAAM,EAAE,GACvB,eAAe,CAuEjB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,GAC/C,MAAM,CAOR"}
|
package/dist/code/regions.js
CHANGED
|
@@ -112,11 +112,14 @@ export function sliceRegion(source, spec, context) {
|
|
|
112
112
|
}
|
|
113
113
|
return extracted;
|
|
114
114
|
}
|
|
115
|
-
/**
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
const
|
|
115
|
+
/**
|
|
116
|
+
* Whole-line `// #highlight label`, `/* #highlight label *\/`, `{/* #highlight label *\/}`
|
|
117
|
+
* or, in HTML and Vue templates, `<!-- #highlight label -->`.
|
|
118
|
+
*/
|
|
119
|
+
const HIGHLIGHT_START_RE = /^\s*(?:\/\/\s*#highlight\b(.*)|\{?\/\*\s*#highlight\b(.*?)\*\/\}?|<!--\s*#highlight\b(.*?)-->)\s*$/;
|
|
120
|
+
const HIGHLIGHT_END_RE = /^\s*(?:\/\/\s*#endhighlight\b.*|\{?\/\*\s*#endhighlight\b.*?\*\/\}?|<!--\s*#endhighlight\b.*?-->)\s*$/;
|
|
121
|
+
/** Trailing `code // #highlight label` (or a `/* … *\/`, `{/* … *\/}` or `<!-- … -->` comment) after code. */
|
|
122
|
+
const HIGHLIGHT_INLINE_RE = /^(.*?\S)\s*(?:\/\/\s*#highlight\b(.*)|\{\/\*\s*#highlight\b(.*?)\*\/\}|\/\*\s*#highlight\b(.*?)\*\/|<!--\s*#highlight\b(.*?)-->)\s*$/;
|
|
120
123
|
function isRegionMarker(line) {
|
|
121
124
|
return REGION_MARKERS.some((re) => re.start.test(line) || re.end.test(line));
|
|
122
125
|
}
|
|
@@ -129,7 +132,8 @@ function isRegionMarker(line) {
|
|
|
129
132
|
* With a label, the opening marker becomes an empty highlighted line that
|
|
130
133
|
* shows the label; without one it is removed.
|
|
131
134
|
* - `code // #highlight label` highlights that single line.
|
|
132
|
-
* - `/* …
|
|
135
|
+
* - `/* … *\/`, `{/* … *\/}` (JSX children) and `<!-- … -->` (HTML, Vue templates)
|
|
136
|
+
* work for both forms.
|
|
133
137
|
* - `#region` / `#endregion` lines are dropped, so full-file views don't show them.
|
|
134
138
|
*
|
|
135
139
|
* `originalLines` (from `sliceRegion`) is kept in step with the removed lines.
|
|
@@ -167,7 +171,7 @@ export function extractCodeMarkers(source, context, originalLines) {
|
|
|
167
171
|
if (block) {
|
|
168
172
|
throw new Error(`${context}: the \`#highlight\` on line ${block.fileLine} has no code line before the \`#highlight\` on line ${fileLine}`);
|
|
169
173
|
}
|
|
170
|
-
const label = (start[1] ?? start[2] ?? '').trim();
|
|
174
|
+
const label = (start[1] ?? start[2] ?? start[3] ?? '').trim();
|
|
171
175
|
if (label) {
|
|
172
176
|
// the label row keeps the marker's indentation, so the label lines up with the block
|
|
173
177
|
kept.push(/^\s*/.exec(text)[0]);
|
|
@@ -193,7 +197,7 @@ export function extractCodeMarkers(source, context, originalLines) {
|
|
|
193
197
|
kept.push(inline ? inline[1] : text);
|
|
194
198
|
keptLines.push(fileLine);
|
|
195
199
|
if (inline)
|
|
196
|
-
mark((inline[2] ?? inline[3] ?? inline[4] ?? '').trim());
|
|
200
|
+
mark((inline[2] ?? inline[3] ?? inline[4] ?? inline[5] ?? '').trim());
|
|
197
201
|
if (block) {
|
|
198
202
|
mark('');
|
|
199
203
|
if (block.nextLineOnly && text.trim())
|
package/dist/code/regions.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"regions.js","sourceRoot":"","sources":["../../src/code/regions.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,MAAM,cAAc,GAAqC;IACvD;QACE,KAAK,EAAE,mCAAmC;QAC1C,GAAG,EAAE,sCAAsC;KAC5C;IACD;QACE,KAAK,EAAE,qCAAqC;QAC5C,GAAG,EAAE,wCAAwC;KAC9C;IACD;QACE,KAAK,EAAE,2CAA2C;QAClD,GAAG,EAAE,8CAA8C;KACpD;IACD;QACE,KAAK,EAAE,8BAA8B;QACrC,GAAG,EAAE,sCAAsC;KAC5C;IACD;QACE,KAAK,EAAE,gCAAgC;QACvC,GAAG,EAAE,mCAAmC;KACzC;IACD;QACE,KAAK,EAAE,6CAA6C;QACpD,GAAG,EAAE,gDAAgD;KACtD;IACD;QACE,KAAK,EAAE,oCAAoC;QAC3C,GAAG,EAAE,uCAAuC;KAC7C;IACD;QACE,KAAK,EAAE,qCAAqC;QAC5C,GAAG,EAAE,wCAAwC;KAC9C;CACF,CAAC;AAEF,MAAM,UAAU,MAAM,CAAC,KAAe;IACpC,MAAM,OAAO,GAAG,KAAK;SAClB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAc,EAAE,UAAkB;IAC5D,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,IAAI,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,UAAU;gBAAE,SAAS;YACxC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,MAAM,aAAa,GAAa,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,EAAE,CAAC;oBACR,SAAS;gBACX,CAAC;gBACD,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;wBAC5B,KAAK,GAAG,CAAC,CAAC;oBACZ,CAAC;yBAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;wBAC3B,KAAK,EAAE,CAAC;oBACV,CAAC;yBAAM,CAAC;wBACN,SAAS;oBACX,CAAC;oBACD,IAAI,KAAK,GAAG,CAAC;wBAAE,SAAS;oBACxB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;gBAC3D,CAAC;gBACD,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5B,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,IAAY,EAAE,OAAe;IACvE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,uBAAuB,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM;YACvB,CAAC,CAAC,oBAAoB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YAC9D,CAAC,CAAC,qCAAqC,CAAC;QAC1C,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,eAAe,IAAI,iBAAiB,IAAI,cAAc,IAAI,IAAI;YACtE,4BAA4B,IAAI,uBAAuB,CAC1D,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"regions.js","sourceRoot":"","sources":["../../src/code/regions.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,MAAM,cAAc,GAAqC;IACvD;QACE,KAAK,EAAE,mCAAmC;QAC1C,GAAG,EAAE,sCAAsC;KAC5C;IACD;QACE,KAAK,EAAE,qCAAqC;QAC5C,GAAG,EAAE,wCAAwC;KAC9C;IACD;QACE,KAAK,EAAE,2CAA2C;QAClD,GAAG,EAAE,8CAA8C;KACpD;IACD;QACE,KAAK,EAAE,8BAA8B;QACrC,GAAG,EAAE,sCAAsC;KAC5C;IACD;QACE,KAAK,EAAE,gCAAgC;QACvC,GAAG,EAAE,mCAAmC;KACzC;IACD;QACE,KAAK,EAAE,6CAA6C;QACpD,GAAG,EAAE,gDAAgD;KACtD;IACD;QACE,KAAK,EAAE,oCAAoC;QAC3C,GAAG,EAAE,uCAAuC;KAC7C;IACD;QACE,KAAK,EAAE,qCAAqC;QAC5C,GAAG,EAAE,wCAAwC;KAC9C;CACF,CAAC;AAEF,MAAM,UAAU,MAAM,CAAC,KAAe;IACpC,MAAM,OAAO,GAAG,KAAK;SAClB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAc,EAAE,UAAkB;IAC5D,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,IAAI,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,UAAU;gBAAE,SAAS;YACxC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,MAAM,cAAc,GAAa,EAAE,CAAC;YACpC,MAAM,aAAa,GAAa,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxC,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,EAAE,CAAC;oBACR,SAAS;gBACX,CAAC;gBACD,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;wBAC5B,KAAK,GAAG,CAAC,CAAC;oBACZ,CAAC;yBAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;wBAC3B,KAAK,EAAE,CAAC;oBACV,CAAC;yBAAM,CAAC;wBACN,SAAS;oBACX,CAAC;oBACD,IAAI,KAAK,GAAG,CAAC;wBAAE,SAAS;oBACxB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;gBAC3D,CAAC;gBACD,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5B,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,IAAY,EAAE,OAAe;IACvE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,uBAAuB,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM;YACvB,CAAC,CAAC,oBAAoB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YAC9D,CAAC,CAAC,qCAAqC,CAAC;QAC1C,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,eAAe,IAAI,iBAAiB,IAAI,cAAc,IAAI,IAAI;YACtE,4BAA4B,IAAI,uBAAuB,CAC1D,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,kBAAkB,GACtB,oGAAoG,CAAC;AACvG,MAAM,gBAAgB,GACpB,uGAAuG,CAAC;AAC1G,8GAA8G;AAC9G,MAAM,mBAAmB,GACvB,sIAAsI,CAAC;AAEzI,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/E,CAAC;AAOD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAc,EACd,OAAe,EACf,aAAwB;IAExB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,UAAU,GAAG,aAAa,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACvE,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,SAAS,GAAkB,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC3D,mGAAmG;IACnG,IAAI,KAAK,GAAyE,IAAI,CAAC;IAEvF,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACvE,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAE,EAAE;QAC9C,KAAK,IAAI,KAAK,GAAG,UAAU,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;YAC/D,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAC;YACrD,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC1D,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,KAAK,EAAE,CAAC;YACV,gGAAgG;YAChG,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,gCAAgC,KAAK,CAAC,QAAQ,uDAAuD,QAAQ,EAAE,CAC1H,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9D,IAAI,KAAK,EAAE,CAAC;gBACV,qFAAqF;gBACrF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzB,IAAI,CAAC,KAAK,CAAC,CAAC;YACd,CAAC;YACD,KAAK,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,YAAY,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YACxF,SAAS;QACX,CAAC;QACD,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,+BAA+B,QAAQ,iCAAiC,CAAC,CAAC;YACtG,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,sCAAsC,KAAK,CAAC,QAAQ,WAAW,CAAC,CAAC;YAC7F,CAAC;YACD,KAAK,GAAG,IAAI,CAAC;YACb,SAAS;QACX,CAAC;QACD,IAAI,cAAc,CAAC,IAAI,CAAC;YAAE,SAAS;QAEnC,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,IAAI,MAAM;YAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAClF,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,EAAE,CAAC,CAAC;YACT,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,EAAE;gBAAE,KAAK,GAAG,IAAI,CAAC;QACtD,CAAC;IACH,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,gCAAgC,KAAK,CAAC,QAAQ,4BAA4B,CAAC,CAAC;IACxG,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC;YAAE,SAAS;QACnG,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAc,EACd,YAAgD;IAEhD,IAAI,CAAC,YAAY;QAAE,OAAO,MAAM,CAAC;IACjC,IAAI,MAAM,GAAG,MAAM,CAAC;IACpB,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACjE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vueBlocks.d.ts","sourceRoot":"","sources":["../../src/code/vueBlocks.ts"],"names":[],"mappings":"AAOA,qFAAqF;AACrF,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAgBjE"}
|
|
@@ -0,0 +1,29 @@
|
|
|
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
|
+
/** `line` is 1-based. Lines outside every block (or a whole-file view) are `vue`. */
|
|
8
|
+
export function vueBlockLang(source, line) {
|
|
9
|
+
const lines = source.split('\n');
|
|
10
|
+
let current = null;
|
|
11
|
+
for (let index = 0; index < Math.min(line, lines.length); index++) {
|
|
12
|
+
const open = BLOCK_OPEN_RE.exec(lines[index]);
|
|
13
|
+
if (open) {
|
|
14
|
+
current = { tag: open[1], attrs: open[2] };
|
|
15
|
+
continue;
|
|
16
|
+
}
|
|
17
|
+
if (current && lines[index].startsWith(`</${current.tag}>`))
|
|
18
|
+
current = null;
|
|
19
|
+
}
|
|
20
|
+
if (!current)
|
|
21
|
+
return 'vue';
|
|
22
|
+
if (current.tag === 'template')
|
|
23
|
+
return 'vue-html';
|
|
24
|
+
const lang = /\blang=["']([\w-]+)["']/.exec(current.attrs)?.[1];
|
|
25
|
+
if (current.tag === 'style')
|
|
26
|
+
return lang ?? 'css';
|
|
27
|
+
return lang ?? 'js';
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=vueBlocks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"vueBlocks.js","sourceRoot":"","sources":["../../src/code/vueBlocks.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,aAAa,GAAG,qCAAqC,CAAC;AAE5D,qFAAqF;AACrF,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAY;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,OAAO,GAA0C,IAAI,CAAC;IAC1D,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QAClE,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,SAAS;QACX,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,KAAK,OAAO,CAAC,GAAG,GAAG,CAAC;YAAE,OAAO,GAAG,IAAI,CAAC;IAC9E,CAAC;IACD,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAC3B,IAAI,OAAO,CAAC,GAAG,KAAK,UAAU;QAAE,OAAO,UAAU,CAAC;IAClD,MAAM,IAAI,GAAG,yBAAyB,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChE,IAAI,OAAO,CAAC,GAAG,KAAK,OAAO;QAAE,OAAO,IAAI,IAAI,KAAK,CAAC;IAClD,OAAO,IAAI,IAAI,IAAI,CAAC;AACtB,CAAC"}
|
package/dist/demos/build.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DemoManifest, DocsKitConfig } from './config.ts';
|
|
1
|
+
import type { DemoFramework, DemoManifest, DocsKitConfig } from './config.ts';
|
|
2
2
|
export type BuildDemosOptions = {
|
|
3
3
|
config: DocsKitConfig;
|
|
4
4
|
/** Folder of the config file; `config.root` resolves against it. */
|
|
@@ -7,8 +7,11 @@ export type BuildDemosOptions = {
|
|
|
7
7
|
log?: (message: string) => void;
|
|
8
8
|
};
|
|
9
9
|
export type BuildDemosResult = {
|
|
10
|
+
/** The primary framework's manifest. */
|
|
10
11
|
manifest: DemoManifest;
|
|
11
|
-
/**
|
|
12
|
+
/** Every framework's manifest. */
|
|
13
|
+
manifests: Partial<Record<DemoFramework, DemoManifest>>;
|
|
14
|
+
/** Ids whose page changed in the last build (primary framework). */
|
|
12
15
|
changed: string[];
|
|
13
16
|
/** Watch mode: stops watching and disposes the esbuild contexts. */
|
|
14
17
|
close(): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/demos/build.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/demos/build.ts"],"names":[],"mappings":"AA8BA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAkC,MAAM,aAAa,CAAC;AAgE9G,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,aAAa,CAAC;IACtB,oEAAoE;IACpE,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wCAAwC;IACxC,QAAQ,EAAE,YAAY,CAAC;IACvB,kCAAkC;IAClC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;IACxD,oEAAoE;IACpE,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,oEAAoE;IACpE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAubF,wBAAsB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAyHtF"}
|