@daybyday/lib-template

This repo contains a bare-bones example of how to create a library using Rollup, including importing a module from node_modules and converting it from CommonJS.

Usage no npm install needed!

<script type="module">
  import daybydayLibTemplate from 'https://cdn.skypack.dev/@daybyday/lib-template';
</script>

README

lib-template

This repo contains a bare-bones example of how to create a library using Rollup, including importing a module from node_modules and converting it from CommonJS.

Getting started

Clone this repository and install its dependencies:

git clone https://github.com/gyx8899/lib-template
cd lib-template
npm install

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

  • dist/index.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/index.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/index.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.