robinjac/rollup-starter-kit

Starter kit for developing js libraries using rollup.

Useful resources

Useful rollup plugins can be found here.

Getting started

Clone this repository and install its dependencies:

git clone https://github.com/robinjac/rollup-starter-lib
cd rollup-starter-lib
npm install

npm run build builds the library to dist, generating three files:

• dist/hello.cjs.js A CommonJS bundle, suitable for use in Node.js, that requires the external dependency. This corresponds to the "main" field in package.json
• dist/hello.esm.js an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the "module" field in package.json
• dist/hello.umd.js a UMD build, suitable for use in any environment (including the browser, as a <script> tag), that includes the external dependency. This corresponds to the "browser" field in package.json

npm run dev builds the library, then keeps rebuilding it whenever the source files change using rollup-watch.

npm test builds the library, then tests it.

npm run release runs standard-version to generate a changelog based on the commit history.

npm run lint lint project with typescript enabled eslint.

Commit format

• conventional commit
• commitlint is run before each commit using husky to enforce the correct commit format.
• @commitlint/config-conventional as a ruleset for commitlint. See commitlint.config.js for modifications to the standard ruleset.

License

MIT.