Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shellscape/gulp-assist
Display helpful information for your Gulp tasks
https://github.com/shellscape/gulp-assist
assistant cli console gulp gulp-plugin gulp-tasks gulpjs help module npm taskname terminal
Last synced: 19 days ago
JSON representation
Display helpful information for your Gulp tasks
- Host: GitHub
- URL: https://github.com/shellscape/gulp-assist
- Owner: shellscape
- License: mit
- Archived: true
- Created: 2017-01-06T04:23:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-24T10:25:31.000Z (about 7 years ago)
- Last Synced: 2025-01-17T10:36:13.654Z (24 days ago)
- Topics: assistant, cli, console, gulp, gulp-plugin, gulp-tasks, gulpjs, help, module, npm, taskname, terminal
- Language: JavaScript
- Size: 116 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-assist
Display helpful information for your Gulp tasks
##
:rocket: Are you ready to tackle ES6 and hone your JavaScript Skills? :rocket:
Check out these outstanding ES6 courses by @wesbos
---
gulp-assist presents basic info registered tasks in a stylish format by extending
`gulp` with an additional method to describe tasks and their flags. gulp-assist
does not modify existing `gulp` methods or API.
And info for each individual task including flags and their descriptions.
## Install
```
$ npm install gulp-assist --save-dev
```
## Usage
```js
const gulp = require('gulp');
// initialize the module
require('gulp-assist')();
gulp.task('lint', () =>
// ...
);
gulp.assist('lint', {
desc: 'Analyzes code for errors and convention violations.',
flags: {
src: 'Specifies a directory / module to inspect, within the `src` directory.'
}
});
```
## API
### default([options])
#### options
Example Usage of all options:
```js
const gulp = require('gulp');
let taskName = 'default';
require('gulp-assist')({ gulp, taskName })
```
##### gulp
Type: `Object`
Default: `null`
The module has the ability to use a `gulp` instance already required. If this
option is not specified, the module will require `gulp` internally. In most cases
this will use the shared instance.
##### taskName
Type: `String`
Default: `'help'`
The name of the task that gulp-assist should use as the entry point.
### gulp.assist(taskName, options)
Registers a task with gulp-assist.
#### options
##### desc
Type: `String`
Default: `null`
A description of the task being registered.
##### flags
Type: `Object`
Default: `null`
An object whose keys represent a flag name. gulp-assist automagically prepends a
double hypen to each flag name when displaying task details. The value for each
key should represent the description of the flag.
## License
MIT © [Andrew Powell](http://shellscape.org)