We use several scripts to make developing Marigold easier and more convenient.
$ pnpm <script name> in your favorite terminal.
Run the test suite. If you append
-w the suite will run in watch mode, meaning test that are affacted by your changes will be automatically re-run.
Boot up the documentation website. This is helpful if you're writing or editing any documentation. Changes will be automatically detected and force a rebuild of the docs without you having to refresh the page in a browser.
test but will output a coverage report into your terminal.
prettier and format source files. We don't care how our source code is formated as long everyone uses the same format.
Run the TypeScript compiler to find any inconsistent or wrong types.
Build all the packages.
Build all the tailwind themes.
Build just storybook.
Build just the documentation.
If you want to know how to release Marigold, go to the Release page.
Run our release script to create a new release and deploy the documentation.
Use changeset, see CLI options for more information.
Sometimes node modules have hick ups. This command will remove all
node_module and build folders so that you have a clean repo like you just git cloned it.
clean except it will only remove all build folders.