npm-minimal-boilerplate

Minimal boilerplate for creating NPM packages

Boilerplate to get started with NPM package instantly.

Features

• ES6, ES7, ES8 support
• Class properties support
• Decorators support
• ESLint with AirBnB Base style guide & Prettier
• Transpilation to ES5

Usage

1. Clone the repo: git clone https://github.com/ganapativs/npm-minimal-boilerplate.git my-awesome-npm-package && cd $_
2. Remove .git: rm -rf .git
3. Install dependencies: yarn
4. Lint: yarn run lint
5. Fix lint issues and prettify code 😎: yarn run lint-fix
6. Transpilation to ES5 in dist folder: yarn run prepublish (standard npm hook)
7. Push package to your own Github repository
8. Publish package: yarn run publish

Todo

• Test cases

License

MIT