Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

115 lines (75 loc) · 3.17 KB
Raw

Contribute to vite-plugin-ssr


System requirements

  • Unix (e.g. macOS or Linux). (Windows may work but there are no guarantees.)
  • Node.js >= v15.0.0.
  • pnpm >= v6.21.0. (To install it: $ npm install -g pnpm.)

These requirements are for developing only; vite-plugin-ssr can be used with any package manager, Windows, and Node.js >= v12.19.0.


Install & build

Install all dependencies of the entire monorepo:

git clone git@github.com:brillout/vite-plugin-ssr
cd vite-plugin-ssr/
pnpm run setup
pnpm install

We need pnpm run setup for setting up the libframe/ submodule.

Build the vite-plugin-ssr source code:

pnpm run build

Create new example

New examples should be minimal and implement only what you want to showcase.

Start off with /examples/react/ or /examples/vue/ as these are minimal demos.

Do not start off /examples/react-full/ nor /examples/vue-full/ as these are full-featured demos.


Modify existing example

Follow the instructions of Install & Build.

We do not follow the README instructions of the example, instead we install the entire monorepo in order to be able to run the example's test.

To run the example:

cd examples/some-example/
pnpm run dev
# Or, depending on the example:
pnpm run start

Check whether the tests defined in examples/some-example/*.spec.ts are still valid and make changes accordingly.

To run the example's tests, follow the instructions of Run test suite.


Modify vite-plugin-ssr

Follow the instructions of Install & Build.

Run TypeScript in watch mode:

pnpm run dev

You can now change the source code of vite-plugin-ssr (/vite-plugin-ssr/) and try your modifications with one of the examples (/examples/*) or boilerplates (/boilerplates/boilerplate-*). You may need to restart the example's Node.js server for your modifications to apply.

If you are having problems running the test suite (e.g. your machine has low memory), you can open a Pull Request in draft mode to let GitHub Actions run the test suite for you.


Run test suite

Follow the instructions of Install & Build.

On Debian, these additional steps are required.

To run all tests:

pnpm run test
# To skip TypeScript type checking:
pnpm run test --skipTs

To run only the tests of a single example/boilerplate:

# Provide example/boilerplate path
pnpm run test examples/some-example/
# Or provide a substring of the path
pnpm run test ome-exampl