JSPM

generator-new-node-module

1.0.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q20329F
  • License MIT

Node module scaffolding template [ES6+, Babel, Tape, Istanbul, Coveralls, Travis, Husky, Airbnb codestyle]

Package Exports

  • generator-new-node-module

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generator-new-node-module) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

< Yeoman generator create scaffolding node modules />

#Install

Install generator-nodeModule from npm, run:

$ npm install -g yo
$ npm install -g generator-new-node-module

Finally initiate the generator:

$ yo new-node-module

#Features

#Usage

You need Yeoman to run this command.

yo new-node-module
→ create package.json
→ create README.md
→ create LICENSE
→ create CHANGELOG.md
→ create src/index.js
→ create test/index.js
→ create .editorconfig
→ create .gitignore
→ create .travis.yml
→ create .eslintrc

#Workflow

  • Add code to src/index.js and tests to test/index.js.

  • Lint, build and test a project with npm run build.

  • Build and watch changes in src/ with npm run watch

  • Run only tests with npm run test.

  • Check coverage with npm run coverage.

  • Generate a TOC for the CHANGELOG with npm run toc

  • Deploy to a remote origin with npm run deploy.

  • Bump version and publish a package with npm run major or minor/patch

#License

MIT ©