es6-lib-starter-light
v1.0.3
Published
A light starter for a Node ES6 library.
Downloads
2
Maintainers
Readme
ES6 library starter
A light starter for a Node ES6 library.
Quick usage
- Clone this repo.
- Change all relevant entries in
package.json
andREADME.md
, so they match your new shiny library. - Run
npm install
to install dev dependencies. - Write your ES6 code in
src
folder. - Write your ES6 tests in
test
folder. - Run
npm run build
to build for Node. This will compile to ES5 and output the result tolib
folder. - Run
npm publish
to pulish to the world.
Detailed overview
Installation
After cloning this repository, make sure to change all the relevant entries in package.json
so they match your library.
npm install
Build for npm
npm run build
This will:
- Convert all files in
src
folder from ES6 to ES5 - Output the result to the
lib
folder
Test
npm run test
Configuration
In package.json
, change all the relevant entries so they match your details.
Under main
, you can configure library entry point (defaults to ./lib/library.js
)
License
MIT