1.0.3 • Published 8 years ago

generator-express-middleware v1.0.3

Weekly downloads
9
License
MIT
Repository
github
Last release
8 years ago

Build Status Dependencies Status Codacy Badge Node

NPM

express-middleware-generator

Yeoman generator for ExpressJS middleware in ES6 (Requires at least Node 5)

Requirements

  • Node 5 or above
  • Gulp npm install -g gulp-cli

Installation

Pull the generator from NPM

npm install -g generator-express-middleware

Create your very first project!

yo express-middleware

Features

  • ES6 implementation to make it faster, reducing the number of dependencies to 0.
  • Gulp, mocha and chai testing scaffolding
  • gulp-bump to help you to manage your versions
  • Editor config file to enforce your coding style (supported by Webstorm out of the box or sublime/atom and others with plugins)
  • Custom JSHint config file to customize your own rules
  • Express App included to test some specific scenarios
  • Watch task to execute test cases as you modify your middleware or test cases code, boost your productivity
  • You can write a wrapper around this generator (for instance a web app) to automate the generator

Usage

Testing

There are three ways to run test cases:

npm test

or

gulp test

or let them run automatically every time you make a change by keep this command running in the background (my personal favorite)

gulp watch

Automated generator

You can just create a folder, dump a file with the name project.json with the settings that you want and invoke the generator with the flag --usefile.

Example

> ls
project.json
> yo express-middleware --usefile

Gulp Tasks (Developer info)

Code hint

gulp jshint

Bumping version

Automatically updates package.json, creates a git tag and pushes. **

Patch (bumps 0.0.1 to 0.0.2)

gulp bump

Minor (bumps 0.0.1 to 0.1.0)

gulp bump --minor

Major (bumps 0.0.1 to 1.0.0)

gulp bump --major

Custom version (bumps to 3.0.0)

gulp bump --version:3.0.0