gulpではあるコマンドでどのようなタスクが定義されているかを一覧表示して確認することができますが、その際にタスク名だけでなくそのタスクの説明文も一緒に表示させる方法です。
「gulp：タスクやインストール済みプラグイン・モジュールの一覧を表示する方法」で紹介しているように、gulpは$ gulp --tasks または $ gulp -Tのコマンドを実行することでタスクの一覧表示ができ、その際は下記のような感じのツリー形式で表示され、現在どのようなタスク定義されているかやどのようなタスクが組み合わさっているかなどを確認することができるようになっています。
[00:00:00] Tasks for ~\path\gulpfile.js
[00:00:00] ├─┬ default
[00:00:00] │ ├── task1
[00:00:00] │ └── task2
[00:00:00] ├── task1
[00:00:00] ├── task2
[00:00:00] └── task3単純にタスクを書いているだけの場合は上記にあるようにタスク名だけが表示されますが、今回はここに説明文も表示させるようにする方法になります。
説明文の設定はその名の通りdescriptionを使用し、タスクを記述しているファイルに下記のような感じで記述していきます。
function defaultTasks() { }
defaultTasks.description = 'default description here.';
function task1() { }
task1.description = 'task1 description here.';
function task2() { }
task2.description = 'task2 description here.';
function task3() { }
task3.description = 'これはタスク3です';
gulp.task('default', ['task1', 'task2'], defaultTasks);
gulp.task('task1', task1);
gulp.task('task2', task2);
gulp.task('task3', task3);上記のようにdescriptionを設定していったら、再度$ gulp --tasks または $ gulp -Tのコマンドを実行すると下記のような形でタスク名の右側にそのタスクの説明文を表示させることができ、「task3」を見てわかるように日本語で設定することもできます。
[00:00:00] Tasks for ~\path\gulpfile.js
[00:00:00] ├─┬ default default description here.
[00:00:00] │ ├── task1
[00:00:00] │ └── task2
[00:00:00] ├── task1 task1 description here.
[00:00:00] ├── task2 task2 description here.
[00:00:00] └── task3 これはタスク3です普通にREADME.mdなどに書いておく方がコマンドの必要もなくすぐ確認できますし、他にもそれぞれのタスク設定前にコメント入れておいたりする方がわかりやすいという人もいるでしょうが、タスク一覧表示時にも説明文を出したいというときは上記方法で実装できます。