module-template

Quick template to jumpstart your next npm module or js project. Slightly opinionated with typecheckig using Flow, AirBnb linting styles, and building with Rollup. The following sections will follow-up on some of these opinons, followed by a references section to allow you to read up on the different projects directly.

Usage

1. Clone this repo
2. Copy into your own new repo "@me/newModule"
3. Update:
   1. package.json (module name, author, repository, description)
   2. rollup.config.js (module name)
4. Install yarn
5. Run yarn
6. yarn flow-typed install
7. Run yarn flow init
8. Run yarn test
9. Run yarn build
   1. Should have a lib/index.esm.js file

Test with Jest

This template suggests using jest and jest theories for testing.

What are theories?

This is a way to run a single test with multiple inputs. Shortcut looping.

Build with Rollup

future section

Code with Flow

future section

Eslint / Prettier

future section

References

• flow
• flow-typed
• jest
• jest-theories
• rollup
• eslint
• prettier
• travisCI
• Inspiration article