1.0.0 • Published 5 years ago
@ironhorse/module-template v1.0.0
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
- Clone this repo
- Copy into your own new repo "@me/newModule"
- Update:
- package.json (module name, author, repository, description)
- rollup.config.js (module name)
- Install yarn
- Run yarn
- yarn flow-typed install
- Run yarn flow init
- Run yarn test
- Run yarn build
- 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
1.0.0
5 years ago