SpacetimeDB/tools/templates/package.json at master - SpacetimeDB - Git

PublicArchive/SpacetimeDB

mirror of https://github.com/clockworklabs/SpacetimeDB.git synced 2026-05-09 17:19:45 -04:00

Files

T

bradleyshep 7454329a08 Template README + template.json generation tool (#4570 )

# Description of Changes

Adds `tools/templates/` scripts to derive template metadata from
manifests and generate READMEs from quickstart docs. Replaces slug-based
`builtWith` with manifest-derived data and hardcoded quickstart mappings
with discovery from docs.

**Manifest-based `builtWith`** (`update-template-jsons.ts`)

- Reads `package.json`, `Cargo.toml`, and `.csproj` to populate
`builtWith` in `.template.json`.
- Scoped npm packages normalize to scope (`@angular/core` → `angular`).
Excludes `@types/*`. Adds `nodejs` only for nodejs-ts when `@types/node`
is present.
- Root manifests processed before subdirs; primary framework first (e.g.
`react` before `spacetimedb` in react-ts). Dependencies reordered in
package.json where needed.

**Dynamic quickstart discovery** (`generate-template-readmes.ts`)

- Discovers template → quickstart by parsing `--template X` from files
in `docs/docs/00100-intro/00200-quickstarts/`.
- Optional `quickstart` override in `.template.json`; must resolve under
quickstarts dir.
- chat-react-ts has no quickstart; uses manual README.

**New:** `tools/templates/` (update-template-jsons.ts,
generate-template-readmes.ts, README, package.json, pnpm-lock).
**Modified:** all `templates/*/.template.json` (added `builtWith`),
new/generated `templates/*/README.md`.

# API and ABI breaking changes

None.

# Expected complexity level and risk

**1** – Dev tooling only. No runtime or API changes. Scripts are
isolated; failures only affect generated metadata and READMEs.

# Testing

- [ ] `cd tools/templates && pnpm run generate` completes without errors
- [ ] Spot-check `builtWith` and generated READMEs for a few templates

2026-03-20 13:01:58 +00:00

15 lines

350 B

JSON

Raw Permalink Blame History

 {
   "name": "templates-tools",
   "private": true,
   "type": "module",
   "scripts": {
     "generate-readmes": "tsx generate-template-readmes.ts",
     "update-jsons": "tsx update-template-jsons.ts",
     "generate": "pnpm run generate-readmes && pnpm run update-jsons"
   },
   "devDependencies": {
     "tsx": "^4.7.0",
     "@types/node": "^20.0.0"
   }
 }