mrm preset to set up nvm, eslint, prettier, lint-staged, husky, and typescript.
Also includes a separate task for publishing npm libraries.
Setup all the things!
npx mrm all --preset @20i/mrm-preset
# or for yarn berry
yarn dlx mrm all --preset @20i/mrm-presetEach of these can be set up individually. To see all available tasks, run
npx mrm --preset @20i/mrm-preset
npx mrm nvm --preset @20i/mrm-presetEvery project should have a .nvmrc file. Currently this defaults to 16, but you can change it to whatever you need.
nvm can be installed by following their installation instructions
npx mrm eslint --preset @20i/mrm-presetThe @20i/eslint-config will be installed with prettier and typescript support by default. See the package for more details.
If React or React Native are found as dependencies, additional eslint packages will be installed. This command can be run again after adding react if needed.
npx mrm lint-staged --preset @20i/mrm-presetThis also sets up husky to run as a pre-commit hook. The default command is to use a precommit npm script, but that can be adjusted in .husky/pre-commit and in your package.json.
npx mrm gitignore --preset @20i/mrm-presetConfigured with default values for a node project and yarn berry.
Any default preset can be run with
npx mrm <PRESET>
Currently, this just runs the mrm preset for typescript. PRs are welcome to update this :D
Will only run if a readme is not already present.
Will only run if a license is not already present.
This is a nifty config to help your editor have better default values. For more options, check out editorconfig docs.
npx mrm ci-publish --preset @20i/mrm-presetci-publish will add a .github/workflows/ci-publish.yml file to your project for auto publishing to npm on releases. It also adds a release.yml template to help with Github's auto release notes.
This package is published to npm using the Publish CI workflow.
The workflow is configured to publish the package to npm after a successful release and package.json version bump.
To use,
- Add a publish
NPM_TOKENto your github repo secrets - Bump the package.json version
- Make a release
For effective changelogs, be sure to add the labels found in release.yml to PRs.