@thedatagrid/docs-kit 0.4.0 → 0.5.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 +11 -0
- package/README.md +23 -0
- package/dist/demos/config.d.ts +14 -0
- package/dist/demos/config.d.ts.map +1 -1
- package/dist/demos/config.js.map +1 -1
- package/dist/demos/vendor.d.ts +5 -1
- package/dist/demos/vendor.d.ts.map +1 -1
- package/dist/demos/vendor.js +6 -2
- package/dist/demos/vendor.js.map +1 -1
- package/dist/fork/codesandbox.d.ts +4 -0
- package/dist/fork/codesandbox.d.ts.map +1 -1
- package/dist/fork/codesandbox.js +5 -3
- package/dist/fork/codesandbox.js.map +1 -1
- package/dist/fork/index.d.ts +12 -0
- package/dist/fork/index.d.ts.map +1 -1
- package/dist/fork/index.js +19 -0
- package/dist/fork/index.js.map +1 -1
- package/dist/fork/stackblitz.d.ts.map +1 -1
- package/dist/fork/stackblitz.js +4 -4
- package/dist/fork/stackblitz.js.map +1 -1
- package/dist/react/fork.d.ts.map +1 -1
- package/dist/react/fork.js +3 -2
- package/dist/react/fork.js.map +1 -1
- package/package.json +1 -1
- package/src/demos/config.ts +15 -0
- package/src/demos/vendor.ts +6 -2
- package/src/fork/codesandbox.ts +8 -3
- package/src/fork/index.ts +31 -0
- package/src/fork/stackblitz.ts +4 -3
- package/src/react/fork.ts +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @thedatagrid/docs-kit
|
|
2
2
|
|
|
3
|
+
## 0.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- f3c34c9: Fork settings for some demos only, and import-map entries that don't trip CSS plugins.
|
|
8
|
+
|
|
9
|
+
- `fork.indexHtmlHead`: HTML put in the `<head>` of the forked sandbox's page (CodeSandbox and StackBlitz), e.g. a `<script src>`.
|
|
10
|
+
- `fork.variants`: settings applied only to the demos whose entry path matches `match` (a regular expression source), on top of the site's `fork` settings. For example, demos named `*-tailwind.demo.tsx` can fork with the Tailwind browser build in the page head.
|
|
11
|
+
- `/fork` exports `resolveForkSettings` and the `ForkSettings` type.
|
|
12
|
+
- Fix: the entry module of an import-map specifier that ends in `.css` (a `libraries` key such as `@acme/grid/theme/ocean.css`, or a CSS file of an npm package) was named `….css.mjs`, which the vanilla-extract esbuild plugin took for one of its own files and failed the build. Entry names no longer contain dots.
|
|
13
|
+
|
|
3
14
|
## 0.4.0
|
|
4
15
|
|
|
5
16
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -102,6 +102,29 @@ export default {
|
|
|
102
102
|
};
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
+
`fork` also takes `indexHtmlHead` (HTML for the `<head>` of the forked
|
|
106
|
+
sandbox's page) and `variants`, for demos that need more than the others. A
|
|
107
|
+
variant applies when `match`, a regular expression source, matches the path of
|
|
108
|
+
the demo's entry file:
|
|
109
|
+
|
|
110
|
+
```js
|
|
111
|
+
fork: {
|
|
112
|
+
dependencies: { '@acme/grid': '1.2.3' },
|
|
113
|
+
entryPrelude: "import '@acme/grid/index.css';",
|
|
114
|
+
variants: [
|
|
115
|
+
{
|
|
116
|
+
// demos named *-tailwind.demo.tsx
|
|
117
|
+
match: '-tailwind\\.demo\\.tsx$',
|
|
118
|
+
indexHtmlHead: '<script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>',
|
|
119
|
+
},
|
|
120
|
+
],
|
|
121
|
+
},
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
A variant's `dependencies`, `devDependencies` and `sourceReplacements` are
|
|
125
|
+
merged over the site's; its `entryPrelude`, `styles` and `indexHtmlHead` are
|
|
126
|
+
added after them.
|
|
127
|
+
|
|
105
128
|
```sh
|
|
106
129
|
docs-kit demos build # → public/gen/demos (+ manifest.json)
|
|
107
130
|
docs-kit demos --watch # rebuild on change, reload open iframes (SSE on :4748)
|
package/dist/demos/config.d.ts
CHANGED
|
@@ -21,6 +21,20 @@ export type ForkConfig = {
|
|
|
21
21
|
styles?: string;
|
|
22
22
|
/** Literal replacements applied to forked files (on top of `sourceReplacements`). */
|
|
23
23
|
sourceReplacements?: Record<string, string>;
|
|
24
|
+
/** HTML put in the `<head>` of the sandbox page (`index.html`), e.g. a `<script src>`. */
|
|
25
|
+
indexHtmlHead?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Settings for some demos only, e.g. the ones that need Tailwind. A variant
|
|
28
|
+
* applies to a demo when `match` (a regular expression source) matches the
|
|
29
|
+
* path of its entry file. Its `dependencies`, `devDependencies` and
|
|
30
|
+
* `sourceReplacements` are merged over the ones above; its `entryPrelude`,
|
|
31
|
+
* `styles` and `indexHtmlHead` are added after them.
|
|
32
|
+
*/
|
|
33
|
+
variants?: ForkVariant[];
|
|
34
|
+
};
|
|
35
|
+
export type ForkVariant = Omit<ForkConfig, 'variants'> & {
|
|
36
|
+
/** Regular expression source, tested against the entry's path: `-tailwind\\.demo\\.tsx$`. */
|
|
37
|
+
match: string;
|
|
24
38
|
};
|
|
25
39
|
/** The frameworks demos can be written in. */
|
|
26
40
|
export type DemoFramework = 'react' | 'vue';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/demos/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,sFAAsF;AACtF,MAAM,MAAM,aAAa,GAAG;IAC1B,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,wFAAwF;IACxF,OAAO,CAAC,EAAE,MAAM,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,uGAAuG;IACvG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/demos/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,sFAAsF;AACtF,MAAM,MAAM,aAAa,GAAG;IAC1B,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,wFAAwF;IACxF,OAAO,CAAC,EAAE,MAAM,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,uGAAuG;IACvG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG;IACvD,6FAA6F;IAC7F,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,aAAa,EACX,YAAY,GACZ,cAAc,GACd,WAAW,GACX,SAAS,GACT,aAAa,GACb,QAAQ,GACR,iBAAiB,GACjB,oBAAoB,GACpB,WAAW,GACX,KAAK,GACL,WAAW,GACX,cAAc,GACd,MAAM,CACT,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,6FAA6F;IAC7F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gGAAgG;IAChG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6FAA6F;IAC7F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;IACnD,8DAA8D;IAC9D,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;IAC7D,6DAA6D;IAC7D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1C,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,uFAAuF;IACvF,WAAW,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAClC,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,4FAA4F;IAC5F,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mFAAmF;IACnF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAChC,kGAAkG;IAClG,YAAY,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACrD,6FAA6F;IAC7F,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACtE,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,yEAAyE;IACzE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kFAAkF;IAClF,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,4FAA4F;AAC5F,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IAC/C,MAAM,EAAE;QACN,QAAQ,EAAE,cAAc,CAAC;QACzB,OAAO,EAAE,cAAc,CAAC;KACzB,CAAC;IACF,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,IAAI,EAAE,UAAU,CAAC;IACjB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC1C,CAAC;AAEF,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAEjE"}
|
package/dist/demos/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/demos/config.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/demos/config.ts"],"names":[],"mappings":"AAkKA,MAAM,UAAU,YAAY,CAAC,MAAqB;IAChD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/dist/demos/vendor.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import type { Plugin } from 'esbuild';
|
|
2
2
|
import type { LibrarySource } from './config.ts';
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* `@scope/pkg/sub` → `scope__pkg__sub`, safe as a file name. Dots go too
|
|
5
|
+
* (`pkg/theme.css` → `pkg__theme_css`): the entry module is `<name>.mjs`, and
|
|
6
|
+
* a `….css.mjs` file is what vanilla-extract and similar plugins claim.
|
|
7
|
+
*/
|
|
4
8
|
export declare function entryNameFor(specifier: string): string;
|
|
5
9
|
export type VendorEntries = {
|
|
6
10
|
/** esbuild entry name → wrapper file. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vendor.d.ts","sourceRoot":"","sources":["../../src/demos/vendor.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AASjD
|
|
1
|
+
{"version":3,"file":"vendor.d.ts","sourceRoot":"","sources":["../../src/demos/vendor.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AASjD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEtD;AAoCD,MAAM,MAAM,aAAa,GAAG;IAC1B,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C,CAAC;AAEF,8DAA8D;AAC9D,wBAAsB,kBAAkB,CAAC,OAAO,EAAE;IAChD,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,GAAG,OAAO,CAAC,aAAa,CAAC,CA8BzB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE;IAC3C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACzC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACvB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;CACd,GAAG,MAAM,CAsBT"}
|
package/dist/demos/vendor.js
CHANGED
|
@@ -19,9 +19,13 @@ import { pathToFileURL } from 'node:url';
|
|
|
19
19
|
import { matchesStub } from "./compile/core.js";
|
|
20
20
|
const VALID_IDENTIFIER = /^[A-Za-z_$][\w$]*$/;
|
|
21
21
|
const RESERVED = new Set('break case catch class const continue debugger default delete do else enum export extends false finally for function if import in instanceof new null return super switch this throw true try typeof var void while with yield let static implements interface package private protected public await'.split(' '));
|
|
22
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* `@scope/pkg/sub` → `scope__pkg__sub`, safe as a file name. Dots go too
|
|
24
|
+
* (`pkg/theme.css` → `pkg__theme_css`): the entry module is `<name>.mjs`, and
|
|
25
|
+
* a `….css.mjs` file is what vanilla-extract and similar plugins claim.
|
|
26
|
+
*/
|
|
23
27
|
export function entryNameFor(specifier) {
|
|
24
|
-
return specifier.replace(/^@/, '').replace(/\//g, '__').replace(/[^\w
|
|
28
|
+
return specifier.replace(/^@/, '').replace(/\//g, '__').replace(/[^\w-]/g, '_');
|
|
25
29
|
}
|
|
26
30
|
/**
|
|
27
31
|
* Export names of an npm package, read by loading it in Node. CommonJS
|
package/dist/demos/vendor.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vendor.js","sourceRoot":"","sources":["../../src/demos/vendor.ts"],"names":[],"mappings":";;;;;;;;AAAA;;;;;GAKG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGhD,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,uSAAuS,CAAC,KAAK,CAC3S,GAAG,CACJ,CACF,CAAC;AAEF
|
|
1
|
+
{"version":3,"file":"vendor.js","sourceRoot":"","sources":["../../src/demos/vendor.ts"],"names":[],"mappings":";;;;;;;;AAAA;;;;;GAKG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGhD,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,uSAAuS,CAAC,KAAK,CAC3S,GAAG,CACJ,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB;IAC5C,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAClF,CAAC;AAID;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAC,SAAiB,EAAE,IAAY,EAAE,SAAmB;IACjF,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;IAC/D,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACrG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,MAAM,kCAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAC,CAAC;QACnD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,UAAU,CAAC,EAAE,CAAC;QAC1E,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACzC,CAAC;IACD,MAAM,WAAW,GAAI,GAAyC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC;IAChG,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CACnC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,YAAY,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAC5G,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,SAAS,IAAK,GAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAClF,CAAC;AASD,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAOxC;IACC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAC1E,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,MAAM,WAAW,GAA2B,EAAE,CAAC;IAC/C,MAAM,gBAAgB,GAA2B,EAAE,CAAC;IAEpD,KAAK,MAAM,SAAS,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC;QAC/C,IAAI,QAAgB,CAAC;QACrB,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,GAAG,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;QACrF,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAChE,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC,mBAAmB,SAAS,+DAA+D,CAAC,CAAC;gBAClG,QAAQ,GAAG,iBAAiB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,GAAG,CAAC,yBAAyB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACtE,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM;oBAAE,KAAK,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACzF,IAAI,KAAK,CAAC,UAAU;oBAAE,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;gBACjE,QAAQ,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACrC,CAAC;QACH,CAAC;QACD,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjC,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IACrC,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAKnC;IACC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAC5D,OAAO;QACL,IAAI,EAAE,yBAAyB;QAC/B,KAAK,CAAC,KAAK;YACT,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACnD,IAAI,IAAI,CAAC,UAAU,EAAE,gBAAgB;oBAAE,OAAO,SAAS,CAAC;gBACxD,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrC,IAAI,OAAO;oBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChE,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC;oBAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;gBAChG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,OAAO,SAAS,CAAC;gBAChD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE;oBAC5C,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,UAAU,EAAE,IAAI;oBAChB,UAAU,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE;iBACvC,CAAC,CAAC;gBACH,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM;oBAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;gBAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;YAC7F,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACrG,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -20,6 +20,8 @@ export type ForkTemplateOptions = {
|
|
|
20
20
|
styles?: string;
|
|
21
21
|
/** Literal replacements applied to every demo file. */
|
|
22
22
|
sourceReplacements?: Record<string, string>;
|
|
23
|
+
/** HTML put in the `<head>` of the sandbox page (`index.html`), e.g. a `<script src>`. */
|
|
24
|
+
indexHtmlHead?: string;
|
|
23
25
|
};
|
|
24
26
|
export type SandboxFiles = Record<string, {
|
|
25
27
|
content: string | Record<string, unknown>;
|
|
@@ -28,6 +30,8 @@ export type SandboxFiles = Record<string, {
|
|
|
28
30
|
export declare function commonDir(paths: string[]): string;
|
|
29
31
|
export declare function replaceAll(source: string, replacements: Record<string, string> | undefined): string;
|
|
30
32
|
export declare const BASE_STYLES = "html,\nbody,\n#root {\n height: 100%;\n margin: 0;\n}\n\n* {\n box-sizing: border-box;\n}\n\nbody {\n font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', sans-serif;\n}\n\n#root {\n display: flex;\n flex-flow: column;\n overflow: hidden;\n}\n";
|
|
33
|
+
/** `indexHtmlHead`, indented to sit in the page's `<head>`. */
|
|
34
|
+
export declare const indexHtmlHead: (head: string | undefined) => string;
|
|
31
35
|
export type PlacedFiles = {
|
|
32
36
|
/** Path of a demo file inside the sandbox. */
|
|
33
37
|
inSrc(filePath: string): string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"codesandbox.d.ts","sourceRoot":"","sources":["../../src/fork/codesandbox.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,sBAAsB,mDAAmD,CAAC;AAEvF,MAAM,MAAM,QAAQ,GAAG;IACrB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"codesandbox.d.ts","sourceRoot":"","sources":["../../src/fork/codesandbox.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,sBAAsB,mDAAmD,CAAC;AAEvF,MAAM,MAAM,QAAQ,GAAG;IACrB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC,CAAC;AAQzF,sDAAsD;AACtD,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAUjD;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,GAAG,MAAM,CAKnG;AAED,eAAO,MAAM,WAAW,gSAoBvB,CAAC;AAEF,+DAA+D;AAC/D,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,GAAG,SAAS,WAAiD,CAAC;AAexG,MAAM,MAAM,WAAW,GAAG;IACxB,8CAA8C;IAC9C,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,wBAAgB,UAAU,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB,GAAG,WAAW,CAcvF;AAWD,oEAAoE;AACpE,eAAO,MAAM,UAAU,GAAI,SAAS,mBAAmB,WACW,CAAC;AAEnE,eAAO,MAAM,WAAW,GAAI,SAAS,mBAAmB,WAAqE,CAAC;AAE9H,8EAA8E;AAC9E,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB,GAAG,YAAY,CA4C/F;AAED,wEAAwE;AACxE,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAKnE;AAED,0DAA0D;AAC1D,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB;;;;EAS9E"}
|
package/dist/fork/codesandbox.js
CHANGED
|
@@ -61,13 +61,15 @@ body {
|
|
|
61
61
|
overflow: hidden;
|
|
62
62
|
}
|
|
63
63
|
`;
|
|
64
|
-
|
|
64
|
+
/** `indexHtmlHead`, indented to sit in the page's `<head>`. */
|
|
65
|
+
export const indexHtmlHead = (head) => (head?.trim() ? ` ${head.trim()}\n` : '');
|
|
66
|
+
const INDEX_HTML = (title, head) => `<!DOCTYPE html>
|
|
65
67
|
<html lang="en">
|
|
66
68
|
<head>
|
|
67
69
|
<meta charset="UTF-8" />
|
|
68
70
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
69
71
|
<title>${title.replace(/</g, '<')}</title>
|
|
70
|
-
</head>
|
|
72
|
+
${indexHtmlHead(head)} </head>
|
|
71
73
|
<body>
|
|
72
74
|
<div id="root"></div>
|
|
73
75
|
</body>
|
|
@@ -126,7 +128,7 @@ export function reactSandboxFiles(files, options) {
|
|
|
126
128
|
browserslist: ['>0.2%', 'not dead'],
|
|
127
129
|
},
|
|
128
130
|
},
|
|
129
|
-
'public/index.html': { content: INDEX_HTML(options.title) },
|
|
131
|
+
'public/index.html': { content: INDEX_HTML(options.title, options.indexHtmlHead) },
|
|
130
132
|
'sandbox.config.json': { content: { infiniteLoopProtection: true } },
|
|
131
133
|
'src/styles.css': { content: forkStyles(options) },
|
|
132
134
|
'src/index.tsx': {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"codesandbox.js","sourceRoot":"","sources":["../../src/fork/codesandbox.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,QAAQ,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE9D,MAAM,CAAC,MAAM,sBAAsB,GAAG,gDAAgD,CAAC;
|
|
1
|
+
{"version":3,"file":"codesandbox.js","sourceRoot":"","sources":["../../src/fork/codesandbox.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,QAAQ,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE9D,MAAM,CAAC,MAAM,sBAAsB,GAAG,gDAAgD,CAAC;AA8BvF,SAAS,WAAW,CAAC,QAAgB;IACnC,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrD,QAAQ,CAAC,GAAG,EAAE,CAAC;IACf,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,SAAS,CAAC,KAAe;IACvC,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAC7B,IAAI,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC;YAAE,CAAC,EAAE,CAAC;QAClF,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,YAAgD;IACzF,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;QAAE,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;;;;CAoB1B,CAAC;AAEF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAwB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAExG,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,IAAa,EAAE,EAAE,CAAC;;;;;aAKxC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;EACtC,aAAa,CAAC,IAAI,CAAC;;;;;CAKpB,CAAC;AAWF,MAAM,UAAU,UAAU,CAAC,KAAiB,EAAE,OAA4B;IACxE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,CAAC,KAAK,2BAA2B,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/F,MAAM,QAAQ,GAA2B,EAAE,CAAC;IAC5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC;AAC5F,CAAC;AAED,SAAS,YAAY,CAAC,OAAqB,EAAE,KAAiB,EAAE,MAAmB,EAAE,OAA4B;IAC/G,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,CAAC,MAAM,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,gCAAgC,CAAC,CAAC;QACvF,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;IACtF,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,oEAAoE;AACpE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAA4B,EAAE,EAAE,CACzD,GAAG,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAEnE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAA4B,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAE9H,8EAA8E;AAC9E,MAAM,UAAU,iBAAiB,CAAC,KAAiB,EAAE,OAA4B;IAC/E,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAiB;QAC5B,cAAc,EAAE;YACd,OAAO,EAAE;gBACP,IAAI,EAAE,WAAW;gBACjB,WAAW,EAAE,OAAO,CAAC,KAAK;gBAC1B,IAAI,EAAE,eAAe;gBACrB,YAAY,EAAE;oBACZ,GAAG,MAAM,CAAC,QAAQ;oBAClB,KAAK,EAAE,SAAS;oBAChB,WAAW,EAAE,SAAS;oBACtB,eAAe,EAAE,QAAQ;oBACzB,GAAG,OAAO,CAAC,YAAY;iBACxB;gBACD,eAAe,EAAE;oBACf,UAAU,EAAE,QAAQ;oBACpB,cAAc,EAAE,SAAS;oBACzB,kBAAkB,EAAE,SAAS;oBAC7B,GAAG,OAAO,CAAC,eAAe;iBAC3B;gBACD,OAAO,EAAE,EAAE,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,qBAAqB,EAAE;gBACvE,YAAY,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;aACpC;SACF;QACD,mBAAmB,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE;QAClF,qBAAqB,EAAE,EAAE,OAAO,EAAE,EAAE,sBAAsB,EAAE,IAAI,EAAE,EAAE;QACpE,gBAAgB,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;QAClD,eAAe,EAAE;YACf,OAAO,EAAE;;EAEb,WAAW,CAAC,OAAO,CAAC;;kBAEJ,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;;;;;;;CAOlF;SACI;KACF,CAAC;IACF,OAAO,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,uBAAuB,CAAC,KAAmB;IACzD,OAAO,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;SACxD,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACxB,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,eAAe,CAAC,KAAiB,EAAE,OAA4B;IAC7E,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACxF,OAAO;QACL,MAAM,EAAE,sBAAsB;QAC9B,UAAU,EAAE,uBAAuB,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,SAAS,UAAU,EAAE;KAC7B,CAAC;AACJ,CAAC"}
|
package/dist/fork/index.d.ts
CHANGED
|
@@ -2,6 +2,18 @@ import { type ForkFile, type ForkTemplateOptions } from './codesandbox.ts';
|
|
|
2
2
|
export { CODESANDBOX_DEFINE_URL, codeSandboxForm, commonDir, encodeSandboxParameters, reactSandboxFiles, type ForkFile, type ForkTemplateOptions, type SandboxFiles, } from './codesandbox.ts';
|
|
3
3
|
export { STACKBLITZ_RUN_URL, stackBlitzForm, vueProjectFiles } from './stackblitz.ts';
|
|
4
4
|
export type ForkFramework = 'react' | 'vue';
|
|
5
|
+
type ForkTemplateSettings = Pick<ForkTemplateOptions, 'dependencies' | 'devDependencies' | 'entryPrelude' | 'styles' | 'sourceReplacements' | 'indexHtmlHead'>;
|
|
6
|
+
/** The fork settings of a site (`fork` in docs-kit.config), with its per-demo variants. */
|
|
7
|
+
export type ForkSettings = ForkTemplateSettings & {
|
|
8
|
+
variants?: (ForkTemplateSettings & {
|
|
9
|
+
match: string;
|
|
10
|
+
})[];
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* The fork settings for one demo: the site's, with every variant whose
|
|
14
|
+
* `match` matches the entry's path applied on top, in order.
|
|
15
|
+
*/
|
|
16
|
+
export declare function resolveForkSettings(settings: ForkSettings, entry: string): ForkTemplateSettings;
|
|
5
17
|
/** Where a framework's demos fork to. */
|
|
6
18
|
export declare const FORK_TARGETS: Record<ForkFramework, {
|
|
7
19
|
id: 'codesandbox' | 'stackblitz';
|
package/dist/fork/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fork/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,QAAQ,EAAE,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAG5F,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,SAAS,EACT,uBAAuB,EACvB,iBAAiB,EACjB,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACxB,KAAK,YAAY,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEtF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5C,yCAAyC;AACzC,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,aAAa,EAAE;IAAE,EAAE,EAAE,aAAa,GAAG,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAGlG,CAAC;AAEF;;;GAGG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,EAAE,mBAAmB,GAAG;IAAE,SAAS,CAAC,EAAE,aAAa,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAIpD"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fork/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,QAAQ,EAAE,KAAK,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAG5F,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,SAAS,EACT,uBAAuB,EACvB,iBAAiB,EACjB,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACxB,KAAK,YAAY,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEtF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5C,KAAK,oBAAoB,GAAG,IAAI,CAC9B,mBAAmB,EACnB,cAAc,GAAG,iBAAiB,GAAG,cAAc,GAAG,QAAQ,GAAG,oBAAoB,GAAG,eAAe,CACxG,CAAC;AAEF,2FAA2F;AAC3F,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,QAAQ,CAAC,EAAE,CAAC,oBAAoB,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;CACzD,CAAC;AAKF;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAY/F;AAED,yCAAyC;AACzC,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,aAAa,EAAE;IAAE,EAAE,EAAE,aAAa,GAAG,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAGlG,CAAC;AAEF;;;GAGG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,EAAE,mBAAmB,GAAG;IAAE,SAAS,CAAC,EAAE,aAAa,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAIpD"}
|
package/dist/fork/index.js
CHANGED
|
@@ -2,6 +2,25 @@ import { codeSandboxForm } from "./codesandbox.js";
|
|
|
2
2
|
import { stackBlitzForm } from "./stackblitz.js";
|
|
3
3
|
export { CODESANDBOX_DEFINE_URL, codeSandboxForm, commonDir, encodeSandboxParameters, reactSandboxFiles, } from "./codesandbox.js";
|
|
4
4
|
export { STACKBLITZ_RUN_URL, stackBlitzForm, vueProjectFiles } from "./stackblitz.js";
|
|
5
|
+
const joinBlocks = (...blocks) => blocks.filter((block) => block?.trim()).join('\n') || undefined;
|
|
6
|
+
/**
|
|
7
|
+
* The fork settings for one demo: the site's, with every variant whose
|
|
8
|
+
* `match` matches the entry's path applied on top, in order.
|
|
9
|
+
*/
|
|
10
|
+
export function resolveForkSettings(settings, entry) {
|
|
11
|
+
const { variants = [], ...resolved } = settings;
|
|
12
|
+
for (const { match, ...variant } of variants) {
|
|
13
|
+
if (!new RegExp(match).test(entry))
|
|
14
|
+
continue;
|
|
15
|
+
resolved.dependencies = { ...resolved.dependencies, ...variant.dependencies };
|
|
16
|
+
resolved.devDependencies = { ...resolved.devDependencies, ...variant.devDependencies };
|
|
17
|
+
resolved.sourceReplacements = { ...resolved.sourceReplacements, ...variant.sourceReplacements };
|
|
18
|
+
resolved.entryPrelude = joinBlocks(resolved.entryPrelude, variant.entryPrelude);
|
|
19
|
+
resolved.styles = joinBlocks(resolved.styles, variant.styles);
|
|
20
|
+
resolved.indexHtmlHead = joinBlocks(resolved.indexHtmlHead, variant.indexHtmlHead);
|
|
21
|
+
}
|
|
22
|
+
return resolved;
|
|
23
|
+
}
|
|
5
24
|
/** Where a framework's demos fork to. */
|
|
6
25
|
export const FORK_TARGETS = {
|
|
7
26
|
react: { id: 'codesandbox', name: 'CodeSandbox' },
|
package/dist/fork/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fork/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAA2C,MAAM,kBAAkB,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,SAAS,EACT,uBAAuB,EACvB,iBAAiB,GAIlB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fork/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAA2C,MAAM,kBAAkB,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,SAAS,EACT,uBAAuB,EACvB,iBAAiB,GAIlB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AActF,MAAM,UAAU,GAAG,CAAC,GAAG,MAA8B,EAAE,EAAE,CACvD,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AAElE;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAsB,EAAE,KAAa;IACvE,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAC;IAChD,KAAK,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,SAAS;QAC7C,QAAQ,CAAC,YAAY,GAAG,EAAE,GAAG,QAAQ,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;QAC9E,QAAQ,CAAC,eAAe,GAAG,EAAE,GAAG,QAAQ,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;QACvF,QAAQ,CAAC,kBAAkB,GAAG,EAAE,GAAG,QAAQ,CAAC,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;QAChG,QAAQ,CAAC,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAChF,QAAQ,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9D,QAAQ,CAAC,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,yCAAyC;AACzC,MAAM,CAAC,MAAM,YAAY,GAA8E;IACrG,KAAK,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE;IACjD,GAAG,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE;CAC9C,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAiB,EACjB,OAA4D;IAE5D,IAAI,OAAO,CAAC,SAAS,KAAK,KAAK;QAAE,OAAO,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACvE,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;AAC7F,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stackblitz.d.ts","sourceRoot":"","sources":["../../src/fork/stackblitz.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,
|
|
1
|
+
{"version":3,"file":"stackblitz.d.ts","sourceRoot":"","sources":["../../src/fork/stackblitz.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAML,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACzB,MAAM,kBAAkB,CAAC;AAE1B,eAAO,MAAM,kBAAkB,+BAA+B,CAAC;AAkB/D,oGAAoG;AACpG,wBAAgB,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAwDvG;AAED,2FAA2F;AAC3F,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB;;;EAW7E"}
|
package/dist/fork/stackblitz.js
CHANGED
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
* Like the CodeSandbox payload, the demo's files keep their folder structure
|
|
7
7
|
* under `src/`, and `src/main.ts` imports the entry by its relative path.
|
|
8
8
|
*/
|
|
9
|
-
import { forkPrelude, forkStyles, placeFiles, replaceAll, } from "./codesandbox.js";
|
|
9
|
+
import { forkPrelude, forkStyles, indexHtmlHead, placeFiles, replaceAll, } from "./codesandbox.js";
|
|
10
10
|
export const STACKBLITZ_RUN_URL = 'https://stackblitz.com/run';
|
|
11
|
-
const INDEX_HTML = (title) => `<!DOCTYPE html>
|
|
11
|
+
const INDEX_HTML = (title, head) => `<!DOCTYPE html>
|
|
12
12
|
<html lang="en">
|
|
13
13
|
<head>
|
|
14
14
|
<meta charset="UTF-8" />
|
|
15
15
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
16
16
|
<title>${title.replace(/</g, '<')}</title>
|
|
17
|
-
</head>
|
|
17
|
+
${indexHtmlHead(head)} </head>
|
|
18
18
|
<body>
|
|
19
19
|
<div id="root"></div>
|
|
20
20
|
<script type="module" src="/src/main.ts"></script>
|
|
@@ -44,7 +44,7 @@ export function vueProjectFiles(files, options) {
|
|
|
44
44
|
...options.devDependencies,
|
|
45
45
|
},
|
|
46
46
|
}),
|
|
47
|
-
'index.html': INDEX_HTML(options.title),
|
|
47
|
+
'index.html': INDEX_HTML(options.title, options.indexHtmlHead),
|
|
48
48
|
'vite.config.ts': `import { defineConfig } from 'vite';
|
|
49
49
|
import vue from '@vitejs/plugin-vue';
|
|
50
50
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stackblitz.js","sourceRoot":"","sources":["../../src/fork/stackblitz.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EACL,WAAW,EACX,UAAU,EACV,UAAU,EACV,UAAU,GAGX,MAAM,kBAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,kBAAkB,GAAG,4BAA4B,CAAC;AAE/D,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC;;;;;
|
|
1
|
+
{"version":3,"file":"stackblitz.js","sourceRoot":"","sources":["../../src/fork/stackblitz.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EACL,WAAW,EACX,UAAU,EACV,aAAa,EACb,UAAU,EACV,UAAU,GAGX,MAAM,kBAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,kBAAkB,GAAG,4BAA4B,CAAC;AAE/D,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,IAAa,EAAE,EAAE,CAAC;;;;;aAKxC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;EACtC,aAAa,CAAC,IAAI,CAAC;;;;;;CAMpB,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAEvE,oGAAoG;AACpG,MAAM,UAAU,eAAe,CAAC,KAAiB,EAAE,OAA4B;IAC7E,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC1C,MAAM,OAAO,GAA2B;QACtC,cAAc,EAAE,IAAI,CAAC;YACnB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,OAAO,CAAC,KAAK;YAC1B,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE;YAC7C,YAAY,EAAE;gBACZ,GAAG,MAAM,CAAC,QAAQ;gBAClB,GAAG,EAAE,QAAQ;gBACb,GAAG,OAAO,CAAC,YAAY;aACxB;YACD,eAAe,EAAE;gBACf,oBAAoB,EAAE,QAAQ;gBAC9B,UAAU,EAAE,QAAQ;gBACpB,IAAI,EAAE,QAAQ;gBACd,GAAG,OAAO,CAAC,eAAe;aAC3B;SACF,CAAC;QACF,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC;QAC9D,gBAAgB,EAAE;;;;CAIrB;QACG,eAAe,EAAE,IAAI,CAAC;YACpB,eAAe,EAAE;gBACf,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,QAAQ;gBAChB,gBAAgB,EAAE,SAAS;gBAC3B,MAAM,EAAE,IAAI;gBACZ,GAAG,EAAE,UAAU;gBACf,eAAe,EAAE,KAAK;gBACtB,YAAY,EAAE,IAAI;gBAClB,GAAG,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,cAAc,CAAC;aACvC;YACD,OAAO,EAAE,CAAC,KAAK,CAAC;SACjB,CAAC;QACF,mBAAmB,EAAE,yCAAyC;QAC9D,gBAAgB,EAAE,UAAU,CAAC,OAAO,CAAC;QACrC,aAAa,EAAE;EACjB,WAAW,CAAC,OAAO,CAAC;;kBAEJ,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC;;;CAGnD;KACE,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,gCAAgC,CAAC,CAAC;QAC/F,OAAO,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,cAAc,CAAC,KAAiB,EAAE,OAA4B;IAC5E,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,MAAM,GAA2B;QACrC,gBAAgB,EAAE,OAAO,CAAC,KAAK;QAC/B,sBAAsB,EAAE,OAAO,CAAC,KAAK;QACrC,sDAAsD;QACtD,mBAAmB,EAAE,MAAM;KAC5B,CAAC;IACF,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,MAAM,CAAC,kBAAkB,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC;IAC3G,OAAO,EAAE,MAAM,EAAE,GAAG,kBAAkB,SAAS,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC;AACvF,CAAC"}
|
package/dist/react/fork.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fork.d.ts","sourceRoot":"","sources":["../../src/react/fork.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,
|
|
1
|
+
{"version":3,"file":"fork.d.ts","sourceRoot":"","sources":["../../src/react/fork.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAiC,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEpG,4GAA4G;AAC5G,wBAAgB,QAAQ,CAAC,OAAO,EAAE;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B,QA4BA"}
|
package/dist/react/fork.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { forkForm } from "../fork/index.js";
|
|
1
|
+
import { forkForm, resolveForkSettings } from "../fork/index.js";
|
|
2
2
|
/** Posts the demo (with any edits) to its fork target (CodeSandbox, or StackBlitz for Vue) in a new tab. */
|
|
3
3
|
export function forkDemo(options) {
|
|
4
|
-
const
|
|
4
|
+
const config = resolveForkSettings(options.config ?? {}, options.entry);
|
|
5
5
|
const form = forkForm(options.files, {
|
|
6
6
|
framework: options.framework,
|
|
7
7
|
title: options.title,
|
|
@@ -11,6 +11,7 @@ export function forkDemo(options) {
|
|
|
11
11
|
entryPrelude: config.entryPrelude,
|
|
12
12
|
styles: config.styles,
|
|
13
13
|
sourceReplacements: config.sourceReplacements,
|
|
14
|
+
indexHtmlHead: config.indexHtmlHead,
|
|
14
15
|
});
|
|
15
16
|
const el = document.createElement('form');
|
|
16
17
|
el.action = form.action;
|
package/dist/react/fork.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fork.js","sourceRoot":"","sources":["../../src/react/fork.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAqC,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"fork.js","sourceRoot":"","sources":["../../src/react/fork.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAqC,MAAM,kBAAkB,CAAC;AAEpG,4GAA4G;AAC5G,MAAM,UAAU,QAAQ,CAAC,OAMxB;IACC,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACxE,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE;QACnC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IACH,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IACxB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;IACnB,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC;IACrB,EAAE,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC9C,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC;QACtB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACpB,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IACD,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC9B,EAAE,CAAC,MAAM,EAAE,CAAC;IACZ,EAAE,CAAC,MAAM,EAAE,CAAC;AACd,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thedatagrid/docs-kit",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Docs tooling: type-checked file snippets with regions and highlights, prebuilt and editable live demos for React and Vue, CodeSandbox forks, docs per framework, scripted showcase demos",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
package/src/demos/config.ts
CHANGED
|
@@ -24,6 +24,21 @@ export type ForkConfig = {
|
|
|
24
24
|
styles?: string;
|
|
25
25
|
/** Literal replacements applied to forked files (on top of `sourceReplacements`). */
|
|
26
26
|
sourceReplacements?: Record<string, string>;
|
|
27
|
+
/** HTML put in the `<head>` of the sandbox page (`index.html`), e.g. a `<script src>`. */
|
|
28
|
+
indexHtmlHead?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Settings for some demos only, e.g. the ones that need Tailwind. A variant
|
|
31
|
+
* applies to a demo when `match` (a regular expression source) matches the
|
|
32
|
+
* path of its entry file. Its `dependencies`, `devDependencies` and
|
|
33
|
+
* `sourceReplacements` are merged over the ones above; its `entryPrelude`,
|
|
34
|
+
* `styles` and `indexHtmlHead` are added after them.
|
|
35
|
+
*/
|
|
36
|
+
variants?: ForkVariant[];
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
export type ForkVariant = Omit<ForkConfig, 'variants'> & {
|
|
40
|
+
/** Regular expression source, tested against the entry's path: `-tailwind\\.demo\\.tsx$`. */
|
|
41
|
+
match: string;
|
|
27
42
|
};
|
|
28
43
|
|
|
29
44
|
/** The frameworks demos can be written in. */
|
package/src/demos/vendor.ts
CHANGED
|
@@ -20,9 +20,13 @@ const RESERVED = new Set(
|
|
|
20
20
|
),
|
|
21
21
|
);
|
|
22
22
|
|
|
23
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* `@scope/pkg/sub` → `scope__pkg__sub`, safe as a file name. Dots go too
|
|
25
|
+
* (`pkg/theme.css` → `pkg__theme_css`): the entry module is `<name>.mjs`, and
|
|
26
|
+
* a `….css.mjs` file is what vanilla-extract and similar plugins claim.
|
|
27
|
+
*/
|
|
24
28
|
export function entryNameFor(specifier: string): string {
|
|
25
|
-
return specifier.replace(/^@/, '').replace(/\//g, '__').replace(/[^\w
|
|
29
|
+
return specifier.replace(/^@/, '').replace(/\//g, '__').replace(/[^\w-]/g, '_');
|
|
26
30
|
}
|
|
27
31
|
|
|
28
32
|
type ExportShape = { names: string[]; hasDefault: boolean } | null;
|
package/src/fork/codesandbox.ts
CHANGED
|
@@ -38,6 +38,8 @@ export type ForkTemplateOptions = {
|
|
|
38
38
|
styles?: string;
|
|
39
39
|
/** Literal replacements applied to every demo file. */
|
|
40
40
|
sourceReplacements?: Record<string, string>;
|
|
41
|
+
/** HTML put in the `<head>` of the sandbox page (`index.html`), e.g. a `<script src>`. */
|
|
42
|
+
indexHtmlHead?: string;
|
|
41
43
|
};
|
|
42
44
|
|
|
43
45
|
export type SandboxFiles = Record<string, { content: string | Record<string, unknown> }>;
|
|
@@ -90,13 +92,16 @@ body {
|
|
|
90
92
|
}
|
|
91
93
|
`;
|
|
92
94
|
|
|
93
|
-
|
|
95
|
+
/** `indexHtmlHead`, indented to sit in the page's `<head>`. */
|
|
96
|
+
export const indexHtmlHead = (head: string | undefined) => (head?.trim() ? ` ${head.trim()}\n` : '');
|
|
97
|
+
|
|
98
|
+
const INDEX_HTML = (title: string, head?: string) => `<!DOCTYPE html>
|
|
94
99
|
<html lang="en">
|
|
95
100
|
<head>
|
|
96
101
|
<meta charset="UTF-8" />
|
|
97
102
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
98
103
|
<title>${title.replace(/</g, '<')}</title>
|
|
99
|
-
</head>
|
|
104
|
+
${indexHtmlHead(head)} </head>
|
|
100
105
|
<body>
|
|
101
106
|
<div id="root"></div>
|
|
102
107
|
</body>
|
|
@@ -169,7 +174,7 @@ export function reactSandboxFiles(files: ForkFile[], options: ForkTemplateOption
|
|
|
169
174
|
browserslist: ['>0.2%', 'not dead'],
|
|
170
175
|
},
|
|
171
176
|
},
|
|
172
|
-
'public/index.html': { content: INDEX_HTML(options.title) },
|
|
177
|
+
'public/index.html': { content: INDEX_HTML(options.title, options.indexHtmlHead) },
|
|
173
178
|
'sandbox.config.json': { content: { infiniteLoopProtection: true } },
|
|
174
179
|
'src/styles.css': { content: forkStyles(options) },
|
|
175
180
|
'src/index.tsx': {
|
package/src/fork/index.ts
CHANGED
|
@@ -15,6 +15,37 @@ export { STACKBLITZ_RUN_URL, stackBlitzForm, vueProjectFiles } from './stackblit
|
|
|
15
15
|
|
|
16
16
|
export type ForkFramework = 'react' | 'vue';
|
|
17
17
|
|
|
18
|
+
type ForkTemplateSettings = Pick<
|
|
19
|
+
ForkTemplateOptions,
|
|
20
|
+
'dependencies' | 'devDependencies' | 'entryPrelude' | 'styles' | 'sourceReplacements' | 'indexHtmlHead'
|
|
21
|
+
>;
|
|
22
|
+
|
|
23
|
+
/** The fork settings of a site (`fork` in docs-kit.config), with its per-demo variants. */
|
|
24
|
+
export type ForkSettings = ForkTemplateSettings & {
|
|
25
|
+
variants?: (ForkTemplateSettings & { match: string })[];
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
const joinBlocks = (...blocks: (string | undefined)[]) =>
|
|
29
|
+
blocks.filter((block) => block?.trim()).join('\n') || undefined;
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* The fork settings for one demo: the site's, with every variant whose
|
|
33
|
+
* `match` matches the entry's path applied on top, in order.
|
|
34
|
+
*/
|
|
35
|
+
export function resolveForkSettings(settings: ForkSettings, entry: string): ForkTemplateSettings {
|
|
36
|
+
const { variants = [], ...resolved } = settings;
|
|
37
|
+
for (const { match, ...variant } of variants) {
|
|
38
|
+
if (!new RegExp(match).test(entry)) continue;
|
|
39
|
+
resolved.dependencies = { ...resolved.dependencies, ...variant.dependencies };
|
|
40
|
+
resolved.devDependencies = { ...resolved.devDependencies, ...variant.devDependencies };
|
|
41
|
+
resolved.sourceReplacements = { ...resolved.sourceReplacements, ...variant.sourceReplacements };
|
|
42
|
+
resolved.entryPrelude = joinBlocks(resolved.entryPrelude, variant.entryPrelude);
|
|
43
|
+
resolved.styles = joinBlocks(resolved.styles, variant.styles);
|
|
44
|
+
resolved.indexHtmlHead = joinBlocks(resolved.indexHtmlHead, variant.indexHtmlHead);
|
|
45
|
+
}
|
|
46
|
+
return resolved;
|
|
47
|
+
}
|
|
48
|
+
|
|
18
49
|
/** Where a framework's demos fork to. */
|
|
19
50
|
export const FORK_TARGETS: Record<ForkFramework, { id: 'codesandbox' | 'stackblitz'; name: string }> = {
|
|
20
51
|
react: { id: 'codesandbox', name: 'CodeSandbox' },
|
package/src/fork/stackblitz.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
import {
|
|
10
10
|
forkPrelude,
|
|
11
11
|
forkStyles,
|
|
12
|
+
indexHtmlHead,
|
|
12
13
|
placeFiles,
|
|
13
14
|
replaceAll,
|
|
14
15
|
type ForkFile,
|
|
@@ -17,13 +18,13 @@ import {
|
|
|
17
18
|
|
|
18
19
|
export const STACKBLITZ_RUN_URL = 'https://stackblitz.com/run';
|
|
19
20
|
|
|
20
|
-
const INDEX_HTML = (title: string) => `<!DOCTYPE html>
|
|
21
|
+
const INDEX_HTML = (title: string, head?: string) => `<!DOCTYPE html>
|
|
21
22
|
<html lang="en">
|
|
22
23
|
<head>
|
|
23
24
|
<meta charset="UTF-8" />
|
|
24
25
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
25
26
|
<title>${title.replace(/</g, '<')}</title>
|
|
26
|
-
</head>
|
|
27
|
+
${indexHtmlHead(head)} </head>
|
|
27
28
|
<body>
|
|
28
29
|
<div id="root"></div>
|
|
29
30
|
<script type="module" src="/src/main.ts"></script>
|
|
@@ -55,7 +56,7 @@ export function vueProjectFiles(files: ForkFile[], options: ForkTemplateOptions)
|
|
|
55
56
|
...options.devDependencies,
|
|
56
57
|
},
|
|
57
58
|
}),
|
|
58
|
-
'index.html': INDEX_HTML(options.title),
|
|
59
|
+
'index.html': INDEX_HTML(options.title, options.indexHtmlHead),
|
|
59
60
|
'vite.config.ts': `import { defineConfig } from 'vite';
|
|
60
61
|
import vue from '@vitejs/plugin-vue';
|
|
61
62
|
|
package/src/react/fork.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ForkConfig } from '../demos/config.ts';
|
|
2
|
-
import { forkForm, type ForkFile, type ForkFramework } from '../fork/index.ts';
|
|
2
|
+
import { forkForm, resolveForkSettings, type ForkFile, type ForkFramework } from '../fork/index.ts';
|
|
3
3
|
|
|
4
4
|
/** Posts the demo (with any edits) to its fork target (CodeSandbox, or StackBlitz for Vue) in a new tab. */
|
|
5
5
|
export function forkDemo(options: {
|
|
@@ -9,7 +9,7 @@ export function forkDemo(options: {
|
|
|
9
9
|
config?: ForkConfig;
|
|
10
10
|
framework?: ForkFramework;
|
|
11
11
|
}) {
|
|
12
|
-
const
|
|
12
|
+
const config = resolveForkSettings(options.config ?? {}, options.entry);
|
|
13
13
|
const form = forkForm(options.files, {
|
|
14
14
|
framework: options.framework,
|
|
15
15
|
title: options.title,
|
|
@@ -19,6 +19,7 @@ export function forkDemo(options: {
|
|
|
19
19
|
entryPrelude: config.entryPrelude,
|
|
20
20
|
styles: config.styles,
|
|
21
21
|
sourceReplacements: config.sourceReplacements,
|
|
22
|
+
indexHtmlHead: config.indexHtmlHead,
|
|
22
23
|
});
|
|
23
24
|
const el = document.createElement('form');
|
|
24
25
|
el.action = form.action;
|