A delightful, modular code generator
- Node Version Manager (nvm) - allows using different versions of node via the command line
nvm use # use the required version of node
npm ci # install dependencies
npm run build # builds all workspaces
Note: Do not run
npm install
ornpm ci
in any of the subdirectories. It will break the build. There should be only onepackage-lock.json
file in the entire repo (at the root).
npm ci # install dependencies
npm run build # builds all workspaces
npm run ci-validate # builds, lints, formats, and tests all code (runs in CI pipeline, don't run locally)
npm run clean # deletes all build artifacts
npm run commit # displays commit helper prompt to ensure your commits use conventional commits
npm run dev # run all workspaces in dev mode
npm run fix # lints, formats and attempts to fix any issues (requires `npm run build` has been ran)
npm run format # formats all workspaces, useful for debugging format issues (generally `npm run fix` is preferred)
npm run lint # runs the linter on all workspaces, useful for debugging lint issues (generally `npm run fix` is preferred)
npm run test # runs full build, lint, format, and all tests - run before pushing to remote
npm run build # run a full build
npm test # test
# Change working directory to the package that needs to be published, e.g.
cd plugins/react
npm publish # you will be prompted for an OTP from Google Authenticator
- configs
- packages/shaper-utils
- apps/code-shaper
- generators
- plugins
Removes all build artifacts and performs a clean build.
npm run clean
npm ci
npm run dev
For an "aggressive" clean build, add one more step as shown below. This will build the lock file from scratch.
npm run clean
rm package-lock.json
npm install
npm run dev
The following command runs a full build, lint, format, and all tests. However, it uses the Turborepo cache to skip steps that have no changes since the last run. Hence it is very efficient. Always run this command before pushing to remote.
npm test
npm run fix