create-grist-widget 0.3.11 → 0.3.13
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/README.md +2 -2
- package/package.json +1 -1
- package/template/README.md +2 -2
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ pnpm dev
|
|
|
12
12
|
The template — plus every starting example and the logic that composes them — ships
|
|
13
13
|
embedded in this package. Nothing is fetched from GitHub or npm at scaffold time; the SDK
|
|
14
14
|
install right after is the only network access any of these commands make. See
|
|
15
|
-
[
|
|
15
|
+
[Quickstart](https://gristwidgets.com/docs/quickstart) for the full
|
|
16
16
|
walkthrough (dev loop, deploying, embedding in Grist).
|
|
17
17
|
|
|
18
18
|
By default the scaffold starts blank (a two-field editor) and installs its own
|
|
@@ -86,7 +86,7 @@ create-grist-widget list --json # the same, as JSON
|
|
|
86
86
|
## Using Claude Code?
|
|
87
87
|
|
|
88
88
|
The scaffolded project ships a working GitHub Pages deploy pipeline
|
|
89
|
-
([release + dev channels](https://gristwidgets.com/docs/
|
|
89
|
+
([release + dev channels](https://gristwidgets.com/docs/quickstart#understand-the-deploy)), which
|
|
90
90
|
needs a couple of one-time repo settings that only a human can click through. The
|
|
91
91
|
simplest way to get from zero to a deployed widget:
|
|
92
92
|
|
package/package.json
CHANGED
package/template/README.md
CHANGED
|
@@ -13,7 +13,7 @@ When actually embedded, `GristStatusChip` (`src/components/grist-status-chip.tsx
|
|
|
13
13
|
- **ESLint** blocks direct `grist` global usage in `src/` — use the SDK only.
|
|
14
14
|
- Edit `GRIST_OPTIONS.columns` in `App.tsx` to change the required columns (or remove the array entirely to read raw, unmapped records instead); `main.tsx` sets `GristBoundary gate="canRender"` whenever columns are declared. Mapping alerts use `GristSdkAlerts`.
|
|
15
15
|
|
|
16
|
-
Run `pnpm test` — see `src/App.test.tsx` for the pattern (`renderWithGrist` + `presets` from `grist-widget-sdk/emulator/testing`, no browser or real Grist doc needed). Full guide: [Testing](https://gristwidgets.com/docs/
|
|
16
|
+
Run `pnpm test` — see `src/App.test.tsx` for the pattern (`renderWithGrist` + `presets` from `grist-widget-sdk/emulator/testing`, no browser or real Grist doc needed). Full guide: [Testing](https://gristwidgets.com/docs/emulator/testing).
|
|
17
17
|
|
|
18
18
|
**Monorepo dev:** this template resolves `grist-widget-sdk` from `packages/core/dist` (like the other widgets), not from SDK source. After changing the SDK, run `pnpm prebuild` or `pnpm --filter grist-widget-sdk build` before `pnpm dev`.
|
|
19
19
|
|
|
@@ -28,7 +28,7 @@ This is the **source** template. It is consumed two ways:
|
|
|
28
28
|
- **Externally (your own repo):** the `create-grist-widget` CLI
|
|
29
29
|
(`npm create grist-widget my-widget`) copies this template and rewrites the
|
|
30
30
|
dependency to the published npm range (`^0.x`), so nothing points back at
|
|
31
|
-
this repo. See [
|
|
31
|
+
this repo. See [Quickstart](https://gristwidgets.com/docs/quickstart).
|
|
32
32
|
|
|
33
33
|
`pnpm-workspace.yaml` here only pre-approves esbuild's build script so a
|
|
34
34
|
standalone `pnpm install` (pnpm 11) exits cleanly; inside the monorepo it's
|