Skip to content

dev.md

Latest commit

 

History

History
71 lines (47 loc) · 1.42 KB

dev.md

File metadata and controls

71 lines (47 loc) · 1.42 KB
Raw

back

👩‍💻 Develop & contribute

Setup

  1. Checkout the project:
git clone git@github.com:puzzle/puzzle-shell.git
cd puzzle-shell

  1. Use mise or nvm (with nvm use) to install/activate the project's Node.js version.

  2. Install Corepack and activate PNPM:

npm install --global corepack@latest
corepack enable pnpm
  1. Install the dependencies:
pnpm install

Tryout Components with Storybook

To run a local instance of Storybook, run:

pnpm storybook

To build a production version of Storybook, run:

pnpm build-storybook

Linting etc.

To scan the project for linting or type errors, run:

pnpm lint

To automatically fix many linting errors & reformat code using Prettier, run:

pnpm lint:fix

To automatically generate the custom-elements.json manifest using the web-component-analyzer, run:

pnpm manifest

Publishing

To publish a new package version, do the following:

  • Build the library with pnpm build
  • Execute pnpm manifest to make sure the custom-elements.json manifest is up-to-date
  • Update the CHANGELOG.md
  • Bump the version with pnpm version (updates package.json and creates Git tag)
  • Execute pnpm publish to upload the new package version