You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,26 @@ Command Line Utility for Gulp
16
16
> gulp [flags] tasks
17
17
```
18
18
19
+
## Custom Metadata
20
+
21
+
When listing tasks with the `gulp -T` command, gulp-cli displays some custom metadata as defined upon task functions. Currently supported properties:
22
+
23
+
*`task.description` - String of the description to display.
24
+
25
+
```js
26
+
functionclean() { ... }
27
+
clean.description='Cleans up generated files.';
28
+
```
29
+
30
+
*`task.flags` - Object with key/value pairs being flag/description to display.
31
+
32
+
```js
33
+
functionbuild() { ... }
34
+
build.flags= {
35
+
'--prod':'Builds in production mode.'
36
+
};
37
+
```
38
+
19
39
## Tasks
20
40
21
41
Tasks can be executed by running `gulp <task> <othertask>`. Just running `gulp` will execute the task you registered called `default`. If there is no `default` task, gulp will error.
0 commit comments