Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.57 KB

BUILDING.md

File metadata and controls

63 lines (40 loc) · 2.57 KB

Building and Testing BlockSuite

Using Playground

To run BlockSuite from source, please ensure you have installed Node.js and pnpm.

pnpm install
pnpm dev

Then there would be multiple entries to choose from:

All these entries are published to try-blocksuite.vercel.app.

And this would build the BlockSuite packages:

pnpm build

Testing

Test Locally

Adding test cases is strongly encouraged when you contribute new features and bug fixes. We use Playwright for E2E test, and vitest for unit test.

To test locally, please make sure browser binaries are already installed via npx playwright install. Then there are multi commands to choose from:

# run tests in headless mode in another terminal window
pnpm test

# or run tests in headed mode for debugging
pnpm test -- --debug

In headed mode, await page.pause() can be used in test cases to suspend the test runner. Note that the usage of the Playwright VSCode extension is also highly recommended.

To test browser compatibility, the BROWSER environment variable can be used:

# supports `firefox|webkit|chromium`
BROWSER=firefox pnpm test

# passing playwright params with the -- syntax
BROWSER=webkit pnpm test -- --debug

To investigate flaky tests, we can mark a test case as test.only, then perform npx playwright test --repeat-each=10 to reproduce the problem by repeated execution. It's also very helpful to run pnpm test -- --debug with await page.pause() added before certain asserters.

Test Collaboration

To test the real-time collaboration feature of BlockSuite locally, please follow these two simple steps:

  1. Open localhost:5173/starter/?init&room=hello in the first browser tab.
  2. Open localhost:5173/starter/?room=hello in a second tab.

See the documentation about what's happening under the hood.