urbanjs-tools

Quick start

Initialize the necessary tasks and presets in your gulpfile.js:

const tools = require('urbanjs-tools');
tools.initialize(gulp, {
  babel: true,
  checkDependencies: true,
  checkFileNames: true,
  conventionalChangelog: true,
  eslint: true,
  jsdoc: true,
  mocha: true,
  nsp: true,
  retire: true,
  tslint: true,
  webpack: true
});

And that's it, you're good to go.

You can run any of the gulp tasks above (e.g. gulp eslint) or you can use these presets:

• gulp test: runs tests (mocha)
• gulp analyse: analyzes the code base (check-dependencies, check-file-names, eslint, nsp, retire, tslint)
• gulp pre-commit: analyzes the code base and runs tests (analyse, test)
• gulp doc: generates the documentation (jsdoc)
• gulp dist: runs the configured transpiler/bundler (babel, webpack)
• gulp changelog: generates the documentation (conventional-changelog)
• gulp pre-release: analyzes the code base, runs tests, generates documentation, and transpiles/bundles (pre-commit, doc, dist, changelog)

Additionally you can use these modifiers:

• :fix (eslint, tslint)
• :watch (babel, webpack, mocha)

e.g. gulp eslint:fix or gulp babel:watch

Documentation

Check out

• the wiki for guides, examples and details
• api documentation
• README.md files of packages

Contribution

Highly appreciated any ideas how to make it more powerful.