# gulp-task-help

> Provides a gulp task that will display a help message describing the tasks as well as their dependencies and arguments.

Latest version **0.0.4** (published 2015-12-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install gulp-task-help
pnpm add gulp-task-help
yarn add gulp-task-help
bun add gulp-task-help
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2015-12-17 |
| First published | 2015-10-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.40 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tim Oram |
| Maintainers | mitmaro |
| Keywords | gulp, task, help |

## Links

- npm: https://www.npmjs.com/package/gulp-task-help
- Repository: https://github.com/MitMaro/gulp-task-help
- Homepage: https://github.com/MitMaro/gulp-task-help#readme
- Issues: https://github.com/MitMaro/gulp-task-help/issues
- npm.io page: https://npm.io/package/gulp-task-help

## Dependencies (3)

- [pad](https://npm.io/package/pad.md) ^1.0.0
- [wordwrap](https://npm.io/package/wordwrap.md) ^1.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2015-12-17
- 0.0.3 — 2015-12-16
- 0.0.2 — 2015-10-31
- 0.0.1 — 2015-10-31

## README

# Gulp Task Help

Provides a gulp task that will display a help message describing the tasks as well as their dependencies and arguments.

## Preview

![gulp-task-help](https://cloud.githubusercontent.com/assets/177427/10861145/089127ba-7f5a-11e5-9e0d-8e60f21a40f7.png)

## Install

    npm i --save-dev gulp-task-help

## Usage
	
	var Help = require('gulp-task-help');
	
	// create the help task instance
	const help = new Help(
		'Project Title',
		'Project Description
	);
	
	// register each argument
	help.registerArgument(
		'arg-name', 'Argument description', 'default value'
	);

	help.registerTask(
		'task:name',
		'Task description',
		['task:dependency'],
		['argument-name']
	);

	// register the task
	gulp.task('help', help.helpTask);

## API Documentation

[Full API Documentation](https://doc.esdoc.org/github.com/MitMaro/gulp-task-help/)

#### `new Help(title, description)`

Argument Name | Type | Description
---|---|---
title | `string` | Generally the title of the application
description | `string` | A description of the application or the build system

#### `registerTask(taskName, description, dependencies, args)`

Argument Name | Type | Description | Default
---|---|---|---
taskName | `string` | The name of the task as registered with gulp
description | `string` | The description of the tasks
dependencies | `string[]` | A list of dependant task nams | `[]`
args | `string[]` | A list of argument names | `[]`

#### `registerArgument(argumentName, description, defaultValue)`
Argument Name | Type | Description
---|---|---
argumentName | `string` | The name of the argument
description | `string` | The description of the argument
defaultValue | `string` | A default value, or description of the default value
 
## License

Gulp Task Help is released under the ISC license. See [LICENSE](LICENSE).

---
_Source: https://npm.io/package/gulp-task-help · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._