Contributing

The pre-push git hook.

#!/usr/bin/env bash

set -xeuo pipefail

npm t
npx standard
npx prettier -c --parser markdown *.mz

For the README.mz examples to work we need sendscript to be linked.

set -e

npm ci
npm link
npm link sendscript
cd ./example

Check if packages are up to date on release.

npm outdated && echo 'No outdated packages found'

Check if no vulnerable dependencies

npm audit

Check if code follows standard formatting.

npx standard

Check if markdown is correctly formatted.

npx prettier --check --parser markdown ./README.mz ./CONTRIBUTING.md

Generate the README from the mz file.

markatzea ./README.mz | tee ./README.md

npx markdown-toc --maxdepth 3 -i README.md

git add *.md ./example

FilesExpand file tree