Skip to content

Commit

Permalink
docs: add sveltekit-2 migration (#11330)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Simon H <[email protected]>
  • Loading branch information
hyunbinseo and dummdidumm authored Dec 15, 2023
1 parent 88ce6b0 commit 67e152c
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions packages/migrate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,27 @@

A CLI for migrating Svelte(Kit) codebases.

Run it using
```
npx svelte-migrate [migration]
```

Or if you're using `pnpm`:

```
pnpm dlx svelte-migrate [migration]
```

## Migrations

The available migrations are:
| Migration | From | To | Guide |
| ------------- | --------------------- | --------------------- | --------------------------------------------------------------- |
| `sveltekit-2` | SvelteKit 1.0 | SvelteKit 2.0 | [Website](https://kit.svelte.dev/docs/migrating-to-sveltekit-2) |
| `svelte-4` | Svelte 3 | Svelte 4 | [Website](https://svelte.dev/docs/v4-migration-guide) |
| `package` | `@sveltejs/package@1` | `@sveltejs/package@2` | [#8922](https://github.com/sveltejs/kit/pull/8922) |
| `routes` | SvelteKit pre-1.0 | SvelteKit 1.0 | [#5774](https://github.com/sveltejs/kit/discussions/5774) |

- `routes` - This will update your pre-SvelteKit-1.0 codebase to the SvelteKit 1.0 routes format. The script will automate as much of the conversion as possible, then annotate your codebase with tasks for completion that you can find by searching for `@migration`. Read [the discussion](https://github.com/sveltejs/kit/discussions/5748) for full details.
- `package` - Migration to @sveltejs/package v2. Review the migration guide at [#8922](https://github.com/sveltejs/kit/pull/) and read the updated docs at https://kit.svelte.dev/docs/packaging
- `svelte-4` - This will migrate your codebase from Svelte 3 to Svelte 4
Some migrations may annotate your codebase with tasks for completion that you can find by searching for `@migration`.

## Changelog

Expand Down

0 comments on commit 67e152c

Please sign in to comment.