Unlock the Power of Mako and Pixi in Your TypeScript Projects
Ensure Node.js v16 or higher is installed. If not, download the latest LTS version from the Node.js website.
To manage dependencies efficiently, globally install pnpm by running the following command in your terminal:
npm install -g pnpm
pnpm install
Follow these steps to create a build and publish it to NPM:
Run:
pnpm run update
This updates the project package.json version number using semantic versioning and generates a file documenting changes.
Create a pull request against the main branch.
Once the PR is approved, GitHub Actions will create a new release PR. Once the release PR is approved, GitHub Actions will automatically deploy to NPM.
-
pnpm build
: Generates a production build in the dist directory. -
pnpm run update
: Updates the project using semver and generates a change documentation file. Do this before pushing changes to git. It automatically updates the version number. -
pnpm docs
: Generates documentation in dist/docs. -
pnpm lint
: Runs ESLint over the codebase. -
pnpm ci
: Publishes the package to NPM. This task is called by GitHub Actions and should not be invoked directly.