Skip to content

chore: update readme to explain scripts #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,22 @@ Join the [Svelte Discord server](https://svelte.dev/chat)!

## Development

- Run `pnpm i` to install dependencies
- Run `pnpm dev` in `packages/vite-plugin-svelte` to autobuild plugin
- Run `pnpm dev` in `packages/playground/xxx` to start a Vite app

Note that changes in the plugin needs restart of the Vite dev server.
All scripts work from monorepo-root.
The plugins are unbundled esm, a build step is not required while developing locally, but restarting local dev-servers can be needed to apply changes.

- `pnpm i` to install dependencies
- `pnpm playwright install chromium` to install required playwright browser binaries via local playwright-core

> **NOTE**
> This repo uses `playwright-core` with a bin alias to `playwright` via package.json script
> Calling `pnpm dlx playwright install chromium` will not work.
- `pnpm check` and `pnpm:test` to validate changes
- `pnpm format` to format source code
- `pnpm test:unit`, `pnpm test:serve` or `pnpm test:build` to run a subset of tests
- `pnpm test <e2e-directory-name>` to focus a specific testsuite
- `pnpm changeset` to generate a changeset
- `pnpm generate:types` to generate public types from jsdoc (this is required when changing types and validated in ci)

## Credits

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"type": "module",
"scripts": {
"test": "run-s -c test:unit test:build test:serve",
"test": "run-s -c test:unit \"test:build {@}\" \"test:serve {@}\" --",
"test:unit": "vitest run",
"test:serve": "vitest run -c vitest.config.e2e.ts",
"test:build": "cross-env TEST_BUILD=1 vitest run -c vitest.config.e2e.ts",
Expand Down
Loading