gulp-help

WebJar for gulp-help

License	MIT
GroupId	org.webjars.npm
ArtifactId	gulp-help
Last Version	1.6.1
Release Date	Feb 21, 2018
Type	jar
Description	gulp-help WebJar for gulp-help
Project URL	http://webjars.org
Source Code Management	https://github.com/chmontgomery/gulp-help

Download gulp-help

Filename	Size
gulp-help-1.6.1.pom
gulp-help-1.6.1.jar	8 KB
gulp-help-1.6.1-sources.jar	22 bytes
gulp-help-1.6.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/gulp-help/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>gulp-help</artifactId>
    <version>1.6.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/gulp-help/
implementation 'org.webjars.npm:gulp-help:1.6.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/gulp-help/
implementation ("org.webjars.npm:gulp-help:1.6.1")

Apache Buildr

'org.webjars.npm:gulp-help:jar:1.6.1'

Apache Ivy

<dependency org="org.webjars.npm" name="gulp-help" rev="1.6.1">
  <artifact name="gulp-help" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='gulp-help', version='1.6.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "gulp-help" % "1.6.1"

Leiningen

[org.webjars.npm/gulp-help "1.6.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : chalk	jar	[1.0.0,2)
org.webjars.npm : object-assign	jar	[3.0.0,4)

Project Modules

There are no modules declared in this project.

gulp-help

Adds a default help task to gulp and provides the ability to add custom help messages to your gulp tasks

NOTE: this version only works with gulp 3. For gulp-help that works with gulp 4, see the gulp4 git branch

Install

$ npm install --save-dev gulp-help

Usage

Before defining any tasks, add gulp help to your gulp instance

// gulpfile.js
var gulp = require('gulp-help')(require('gulp'));

Next, define help text for each custom task

// gulpfile.js
gulp.task('lint', 'Lints all server side js', function () {
    gulp.src('./lib/**/*.js')
      .pipe(jshint());
});

Now show that help via gulp help

New task API

gulp.task(name[, help, deps, fn, taskOptions])

name

Type: string

help

Type: string | boolean

Custom help message as a string.

If you want to hide the task from the help menu, supply false

gulp.task('task-hidden-from-help', false, function () {
  // ...
});

However, if the --all flag is provided, even these tasks will be shown. (i.e. gulp help --all)

deps

Type: Array

fn

Type: function

taskOptions.aliases

Type: Array

List of aliases for this task

gulp.task('version', 'prints the version.', [], function() {
  // ...
}, {
  aliases: ['v', 'V']
});

which results in

taskOptions.options

Type: Object

Object documenting options which can be passed to your task

gulp.task('version', 'prints the version.', [], function () {
  // ...
}, {
  options: {
    'env=prod': 'description of env, perhaps with available values',
    'key=val': 'description of key & val',
    'key': 'description of key'
  }
});

which results in

require('gulp-help')(require('gulp'), options);

These are all the options available to be passed to the gulp-help instance, NOT individual tasks.

• description - modifies the default help message
• aliases - adds aliases to the default help task
• hideEmpty - hide all tasks with no help message defined. Useful when including 3rd party tasks
• hideDepsMessage - hide all task dependencies
• afterPrintCallback - a function to run after the default help task runs

License

MIT © Chris Montgomery

Versions

Version
1.6.1 Feb 21, 2018