Development

Clone or fork the repository.

git clone git@github.com:milesstoetzner/stoetzms-work.git

Make sure that your IDE is using Prettier and ESLint and their corresponding configurations.

Code

We use the Node.js version in .nvmrc, currently the LTS Node.js 24.

nvm use

For installing dependencies ...

yarn

For running the current code ...

yarn work

For linting ...

yarn lint:check

For fixing lint errors ...

yarn lint:fix

For checking types ...

yarn types:check

For running the tests ...

yarn test

The tests in tests/cli run the actual CLI as a separate process, each in its own temporary directory. For running only them, optionally against the built bundle instead of the sources ...

yarn test:cli
STOETZMS_WORK_CLI=dist/stoetzms-work.js yarn test:cli

For checking the code style ...

yarn style:check

For fixing code style errors ...

yarn style:fix

Distribution

For transpiling the project ...

yarn dist:build

For bundling the transpiled code as binaries ...

yarn dist:package

For compressing the binaries ...

yarn dist:compress

Licenses

For checking the licenses of dependencies ...

yarn license:check

For generating a report containing the licenses of dependencies ...

yarn license:generate

Documentation

We use Vitepress for our documentation. For locally starting the documentation ...

yarn docs:dev

For building the documentation ...

yarn docs:build

For previewing the build documentation ...

yarn docs:preview