@boilertowns/node-package-boilerplate v0.0.0
The Setup
- TypeScript
- Linting with Eslint and code formatting with Prettier
- Conventional commit messages with Commitlint
- Build with Rollup
- Vitest for Unit test
- Automated release with changesets
- Build library for Node.js 14 or newer.
- Support both CJS & ESM.
Get Started
Use Boilertowns CLI.
# npm npm create boilertowns@latest -- -b node-package-boilerplate # yarn yarn create boilertowns -b node-package-boilerplate # pnpm pnpm create boilertowns -b node-package-boilerplate # bun bun create boilertowns/node-package-boilerplate [package-name]
Click the green "Use this template" button to generate a new repository with the same structure and files.
Development
Run the package in development mode:
pnpm dev
Build for production:
pnpm build
Create changeset:
pnpm changeset
Release & Publish
This boilerplate uses changesets to automatically generate CHANGELOG
, create releases and publish to NPM registry via GitHub Actions. You can see action details at release.yml.
To automating publish your Node.js package, follow these steps:
Create a
NPM_TOKEN
. See this article for more details. Make sure the type of access token is Automation.Follow this instruction to add the created token to your GitHub Actions secrets. Name of the secret is
NPM_TOKEN
.Install changeset bot.
P/S: Remember to check the Allow GitHub Actions to create and approve pull requests
in your repo Settings > Actions > General & scroll to Workflow permissions.
Contributing
node-package-boilerplate ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.
2 years ago