Marola - component library

Commands

yarn dev - run the playground, launches a server where a developer can test and develop components, watches for file changes

yarn build - builds the components ready for publish

yarn test - calls off to yarn test:unit

yarn test:unit - runs vitest for unit tests

yarn test:unit:visual - runs vitest for unit tests in a browser, then when tests are run it will show the output in browser

yarn test:unit:watch - runs vitest and watches for any change and reruns

yarn lint - performs an eslint across the project code and reports any problems in the terminal

yarn preview - runs build and serves the files in the dist serves what would be in a publish

yarn publish - runs a prePublish build (the build command) then publishes the contents of the dist directory

yarn storybook - start storybook

yarn build-storybook - build storybook static files

Tips

Node version

This project uses a .nvmrc file, to auto switch node version follow these steps from the nvm project .

Publishing

This project is distributed to the Pismo's microfrontends via npm. To publish a new version of this library follow the following steps: 1 - Create a new branch from main and work on whatever updates, fixes or new features are needed. 2 - Before updating the version, pull from main to guarantee you are on the last published version. 3 - In the package.json file, update the version following the version semantics convention 4 - Open a Pull Request with your changes and send it to review on the design system guild channel 5 - When the PR is approved and the pipelines have passed, merge the branch 6 - Checkout main and pull from origin 7 - Run yarn publish (you will be requested for your NPM OTP, which should be available on your Google Authenticator App)