@lukeboyle/esnext-library-generator

esnext-library-generator

This generator contains dead simple boilerplates for creating modules, commonly to be published on npm.

Boilerplates

• vanilla - ES2015+ library boilerplate: https://github.com/3stacks/es6-module-boilerplate
• react - React library/component boilerplate: https://github.com/3stacks/react-component-boilerplate

Usage

• run npm install @lukeboyle/esnext-library-generator -g
• Clone a repository or create a new folder e.g. my-new-project
• cd my-new-project
• esnext-library [--type=react] [] denotes optional

Currently supported types are vanilla and react.

Passing no --type option will copy vanilla boilerplate

Installation

• npm install yo generator-esnext-modules -g
• Create a directory where you want to build your component (an initialised git repo folder for example)
• cd into that directory

For Vanilla JS ES6 Modules

• esnext-library [--type=vanilla] [] denotes optional
• npm install
• Use the readme in that folder to get you started

For React JSX Modules

• esnext-library --type=react
• npm install
• Use the readme in that folder to get you started

Submitting issues

If you have are having a problem with the generator, before you submit an issue to this repository...

The template files are part of git submodules.

For issues relating to the Vanilla JS template, visit: https://github.com/3stacks/es6-module-boilerplate For issues relating to the React template, visit: https://github.com/3stacks/react-component-boilerplate

Otherwise, if your issue is with the generator, visit https://github.com/3stacks/esnext-module-generator

Changelog

1.0.0

Initial Version