Skip to content

Commit aa576c2

Browse files
committed
Add a migration guide
1 parent b9a9224 commit aa576c2

File tree

2 files changed

+394
-0
lines changed

2 files changed

+394
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ npm install @domstack/static
2424
- πŸ“’ [v7 Announcement](https://bret.io/blog/2023/reintroducing-top-bun/)
2525
- πŸ“˜ [Full TypeScript Support](#typescript-support)
2626

27+
## Migrating from top-bun
28+
29+
domstack v11 is a major release that renames the project from `top-bun` to `@domstack/static`. The full migration guide is at [docs/v11-migration.md](docs/v11-migration.md). Key changes at a glance:
30+
31+
- **Package**: `top-bun` β†’ `@domstack/static`
32+
- **CLI**: `top-bun`/`tb` β†’ `domstack`/`dom`
33+
- **Programmatic API**: `TopBun` class β†’ `DomStack`, all `TopBun*` types/errors/warnings renamed to `DomStack*`
34+
- **`postVars` removed**: migrate `postVars` exports from `page.vars.js` files to a single `global.data.js` with a default export
35+
- **New reserved filenames**: `global.data.js`, `markdown-it.settings.js`, `page.md`, `*.worker.{js,ts}` are now special β€” rename any colliding files
36+
- **Default layout**: switched from `uhtml-isomorphic` to `preact`; add `uhtml-isomorphic` to your own deps if you import it directly
37+
- **Output paths**: `top-bun-esbuild-meta.json` β†’ `dom-stack-esbuild-meta.json`, `top-bun-defaults/` β†’ `dom-stack-defaults/`
38+
- **Conflict now throws**: using both `browser` in `global.vars.js` and `define` in `esbuild.settings.js` is now a hard error
39+
40+
See [docs/v11-migration.md](docs/v11-migration.md) for the complete migration guide with code examples.
41+
2742
## Table of Contents
2843

2944
[[toc]]
@@ -1555,6 +1570,7 @@ It is also an homage to [substack](https://substack.net) as well as a play on th
15551570
- [CHANGELOG](CHANGELOG.md)
15561571
- [CONTRIBUTING](CONTRIBUTING.md)
15571572
- [Dependencies](dependencygraph.svg)
1573+
- [v11 Migration Guide](docs/v11-migration.md)
15581574

15591575
## License
15601576

0 commit comments

Comments
Β (0)