npm-library-starter

Starter kit for npm libraries.

Usage no npm install needed!

<script type="module">
  import npmLibraryStarter from 'https://cdn.skypack.dev/npm-library-starter';
</script>

README

[WIP] ⚗

TODO:

◾ Eslint configuration
◾ Babel configuration
◾ Jest setup
◾ Test script
◾ Coverage script
◾ Coverage integration with codecov.io
◾ UMD build
◾ UMD-min build
◾ CommonJS build
◾ Full build script
◾ Integrate commitizen
◾ Integrate semantic-release
◾ Test a travis integration
◽ Example library README.md along with badges
◽ Example website template
◽ React component library branch
◽ Walkthrough/Tutorial

npm-library-starter

Travis npm MIT License Codecov

A starter kit for creating npm libraries.

TOCS

Tutorial/Walkthrough

Topics

  • commands
  • build types
  • Gitflow
  • commitizen
  • semantic-release
  • travis
  • codecov.io

FAQs

How do I run and upload a codecov report locally?

Get the upload token from codecov.io and then set the environment var before executing the respective npm task.

e.g.

CODECOV_TOKEN=0f24e004-ba1d-4cac-9a4e-23310ef221c2 npm run coverage:report