Skip to content
Simple generator for plain node modules with test, release and documentation workflows
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
generators/app
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package-lock.json
package.json
update-deps-and-tag.sh

README.md

Node module generator

Build Status Dependency Status DevDependency Status Npm downloads Npm Version Git tag Github issues License

A generator for plain node modules with test, ci, release and documentation workflows

Includes

The generated project comes with:

  • Changelog Configuration
  • Istanbul Code Coverage Configuration
  • JsDoc Gen Configuration
  • JsDoc Push Configuration
  • Mocha Test Configuration
  • Travis CI Configuration

Generates

The generated project has the following the structure:

| lib
|  | index.js 
| test
|  | index.spec.js
| .gitignore
| .jsdoc.json
| .travis.yml
| LICENSE
| README.md
| package.json

Scripts

The generated project is preconfigured with the following scripts:

  • changelog to generate the changelog for the current version
  • coverage to generate the code coverage for a test run
  • docs to generate jsdoc application code
  • push-docs to push generated js doc to gh-pages branch
  • release-patch to release a new patch version to github
    • calls version, test and changelog
  • release-minor to release a new minor version to github
    • calls version, test and changelog
  • release-major to release a new major version to github
    • calls version, test and changelog
  • setup to onetime setup the github repository with an initial tag
  • test to run tests a single time
  • test-watch to watch for file changes and run tests

Installation

npm install generator-stfsy-node -g

Usage

cd <workspace>
mkdir <projectName>
cd <projectName>
yo stfsy-node

Run npm run setup afterwards to setup your git repository with an empty tag. This is needed for the generation of your first changelog.

License

This project is distributed under the MIT license.

You can’t perform that action at this time.