Installation
# Install the package globally.
npm i -g @elieandraos/create-nodejs-package
create-nodejs-package
# or (requires NPM6+)
npm init @elieandraos/nodejs-package
The scaffolded package
Includes:
-
📦 esbuild, an extremely fast JavaScript bundler -
🧪 jest, a delightful JavaScript testing framework -
🚨 eslint, a tool for identifying and reporting on patterns in JavaScript -
💄 prettier, a tool for code formatting -
🔀 dotenv, loads environment variables from a .env file into process.env -
🚀 automated semantic version releasing
Scripts:
-
npm run build
bundles your code with esbuild -
npm run test
runs the test suites with jest -
npm run format
formats the code with prettier -
npm run lint
check for linting error & apply fixes with es-lint -
npm run release
creates a gitHub tag and release, publishes to npm registry -
npm run info
lists the dependencies installed and the ones that are outdated
Customization
The package uses the default eslint:recommended
set of rules and few prettier rules.
You can customize both of them to your personal flavor.
- es-lint configuration and rules docs
- prettier configuration and options docs
Release automation
The automated release is shipped from the package @elieandraos/cli-tools
npm run release