@thedatagrid/docs-kit 0.0.0-stage → 0.1.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 +7 -0
- package/README.md +123 -2
- package/dist/code/demoFiles.d.ts +14 -0
- package/dist/code/demoFiles.d.ts.map +1 -0
- package/dist/code/demoFiles.js +46 -0
- package/dist/code/demoFiles.js.map +1 -0
- package/dist/code/heights.d.ts +17 -0
- package/dist/code/heights.d.ts.map +1 -0
- package/dist/code/heights.js +40 -0
- package/dist/code/heights.js.map +1 -0
- package/dist/code/highlightSpec.d.ts +34 -0
- package/dist/code/highlightSpec.d.ts.map +1 -0
- package/dist/code/highlightSpec.js +119 -0
- package/dist/code/highlightSpec.js.map +1 -0
- package/dist/code/imports.d.ts +5 -0
- package/dist/code/imports.d.ts.map +1 -0
- package/dist/code/imports.js +17 -0
- package/dist/code/imports.js.map +1 -0
- package/dist/code/index.d.ts +8 -0
- package/dist/code/index.d.ts.map +1 -0
- package/dist/code/index.js +8 -0
- package/dist/code/index.js.map +1 -0
- package/dist/code/lineRanges.d.ts +5 -0
- package/dist/code/lineRanges.d.ts.map +1 -0
- package/dist/code/lineRanges.js +35 -0
- package/dist/code/lineRanges.js.map +1 -0
- package/dist/code/regions.d.ts +53 -0
- package/dist/code/regions.d.ts.map +1 -0
- package/dist/code/regions.js +237 -0
- package/dist/code/regions.js.map +1 -0
- package/dist/code/shiki.d.ts +58 -0
- package/dist/code/shiki.d.ts.map +1 -0
- package/dist/code/shiki.js +244 -0
- package/dist/code/shiki.js.map +1 -0
- package/dist/demos/build.d.ts +17 -0
- package/dist/demos/build.d.ts.map +1 -0
- package/dist/demos/build.js +426 -0
- package/dist/demos/build.js.map +1 -0
- package/dist/demos/cli.d.ts +3 -0
- package/dist/demos/cli.d.ts.map +1 -0
- package/dist/demos/cli.js +68 -0
- package/dist/demos/cli.js.map +1 -0
- package/dist/demos/client.d.ts +27 -0
- package/dist/demos/client.d.ts.map +1 -0
- package/dist/demos/client.js +61 -0
- package/dist/demos/client.js.map +1 -0
- package/dist/demos/compile/core.d.ts +64 -0
- package/dist/demos/compile/core.d.ts.map +1 -0
- package/dist/demos/compile/core.js +174 -0
- package/dist/demos/compile/core.js.map +1 -0
- package/dist/demos/config.d.ts +108 -0
- package/dist/demos/config.d.ts.map +1 -0
- package/dist/demos/config.js +4 -0
- package/dist/demos/config.js.map +1 -0
- package/dist/demos/devEvents.d.ts +13 -0
- package/dist/demos/devEvents.d.ts.map +1 -0
- package/dist/demos/devEvents.js +45 -0
- package/dist/demos/devEvents.js.map +1 -0
- package/dist/demos/html.d.ts +21 -0
- package/dist/demos/html.d.ts.map +1 -0
- package/dist/demos/html.js +57 -0
- package/dist/demos/html.js.map +1 -0
- package/dist/demos/index.d.ts +8 -0
- package/dist/demos/index.d.ts.map +1 -0
- package/dist/demos/index.js +6 -0
- package/dist/demos/index.js.map +1 -0
- package/dist/demos/pages.d.ts +15 -0
- package/dist/demos/pages.d.ts.map +1 -0
- package/dist/demos/pages.js +71 -0
- package/dist/demos/pages.js.map +1 -0
- package/dist/demos/runtime/iframe.d.ts +50 -0
- package/dist/demos/runtime/iframe.d.ts.map +1 -0
- package/dist/demos/runtime/iframe.js +245 -0
- package/dist/demos/runtime/iframe.js.map +1 -0
- package/dist/demos/runtime/react.d.ts +3 -0
- package/dist/demos/runtime/react.d.ts.map +1 -0
- package/dist/demos/runtime/react.js +17 -0
- package/dist/demos/runtime/react.js.map +1 -0
- package/dist/demos/slug.d.ts +3 -0
- package/dist/demos/slug.d.ts.map +1 -0
- package/dist/demos/slug.js +11 -0
- package/dist/demos/slug.js.map +1 -0
- package/dist/demos/vendor.d.ts +32 -0
- package/dist/demos/vendor.d.ts.map +1 -0
- package/dist/demos/vendor.js +127 -0
- package/dist/demos/vendor.js.map +1 -0
- package/dist/demos/worker/compile.worker.d.ts +2 -0
- package/dist/demos/worker/compile.worker.d.ts.map +1 -0
- package/dist/demos/worker/compile.worker.js +27 -0
- package/dist/demos/worker/compile.worker.js.map +1 -0
- package/dist/fork/codesandbox.d.ts +39 -0
- package/dist/fork/codesandbox.d.ts.map +1 -0
- package/dist/fork/codesandbox.js +156 -0
- package/dist/fork/codesandbox.js.map +1 -0
- package/dist/fork/index.d.ts +2 -0
- package/dist/fork/index.d.ts.map +1 -0
- package/dist/fork/index.js +2 -0
- package/dist/fork/index.js.map +1 -0
- package/dist/react/Demo.d.ts +80 -0
- package/dist/react/Demo.d.ts.map +1 -0
- package/dist/react/Demo.js +156 -0
- package/dist/react/Demo.js.map +1 -0
- package/dist/react/DemoIframe.d.ts +22 -0
- package/dist/react/DemoIframe.d.ts.map +1 -0
- package/dist/react/DemoIframe.js +123 -0
- package/dist/react/DemoIframe.js.map +1 -0
- package/dist/react/DemoShell.d.ts +47 -0
- package/dist/react/DemoShell.d.ts.map +1 -0
- package/dist/react/DemoShell.js +341 -0
- package/dist/react/DemoShell.js.map +1 -0
- package/dist/react/devEvents.d.ts +17 -0
- package/dist/react/devEvents.d.ts.map +1 -0
- package/dist/react/devEvents.js +30 -0
- package/dist/react/devEvents.js.map +1 -0
- package/dist/react/editor.d.ts +8 -0
- package/dist/react/editor.d.ts.map +1 -0
- package/dist/react/editor.js +52 -0
- package/dist/react/editor.js.map +1 -0
- package/dist/react/fork.d.ts +10 -0
- package/dist/react/fork.d.ts.map +1 -0
- package/dist/react/fork.js +30 -0
- package/dist/react/fork.js.map +1 -0
- package/dist/react/index.d.ts +4 -0
- package/dist/react/index.d.ts.map +1 -0
- package/dist/react/index.js +4 -0
- package/dist/react/index.js.map +1 -0
- package/dist/react/styles.css +493 -0
- package/dist/remark/index.d.ts +3 -0
- package/dist/remark/index.d.ts.map +1 -0
- package/dist/remark/index.js +3 -0
- package/dist/remark/index.js.map +1 -0
- package/dist/remark/meta.d.ts +7 -0
- package/dist/remark/meta.d.ts.map +1 -0
- package/dist/remark/meta.js +20 -0
- package/dist/remark/meta.js.map +1 -0
- package/dist/remark/remarkDemoFences.d.ts +77 -0
- package/dist/remark/remarkDemoFences.d.ts.map +1 -0
- package/dist/remark/remarkDemoFences.js +259 -0
- package/dist/remark/remarkDemoFences.js.map +1 -0
- package/package.json +106 -4
- package/src/code/demoFiles.ts +54 -0
- package/src/code/heights.ts +47 -0
- package/src/code/highlightSpec.ts +139 -0
- package/src/code/imports.ts +18 -0
- package/src/code/index.ts +46 -0
- package/src/code/lineRanges.ts +31 -0
- package/src/code/regions.ts +270 -0
- package/src/code/shiki.ts +271 -0
- package/src/demos/build.ts +477 -0
- package/src/demos/cli.ts +64 -0
- package/src/demos/client.ts +82 -0
- package/src/demos/compile/core.ts +228 -0
- package/src/demos/config.ts +106 -0
- package/src/demos/devEvents.ts +45 -0
- package/src/demos/html.ts +74 -0
- package/src/demos/index.ts +25 -0
- package/src/demos/pages.ts +79 -0
- package/src/demos/runtime/iframe.ts +262 -0
- package/src/demos/runtime/react.ts +19 -0
- package/src/demos/slug.ts +10 -0
- package/src/demos/vendor.ts +142 -0
- package/src/demos/worker/compile.worker.ts +35 -0
- package/src/fork/codesandbox.ts +189 -0
- package/src/fork/index.ts +10 -0
- package/src/react/Demo.tsx +250 -0
- package/src/react/DemoIframe.tsx +165 -0
- package/src/react/DemoShell.tsx +592 -0
- package/src/react/devEvents.ts +34 -0
- package/src/react/editor.ts +61 -0
- package/src/react/fork.ts +31 -0
- package/src/react/index.ts +10 -0
- package/src/react/styles.css +493 -0
- package/src/remark/index.ts +2 -0
- package/src/remark/meta.ts +20 -0
- package/src/remark/remarkDemoFences.ts +330 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# @thedatagrid/docs-kit
|
|
2
|
+
|
|
3
|
+
## 0.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 0a3e45c: First release: `/code` (regions, `#highlight` markers, shiki transformers), `/remark` (`file=` / `region=` / `live` fences), `/demos` (esbuild prebuild into iframes with a shared import map, watch mode with dev reloads, `compileDemo`), `/demos/client` (in-browser esbuild-wasm and remote compilers), `/react` (`Demo` server component, `DemoShell` with editing) and `/fork` (CodeSandbox payloads that keep the folder structure).
|
package/README.md
CHANGED
|
@@ -1,3 +1,124 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @thedatagrid/docs-kit
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Docs tooling shared by the Infinite Table, Adaptable DataGrid and AdapTable
|
|
4
|
+
documentation sites:
|
|
5
|
+
|
|
6
|
+
- **file-based snippets**: fences reference real, type-checked files, with
|
|
7
|
+
`#region`s and `// #highlight` comment markers;
|
|
8
|
+
- **live demos** prebuilt with esbuild into static iframe pages (fast first
|
|
9
|
+
view, no in-browser bundler on page load), with one shared import map for
|
|
10
|
+
the product library and React;
|
|
11
|
+
- **editable demos**: CodeMirror plus an in-browser esbuild-wasm rebuild of the
|
|
12
|
+
demo's own files (or a remote compile server);
|
|
13
|
+
- **CodeSandbox forks** that keep the demo's folder structure.
|
|
14
|
+
|
|
15
|
+
One package, with subpath exports:
|
|
16
|
+
|
|
17
|
+
| Subpath | What |
|
|
18
|
+
|---|---|
|
|
19
|
+
| `/code` | regions, highlight markers, shiki transformers and `highlightCode`, demo file collection |
|
|
20
|
+
| `/remark` | `remarkDemoFences`: `file=` / `region=` / `live` / `lines` / `height` fences |
|
|
21
|
+
| `/demos` | the demo builder (`buildDemos`, `docs-kit demos` CLI), config types, `compileDemo` |
|
|
22
|
+
| `/demos/client` | browser-side compilers (`browser` worker or `remote`) |
|
|
23
|
+
| `/react` | `Demo` (server component), `DemoShell` (client card), `createDemoComponents` |
|
|
24
|
+
| `/react/styles.css` | the card styles (CSS custom properties) |
|
|
25
|
+
| `/fork` | CodeSandbox define-API payloads |
|
|
26
|
+
|
|
27
|
+
## Fences
|
|
28
|
+
|
|
29
|
+
````md
|
|
30
|
+
```tsx file="basic.demo.tsx" live title="Basic grid"
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
```tsx file="sorting.snippet.tsx" region="sort-info" lines
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
<Demo>
|
|
37
|
+
<DemoTitle>Controlled sorting</DemoTitle>
|
|
38
|
+
<DemoDescription>Click a header to sort.</DemoDescription>
|
|
39
|
+
|
|
40
|
+
```tsx file="controlled.demo.tsx" live height="small"
|
|
41
|
+
```
|
|
42
|
+
</Demo>
|
|
43
|
+
````
|
|
44
|
+
|
|
45
|
+
- `file` is relative to the page. Missing files and regions fail the build.
|
|
46
|
+
- `live` turns a `*.demo.tsx` (in the page's folder or below) into a demo card.
|
|
47
|
+
`live=off` starts on the code tab. `edit=off` disables editing.
|
|
48
|
+
- `region="name"` shows a `//#region name` … `//#endregion` slice (also
|
|
49
|
+
`{/* #region name */}` in JSX).
|
|
50
|
+
- Highlights are comments in the source, stripped from the shown code:
|
|
51
|
+
`// #highlight label` … `// #endhighlight`, a bare `// #highlight` for the next
|
|
52
|
+
line, or a trailing `code // #highlight label`.
|
|
53
|
+
- `lines` shows line numbers (original file numbers with `region`).
|
|
54
|
+
- `files=off` hides the file tabs. The files a demo imports via relative
|
|
55
|
+
imports become tabs automatically.
|
|
56
|
+
- `height="small|default|large|auto|<px>"`.
|
|
57
|
+
|
|
58
|
+
## Building demos
|
|
59
|
+
|
|
60
|
+
`docs-kit.config.mjs` in the site root:
|
|
61
|
+
|
|
62
|
+
```js
|
|
63
|
+
/** @type {import('@thedatagrid/docs-kit/demos').DocsKitConfig} */
|
|
64
|
+
export default {
|
|
65
|
+
libraries: {
|
|
66
|
+
// built from source into the import map
|
|
67
|
+
'@acme/grid': { entry: '../source/src/index.tsx', plugins: () => [/* esbuild plugins */] },
|
|
68
|
+
},
|
|
69
|
+
stubImports: [/^@acme\/grid\/.*\.css$/], // the CSS is linked in the page
|
|
70
|
+
define: { 'process.env.API_URL': JSON.stringify(apiUrl) },
|
|
71
|
+
sourceReplacements: { 'process.env.API_URL': JSON.stringify(apiUrl) },
|
|
72
|
+
bootstrap: 'src/demo-bootstrap.ts', // export setup() / applyTheme(theme)
|
|
73
|
+
fork: { dependencies: { '@acme/grid': '1.2.3' }, entryPrelude: "import '@acme/grid/index.css';" },
|
|
74
|
+
};
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
```sh
|
|
78
|
+
docs-kit demos build # → public/gen/demos (+ manifest.json)
|
|
79
|
+
docs-kit demos --watch # rebuild on change, reload open iframes (SSE on :4748)
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Every bare import found in the demos becomes an import-map entry. They are
|
|
83
|
+
built in one split esbuild pass, so React exists once. Configured libraries
|
|
84
|
+
come from source, so the docs can show features before they ship.
|
|
85
|
+
|
|
86
|
+
## Rendering (Next.js)
|
|
87
|
+
|
|
88
|
+
```tsx
|
|
89
|
+
import { remarkDemoFences } from '@thedatagrid/docs-kit/remark';
|
|
90
|
+
import { createDemoComponents } from '@thedatagrid/docs-kit/react';
|
|
91
|
+
import '@thedatagrid/docs-kit/react/styles.css';
|
|
92
|
+
|
|
93
|
+
const contentDir = path.join(process.cwd(), 'content');
|
|
94
|
+
// remark
|
|
95
|
+
remarkDemoFences({ contentDir, folder: page.folderPath, staticFences: 'card' });
|
|
96
|
+
// MDX components
|
|
97
|
+
createDemoComponents({ contentDir, folder: page.folderPath, manifest: 'public/gen/demos/manifest.json' });
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
`remarkDemoFences` options:
|
|
101
|
+
- `claim(fence)` limits it to some fences, so a legacy pipeline can run after it;
|
|
102
|
+
- `banInlineCode` is on by default;
|
|
103
|
+
- `staticFences: 'shiki-meta' | 'card'`. Use `shiki-meta` with `@shikijs/rehype` and `fenceTransformers()` from `/code`.
|
|
104
|
+
|
|
105
|
+
## Editing
|
|
106
|
+
|
|
107
|
+
The card's **edit** button lazy-loads CodeMirror. Each change is rebuilt by
|
|
108
|
+
the compiler from the manifest:
|
|
109
|
+
|
|
110
|
+
- `browser` (default): esbuild-wasm in a module worker, loaded on the first edit;
|
|
111
|
+
- `remote`: POST `{ request, options }` to a server running `compileDemo(esbuild, request, options)`.
|
|
112
|
+
|
|
113
|
+
The result is imported from a blob URL inside the iframe, where the import
|
|
114
|
+
map applies, and re-mounted. Errors show as an overlay. Reset restores the
|
|
115
|
+
prebuilt demo. Fork sends the edited files.
|
|
116
|
+
|
|
117
|
+
Serve `*.wasm` with a long cache lifetime: the file name is content-hashed.
|
|
118
|
+
|
|
119
|
+
## Local development across repos
|
|
120
|
+
|
|
121
|
+
Check `docs-kit` out next to the consuming repo, and run the site with
|
|
122
|
+
`DOCS_KIT_LOCAL=1` (or `DOCS_KIT_LOCAL=/path/to/docs-kit`). The site resolves
|
|
123
|
+
`@thedatagrid/docs-kit` to `packages/docs-kit/src`: no `npm link`, no build
|
|
124
|
+
step. The CLI runs from source too (Node ≥ 22.18 strips the types).
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export declare const RESOLVE_EXTENSIONS: string[];
|
|
2
|
+
export type DemoSourceFile = {
|
|
3
|
+
/** Absolute path. */
|
|
4
|
+
filePath: string;
|
|
5
|
+
source: string;
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* The demo file plus every file it (transitively) pulls in through relative
|
|
9
|
+
* imports, entry first. They are shown as extra tabs in the code view and are
|
|
10
|
+
* the files a browser rebuild and a CodeSandbox fork need.
|
|
11
|
+
*/
|
|
12
|
+
export declare function collectDemoFiles(entryFile: string): DemoSourceFile[];
|
|
13
|
+
export { bareImports } from './imports.ts';
|
|
14
|
+
//# sourceMappingURL=demoFiles.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"demoFiles.d.ts","sourceRoot":"","sources":["../../src/code/demoFiles.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,kBAAkB,UAA8D,CAAC;AAe9F,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"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
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'];
|
|
5
|
+
function resolveRelativeImport(fromDir, specifier) {
|
|
6
|
+
const base = path.resolve(fromDir, specifier);
|
|
7
|
+
for (const ext of RESOLVE_EXTENSIONS) {
|
|
8
|
+
const candidate = base + ext;
|
|
9
|
+
if (fs.existsSync(candidate) && fs.statSync(candidate).isFile())
|
|
10
|
+
return candidate;
|
|
11
|
+
}
|
|
12
|
+
for (const ext of RESOLVE_EXTENSIONS.slice(1)) {
|
|
13
|
+
const candidate = path.join(base, `index${ext}`);
|
|
14
|
+
if (fs.existsSync(candidate))
|
|
15
|
+
return candidate;
|
|
16
|
+
}
|
|
17
|
+
return null;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The demo file plus every file it (transitively) pulls in through relative
|
|
21
|
+
* imports, entry first. They are shown as extra tabs in the code view and are
|
|
22
|
+
* the files a browser rebuild and a CodeSandbox fork need.
|
|
23
|
+
*/
|
|
24
|
+
export function collectDemoFiles(entryFile) {
|
|
25
|
+
const ordered = [];
|
|
26
|
+
const visited = new Set();
|
|
27
|
+
const visit = (filePath) => {
|
|
28
|
+
if (visited.has(filePath))
|
|
29
|
+
return;
|
|
30
|
+
visited.add(filePath);
|
|
31
|
+
const source = fs.readFileSync(filePath, 'utf8');
|
|
32
|
+
ordered.push({ filePath, source });
|
|
33
|
+
if (!/\.(?:[cm]?[jt]sx?)$/.test(filePath))
|
|
34
|
+
return;
|
|
35
|
+
for (const match of source.matchAll(IMPORT_RE)) {
|
|
36
|
+
const specifier = match[1] ?? match[2];
|
|
37
|
+
const resolved = resolveRelativeImport(path.dirname(filePath), specifier);
|
|
38
|
+
if (resolved)
|
|
39
|
+
visit(resolved);
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
visit(entryFile);
|
|
43
|
+
return ordered;
|
|
44
|
+
}
|
|
45
|
+
export { bareImports } from "./imports.js";
|
|
46
|
+
//# sourceMappingURL=demoFiles.js.map
|
|
@@ -0,0 +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;AAE9F,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,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO;QAClD,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"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export type DemoHeights = {
|
|
2
|
+
small: number;
|
|
3
|
+
default: number;
|
|
4
|
+
large: number;
|
|
5
|
+
};
|
|
6
|
+
/** Preview heights for `height="small" | "default" | "large"`; sites can pass their own. */
|
|
7
|
+
export declare const DEMO_HEIGHTS: DemoHeights;
|
|
8
|
+
export type DemoHeightName = keyof DemoHeights;
|
|
9
|
+
/** Pixels, or `auto` — the card takes the natural height of the code. */
|
|
10
|
+
export type DemoHeight = number | 'auto';
|
|
11
|
+
/**
|
|
12
|
+
* Fence `height="small" | "default" | "large" | "auto" | "<px>"` → pixels or
|
|
13
|
+
* `auto`. Omitted → default. With `auto`, the preview is never shorter than
|
|
14
|
+
* `heights.default`, so a short code region still leaves room for the grid.
|
|
15
|
+
*/
|
|
16
|
+
export declare function parseDemoHeight(height?: string | number | boolean | null, heights?: DemoHeights): DemoHeight;
|
|
17
|
+
//# sourceMappingURL=heights.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"heights.d.ts","sourceRoot":"","sources":["../../src/code/heights.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,4FAA4F;AAC5F,eAAO,MAAM,YAAY,EAAE,WAI1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC;AAE/C,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAYzC;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EACzC,OAAO,GAAE,WAA0B,GAClC,UAAU,CAcZ"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/** Preview heights for `height="small" | "default" | "large"`; sites can pass their own. */
|
|
2
|
+
export const DEMO_HEIGHTS = {
|
|
3
|
+
small: 650,
|
|
4
|
+
default: 850,
|
|
5
|
+
large: 1050,
|
|
6
|
+
};
|
|
7
|
+
const NAMES = new Set(['small', 'default', 'large']);
|
|
8
|
+
function invalid(height, heights) {
|
|
9
|
+
return new Error(`invalid height "${String(height)}" — use "small" (${heights.small}px), ` +
|
|
10
|
+
`"default" (${heights.default}px), "large" (${heights.large}px), "auto", ` +
|
|
11
|
+
`or a number of pixels`);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Fence `height="small" | "default" | "large" | "auto" | "<px>"` → pixels or
|
|
15
|
+
* `auto`. Omitted → default. With `auto`, the preview is never shorter than
|
|
16
|
+
* `heights.default`, so a short code region still leaves room for the grid.
|
|
17
|
+
*/
|
|
18
|
+
export function parseDemoHeight(height, heights = DEMO_HEIGHTS) {
|
|
19
|
+
if (height == null)
|
|
20
|
+
return heights.default;
|
|
21
|
+
if (typeof height === 'number') {
|
|
22
|
+
if (Number.isFinite(height) && height > 0)
|
|
23
|
+
return height;
|
|
24
|
+
throw invalid(height, heights);
|
|
25
|
+
}
|
|
26
|
+
if (typeof height !== 'string')
|
|
27
|
+
throw invalid(height, heights);
|
|
28
|
+
const name = height.trim().toLowerCase();
|
|
29
|
+
if (!name)
|
|
30
|
+
return heights.default;
|
|
31
|
+
if (name === 'auto')
|
|
32
|
+
return 'auto';
|
|
33
|
+
if (NAMES.has(name))
|
|
34
|
+
return heights[name];
|
|
35
|
+
const px = /^(\d+)(?:px)?$/.exec(name);
|
|
36
|
+
if (px && Number(px[1]) > 0)
|
|
37
|
+
return Number(px[1]);
|
|
38
|
+
throw invalid(height, heights);
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=heights.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"heights.js","sourceRoot":"","sources":["../../src/code/heights.ts"],"names":[],"mappings":"AAEA,4FAA4F;AAC5F,MAAM,CAAC,MAAM,YAAY,GAAgB;IACvC,KAAK,EAAE,GAAG;IACV,OAAO,EAAE,GAAG;IACZ,KAAK,EAAE,IAAI;CACZ,CAAC;AAOF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAE7D,SAAS,OAAO,CAAC,MAAe,EAAE,OAAoB;IACpD,OAAO,IAAI,KAAK,CACd,mBAAmB,MAAM,CAAC,MAAM,CAAC,oBAAoB,OAAO,CAAC,KAAK,OAAO;QACvE,cAAc,OAAO,CAAC,OAAO,iBAAiB,OAAO,CAAC,KAAK,eAAe;QAC1E,uBAAuB,CAC1B,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAyC,EACzC,UAAuB,YAAY;IAEnC,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC;IAC3C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC;YAAE,OAAO,MAAM,CAAC;QACzD,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC;IAClC,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IACnC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC,IAAsB,CAAC,CAAC;IAC5D,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,EAAE,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjC,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Highlighted lines plus optional labels, keyed by the first displayed line
|
|
3
|
+
* of each labelled block. Produced from `#highlight` markers in the source
|
|
4
|
+
* (see `extractCodeMarkers`) and serialized into fence meta as
|
|
5
|
+
* `{1-3,8="label"}` so markdown-level shiki transformers can read it.
|
|
6
|
+
*/
|
|
7
|
+
export type HighlightSpec = {
|
|
8
|
+
lines: number[];
|
|
9
|
+
labels: Record<number, string>;
|
|
10
|
+
};
|
|
11
|
+
export type HighlightAnnotation = {
|
|
12
|
+
lines: number[];
|
|
13
|
+
label?: string;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* `{1-3,7}` or `{8="label", 9-10="hello"}` in a fence meta string.
|
|
17
|
+
* Quoted labels may contain commas; braces inside quotes are not supported.
|
|
18
|
+
*/
|
|
19
|
+
export declare const HIGHLIGHT_META_RE: RegExp;
|
|
20
|
+
/** `lines` in a fence meta string: show a gutter with line numbers. */
|
|
21
|
+
export declare const LINES_META_RE: RegExp;
|
|
22
|
+
/** `originalLines="12-14"`, written for `region` fences so the gutter shows file line numbers. */
|
|
23
|
+
export declare const ORIGINAL_LINES_META_RE: RegExp;
|
|
24
|
+
/** `height=small` / `height="small"` in a fence meta string. */
|
|
25
|
+
export declare const HEIGHT_META_RE: RegExp;
|
|
26
|
+
/**
|
|
27
|
+
* Parses the inside of a `{…}` highlight group: unlabeled ranges (`1-3,7`)
|
|
28
|
+
* and labeled ones (`8="available columns", 9-10="hello"`).
|
|
29
|
+
*/
|
|
30
|
+
export declare function parseHighlightMeta(inner: string): HighlightAnnotation[];
|
|
31
|
+
export declare function parseHighlightSpec(inner: string): HighlightSpec;
|
|
32
|
+
/** Inverse of `parseHighlightSpec`: `{ lines: [1,2,3,7], labels: { 1: 'a' } }` → `1-3="a",7`. */
|
|
33
|
+
export declare function formatHighlightSpec(spec: HighlightSpec): string;
|
|
34
|
+
//# sourceMappingURL=highlightSpec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"highlightSpec.d.ts","sourceRoot":"","sources":["../../src/code/highlightSpec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAwC,CAAC;AAEvE,uEAAuE;AACvE,eAAO,MAAM,aAAa,QAA0B,CAAC;AAErD,kGAAkG;AAClG,eAAO,MAAM,sBAAsB,QAAoC,CAAC;AAExE,gEAAgE;AAChE,eAAO,MAAM,cAAc,QAAiC,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,mBAAmB,EAAE,CAsEvE;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAU/D;AAED,iGAAiG;AACjG,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAkB/D"}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `{1-3,7}` or `{8="label", 9-10="hello"}` in a fence meta string.
|
|
3
|
+
* Quoted labels may contain commas; braces inside quotes are not supported.
|
|
4
|
+
*/
|
|
5
|
+
export const HIGHLIGHT_META_RE = /\{((?:[^"{}]|"(?:\\.|[^"\\])*")*)\}/;
|
|
6
|
+
/** `lines` in a fence meta string: show a gutter with line numbers. */
|
|
7
|
+
export const LINES_META_RE = /(?:^|\s)lines(?:\s|$)/;
|
|
8
|
+
/** `originalLines="12-14"`, written for `region` fences so the gutter shows file line numbers. */
|
|
9
|
+
export const ORIGINAL_LINES_META_RE = /(?:^|\s)originalLines="([^"]+)"/;
|
|
10
|
+
/** `height=small` / `height="small"` in a fence meta string. */
|
|
11
|
+
export const HEIGHT_META_RE = /(?:^|\s)height="?([^\s"]+)"?/;
|
|
12
|
+
/**
|
|
13
|
+
* Parses the inside of a `{…}` highlight group: unlabeled ranges (`1-3,7`)
|
|
14
|
+
* and labeled ones (`8="available columns", 9-10="hello"`).
|
|
15
|
+
*/
|
|
16
|
+
export function parseHighlightMeta(inner) {
|
|
17
|
+
const annotations = [];
|
|
18
|
+
const s = inner;
|
|
19
|
+
let i = 0;
|
|
20
|
+
const skipSep = () => {
|
|
21
|
+
while (i < s.length && /[\s,]/.test(s[i]))
|
|
22
|
+
i++;
|
|
23
|
+
};
|
|
24
|
+
const readNumber = () => {
|
|
25
|
+
const start = i;
|
|
26
|
+
while (i < s.length && /\d/.test(s[i]))
|
|
27
|
+
i++;
|
|
28
|
+
if (i === start)
|
|
29
|
+
return null;
|
|
30
|
+
return Number(s.slice(start, i));
|
|
31
|
+
};
|
|
32
|
+
while (i < s.length) {
|
|
33
|
+
skipSep();
|
|
34
|
+
if (i >= s.length)
|
|
35
|
+
break;
|
|
36
|
+
const start = readNumber();
|
|
37
|
+
if (start == null) {
|
|
38
|
+
throw new Error(`invalid highlight \`{${inner}}\` — expected a line number`);
|
|
39
|
+
}
|
|
40
|
+
let end = start;
|
|
41
|
+
if (s[i] === '-') {
|
|
42
|
+
i++;
|
|
43
|
+
const stop = readNumber();
|
|
44
|
+
if (stop == null) {
|
|
45
|
+
throw new Error(`invalid highlight \`{${inner}}\` — expected a line number after "-"`);
|
|
46
|
+
}
|
|
47
|
+
end = stop;
|
|
48
|
+
}
|
|
49
|
+
if (end < start) {
|
|
50
|
+
throw new Error(`invalid highlight \`{${inner}}\` — range ${start}-${end} goes backwards`);
|
|
51
|
+
}
|
|
52
|
+
const lines = [];
|
|
53
|
+
for (let line = start; line <= end; line++)
|
|
54
|
+
lines.push(line);
|
|
55
|
+
while (i < s.length && /\s/.test(s[i]))
|
|
56
|
+
i++;
|
|
57
|
+
let label;
|
|
58
|
+
if (s[i] === '=') {
|
|
59
|
+
i++;
|
|
60
|
+
while (i < s.length && /\s/.test(s[i]))
|
|
61
|
+
i++;
|
|
62
|
+
const quote = s[i];
|
|
63
|
+
if (quote !== '"' && quote !== "'") {
|
|
64
|
+
throw new Error(`invalid highlight \`{${inner}}\` — labels must be quoted ("...")`);
|
|
65
|
+
}
|
|
66
|
+
i++;
|
|
67
|
+
let value = '';
|
|
68
|
+
while (i < s.length && s[i] !== quote) {
|
|
69
|
+
if (s[i] === '\\' && i + 1 < s.length) {
|
|
70
|
+
value += s[i + 1];
|
|
71
|
+
i += 2;
|
|
72
|
+
continue;
|
|
73
|
+
}
|
|
74
|
+
value += s[i];
|
|
75
|
+
i++;
|
|
76
|
+
}
|
|
77
|
+
if (s[i] !== quote) {
|
|
78
|
+
throw new Error(`invalid highlight \`{${inner}}\` — unterminated label`);
|
|
79
|
+
}
|
|
80
|
+
i++;
|
|
81
|
+
label = value;
|
|
82
|
+
}
|
|
83
|
+
annotations.push(label ? { lines, label } : { lines });
|
|
84
|
+
}
|
|
85
|
+
return annotations;
|
|
86
|
+
}
|
|
87
|
+
export function parseHighlightSpec(inner) {
|
|
88
|
+
const annotations = parseHighlightMeta(inner);
|
|
89
|
+
const lines = [...new Set(annotations.flatMap((a) => a.lines))];
|
|
90
|
+
const labels = {};
|
|
91
|
+
for (const annotation of annotations) {
|
|
92
|
+
if (annotation.label && annotation.lines[0] != null) {
|
|
93
|
+
labels[annotation.lines[0]] = annotation.label;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return { lines, labels };
|
|
97
|
+
}
|
|
98
|
+
/** Inverse of `parseHighlightSpec`: `{ lines: [1,2,3,7], labels: { 1: 'a' } }` → `1-3="a",7`. */
|
|
99
|
+
export function formatHighlightSpec(spec) {
|
|
100
|
+
const lines = [...new Set(spec.lines)].sort((a, b) => a - b);
|
|
101
|
+
const groups = [];
|
|
102
|
+
for (const line of lines) {
|
|
103
|
+
const last = groups[groups.length - 1];
|
|
104
|
+
if (last && line === last.end + 1 && !spec.labels[line]) {
|
|
105
|
+
last.end = line;
|
|
106
|
+
}
|
|
107
|
+
else {
|
|
108
|
+
groups.push({ start: line, end: line });
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
return groups
|
|
112
|
+
.map(({ start, end }) => {
|
|
113
|
+
const range = start === end ? String(start) : `${start}-${end}`;
|
|
114
|
+
const label = spec.labels[start];
|
|
115
|
+
return label ? `${range}="${label.replace(/["\\]/g, '\\$&')}"` : range;
|
|
116
|
+
})
|
|
117
|
+
.join(',');
|
|
118
|
+
}
|
|
119
|
+
//# sourceMappingURL=highlightSpec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"highlightSpec.js","sourceRoot":"","sources":["../../src/code/highlightSpec.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,qCAAqC,CAAC;AAEvE,uEAAuE;AACvE,MAAM,CAAC,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAErD,kGAAkG;AAClG,MAAM,CAAC,MAAM,sBAAsB,GAAG,iCAAiC,CAAC;AAExE,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG,8BAA8B,CAAC;AAE7D;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,MAAM,WAAW,GAA0B,EAAE,CAAC;IAC9C,MAAM,CAAC,GAAG,KAAK,CAAC;IAChB,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAAE,CAAC,EAAE,CAAC;IACjD,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,GAAkB,EAAE;QACrC,MAAM,KAAK,GAAG,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAAE,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,KAAK;YAAE,OAAO,IAAI,CAAC;QAC7B,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;QACV,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM;YAAE,MAAM;QAEzB,MAAM,KAAK,GAAG,UAAU,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,8BAA8B,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,GAAG,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACjB,CAAC,EAAE,CAAC;YACJ,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;YAC1B,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,wCAAwC,CAAC,CAAC;YACzF,CAAC;YACD,GAAG,GAAG,IAAI,CAAC;QACb,CAAC;QACD,IAAI,GAAG,GAAG,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,eAAe,KAAK,IAAI,GAAG,iBAAiB,CAAC,CAAC;QAC7F,CAAC;QACD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,GAAG,EAAE,IAAI,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE7D,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAAE,CAAC,EAAE,CAAC;QAC5C,IAAI,KAAyB,CAAC;QAC9B,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACjB,CAAC,EAAE,CAAC;YACJ,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACnB,IAAI,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,qCAAqC,CAAC,CAAC;YACtF,CAAC;YACD,CAAC,EAAE,CAAC;YACJ,IAAI,KAAK,GAAG,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;gBACtC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;oBACtC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;oBAClB,CAAC,IAAI,CAAC,CAAC;oBACP,SAAS;gBACX,CAAC;gBACD,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC,EAAE,CAAC;YACN,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,0BAA0B,CAAC,CAAC;YAC3E,CAAC;YACD,CAAC,EAAE,CAAC;YACJ,KAAK,GAAG,KAAK,CAAC;QAChB,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,MAAM,WAAW,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACpD,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;QACjD,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,mBAAmB,CAAC,IAAmB;IACrD,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAqC,EAAE,CAAC;IACpD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvC,IAAI,IAAI,IAAI,IAAI,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IACD,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;QACtB,MAAM,KAAK,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;IACzE,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/** Bare (package) specifiers a source file imports, e.g. `react`, `@scope/pkg/sub`. */
|
|
2
|
+
export declare function bareImports(source: string): string[];
|
|
3
|
+
/** `@scope/pkg/sub` → `@scope/pkg`, `pkg/sub` → `pkg`. */
|
|
4
|
+
export declare function packageName(specifier: string): string;
|
|
5
|
+
//# sourceMappingURL=imports.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/code/imports.ts"],"names":[],"mappings":"AAGA,uFAAuF;AACvF,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAOpD;AAED,0DAA0D;AAC1D,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGrD"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
const BARE_IMPORT_RE = /(?:import|export)\s[^'"]*?from\s+['"]([^'"./][^'"]*)['"]|import\s*\(?\s*['"]([^'"./][^'"]*)['"]/g;
|
|
2
|
+
/** Bare (package) specifiers a source file imports, e.g. `react`, `@scope/pkg/sub`. */
|
|
3
|
+
export function bareImports(source) {
|
|
4
|
+
const found = new Set();
|
|
5
|
+
for (const match of source.matchAll(BARE_IMPORT_RE)) {
|
|
6
|
+
const specifier = match[1] ?? match[2];
|
|
7
|
+
if (specifier && !specifier.startsWith('node:'))
|
|
8
|
+
found.add(specifier);
|
|
9
|
+
}
|
|
10
|
+
return [...found];
|
|
11
|
+
}
|
|
12
|
+
/** `@scope/pkg/sub` → `@scope/pkg`, `pkg/sub` → `pkg`. */
|
|
13
|
+
export function packageName(specifier) {
|
|
14
|
+
const parts = specifier.split('/');
|
|
15
|
+
return specifier.startsWith('@') ? parts.slice(0, 2).join('/') : parts[0];
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=imports.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"imports.js","sourceRoot":"","sources":["../../src/code/imports.ts"],"names":[],"mappings":"AAAA,MAAM,cAAc,GAClB,kGAAkG,CAAC;AAErG,uFAAuF;AACvF,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QACpD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;QACvC,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,SAAiB;IAC3C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,OAAO,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { applySourceReplacements, dedent, extractCodeMarkers, listRegionNames, sliceRegion, stripCodeMarkers, type CodeWithMarkers, type SlicedRange, } from './regions.ts';
|
|
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
|
+
export { formatLineRanges, parseLineRanges } from './lineRanges.ts';
|
|
4
|
+
export { DEMO_HEIGHTS, parseDemoHeight, type DemoHeight, type DemoHeightName, type DemoHeights, } from './heights.ts';
|
|
5
|
+
export { DEFAULT_CODE_THEMES, dirnameOf, fenceTransformers, highlightCode, joinPath, langForFile, matchImportedFile, transformerHeightMeta, transformerImportFileLinks, transformerLineHighlight, transformerLineNumbers, type CodeThemes, type HighlightOptions, } from './shiki.ts';
|
|
6
|
+
export { collectDemoFiles, RESOLVE_EXTENSIONS, type DemoSourceFile } from './demoFiles.ts';
|
|
7
|
+
export { bareImports, packageName } from './imports.ts';
|
|
8
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { applySourceReplacements, dedent, extractCodeMarkers, listRegionNames, sliceRegion, stripCodeMarkers, } from "./regions.js";
|
|
2
|
+
export { HEIGHT_META_RE, HIGHLIGHT_META_RE, LINES_META_RE, ORIGINAL_LINES_META_RE, formatHighlightSpec, parseHighlightMeta, parseHighlightSpec, } from "./highlightSpec.js";
|
|
3
|
+
export { formatLineRanges, parseLineRanges } from "./lineRanges.js";
|
|
4
|
+
export { DEMO_HEIGHTS, parseDemoHeight, } from "./heights.js";
|
|
5
|
+
export { DEFAULT_CODE_THEMES, dirnameOf, fenceTransformers, highlightCode, joinPath, langForFile, matchImportedFile, transformerHeightMeta, transformerImportFileLinks, transformerLineHighlight, transformerLineNumbers, } from "./shiki.js";
|
|
6
|
+
export { collectDemoFiles, RESOLVE_EXTENSIONS } from "./demoFiles.js";
|
|
7
|
+
export { bareImports, packageName } from "./imports.js";
|
|
8
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/** Expands `"1-3,7"` into `[1, 2, 3, 7]` (1-based). */
|
|
2
|
+
export declare function parseLineRanges(spec: string): number[];
|
|
3
|
+
/** Compacts `[1, 2, 3, 7]` into `"1-3,7"`. */
|
|
4
|
+
export declare function formatLineRanges(lines: number[]): string;
|
|
5
|
+
//# sourceMappingURL=lineRanges.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lineRanges.d.ts","sourceRoot":"","sources":["../../src/code/lineRanges.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAUtD;AAED,8CAA8C;AAC9C,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAgBxD"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/** Expands `"1-3,7"` into `[1, 2, 3, 7]` (1-based). */
|
|
2
|
+
export function parseLineRanges(spec) {
|
|
3
|
+
const lines = [];
|
|
4
|
+
for (const part of spec.split(',')) {
|
|
5
|
+
const token = part.trim();
|
|
6
|
+
if (!token)
|
|
7
|
+
continue;
|
|
8
|
+
const [start, end = start] = token.split('-').map((n) => Number(n.trim()));
|
|
9
|
+
if (!Number.isFinite(start) || !Number.isFinite(end))
|
|
10
|
+
continue;
|
|
11
|
+
for (let line = start; line <= end; line++)
|
|
12
|
+
lines.push(line);
|
|
13
|
+
}
|
|
14
|
+
return lines;
|
|
15
|
+
}
|
|
16
|
+
/** Compacts `[1, 2, 3, 7]` into `"1-3,7"`. */
|
|
17
|
+
export function formatLineRanges(lines) {
|
|
18
|
+
if (!lines.length)
|
|
19
|
+
return '';
|
|
20
|
+
const parts = [];
|
|
21
|
+
let start = lines[0];
|
|
22
|
+
let prev = lines[0];
|
|
23
|
+
for (let i = 1; i < lines.length; i++) {
|
|
24
|
+
const n = lines[i];
|
|
25
|
+
if (n === prev + 1) {
|
|
26
|
+
prev = n;
|
|
27
|
+
continue;
|
|
28
|
+
}
|
|
29
|
+
parts.push(start === prev ? String(start) : `${start}-${prev}`);
|
|
30
|
+
start = prev = n;
|
|
31
|
+
}
|
|
32
|
+
parts.push(start === prev ? String(start) : `${start}-${prev}`);
|
|
33
|
+
return parts.join(',');
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=lineRanges.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lineRanges.js","sourceRoot":"","sources":["../../src/code/lineRanges.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,SAAS;QAC/D,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,GAAG,EAAE,IAAI,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,gBAAgB,CAAC,KAAe;IAC9C,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC,EAAE,CAAC;YACnB,IAAI,GAAG,CAAC,CAAC;YACT,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC;QAChE,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC;IACnB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC;IAChE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { HighlightSpec } from './highlightSpec.ts';
|
|
2
|
+
/**
|
|
3
|
+
* Source preparation for docs fences:
|
|
4
|
+
*
|
|
5
|
+
* - `sliceRegion` extracts a VS Code / fumadocs `#region name` block (`region="name"`).
|
|
6
|
+
* - `extractCodeMarkers` strips `#highlight` / `#region` marker comments and
|
|
7
|
+
* returns the lines they highlight.
|
|
8
|
+
*/
|
|
9
|
+
export type SlicedRange = {
|
|
10
|
+
source: string;
|
|
11
|
+
/** 1-based original file line numbers of the displayed lines. */
|
|
12
|
+
originalLines: number[];
|
|
13
|
+
};
|
|
14
|
+
export declare function dedent(lines: string[]): string;
|
|
15
|
+
export declare function listRegionNames(source: string): string[];
|
|
16
|
+
/**
|
|
17
|
+
* Returns the displayed source for `region="name"` plus the original file line
|
|
18
|
+
* numbers (so a `lines` gutter can keep showing those). Throws with the list
|
|
19
|
+
* of known regions when the name doesn't exist.
|
|
20
|
+
*/
|
|
21
|
+
export declare function sliceRegion(source: string, spec: string, context: string): SlicedRange;
|
|
22
|
+
export type CodeWithMarkers = SlicedRange & {
|
|
23
|
+
/** Displayed (1-based) lines marked with `#highlight`, labels on the first line of each block. */
|
|
24
|
+
highlight: HighlightSpec;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Strips marker comments from a snippet and returns the lines they highlight.
|
|
28
|
+
*
|
|
29
|
+
* - `// #highlight label` … `// #endhighlight` highlights the lines in between.
|
|
30
|
+
* Without a closing `#endhighlight` (before the next `#highlight`), only the
|
|
31
|
+
* next non-blank line is highlighted.
|
|
32
|
+
* With a label, the opening marker becomes an empty highlighted line that
|
|
33
|
+
* shows the label; without one it is removed.
|
|
34
|
+
* - `code // #highlight label` highlights that single line.
|
|
35
|
+
* - `/* … *\/` and `{/* … *\/}` (JSX children) work for both forms.
|
|
36
|
+
* - `#region` / `#endregion` lines are dropped, so full-file views don't show them.
|
|
37
|
+
*
|
|
38
|
+
* `originalLines` (from `sliceRegion`) is kept in step with the removed lines.
|
|
39
|
+
*/
|
|
40
|
+
export declare function extractCodeMarkers(source: string, context: string, originalLines?: number[]): CodeWithMarkers;
|
|
41
|
+
/**
|
|
42
|
+
* Removes every marker comment (`#highlight`, `#endhighlight`, trailing
|
|
43
|
+
* `// #highlight`, `#region` lines) without the empty label rows that
|
|
44
|
+
* `extractCodeMarkers` keeps for display: the code to copy, edit and fork.
|
|
45
|
+
*/
|
|
46
|
+
export declare function stripCodeMarkers(source: string): string;
|
|
47
|
+
/**
|
|
48
|
+
* Applies literal `search → replacement` pairs to source shown in the docs
|
|
49
|
+
* (e.g. `process.env.API_URL` → `"https://…"`), so displayed, edited and
|
|
50
|
+
* forked code runs without the docs build's `define`s.
|
|
51
|
+
*/
|
|
52
|
+
export declare function applySourceReplacements(source: string, replacements: Record<string, string> | undefined): string;
|
|
53
|
+
//# sourceMappingURL=regions.d.ts.map
|
|
@@ -0,0 +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;AAaD,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C,kGAAkG;IAClG,SAAS,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;;;;GAaG;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"}
|