From 008474f24aaed82e57e204e41d22eac37269328b Mon Sep 17 00:00:00 2001 From: Blaine Bublitz Date: Thu, 21 Dec 2017 13:50:38 -0700 Subject: [PATCH] Docs: Update for flags & aliases --- README.md | 13 +++---------- docs/CLI.md | 11 +++++------ 2 files changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index cd95f173..0cda70b4 100644 --- a/README.md +++ b/README.md @@ -57,11 +57,7 @@ If more than one task is listed, Gulp will execute all of them concurrently, that is, as if they had all been listed as dependencies of a single task. -Gulp does not serialize tasks listed on the command line. From using -other comparable tools users may expect to execute something like -`gulp clean build`, with tasks named `clean` and `build`. This will not -produce the intended result, as the two tasks will be executed -concurrently. +By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the `--series` flag. e.g. `gulp clean build --series` Just running `gulp` will execute the task `default`. If there is no `default` task, gulp will error. @@ -225,11 +221,8 @@ __Some flags only work with gulp 4 and will be ignored when invoked against gulp MIT -[gittip-url]: https://www.gittip.com/WeAreFractal/ -[gittip-image]: http://img.shields.io/gittip/WeAreFractal.svg - [downloads-image]: http://img.shields.io/npm/dm/gulp-cli.svg -[npm-url]: https://npmjs.org/package/gulp-cli +[npm-url]: https://www.npmjs.com/package/gulp-cli [npm-image]: http://img.shields.io/npm/v/gulp-cli.svg [travis-url]: https://travis-ci.org/gulpjs/gulp-cli @@ -242,4 +235,4 @@ MIT [coveralls-image]: http://img.shields.io/coveralls/gulpjs/gulp-cli/master.svg [gitter-url]: https://gitter.im/gulpjs/gulp -[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png +[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg diff --git a/docs/CLI.md b/docs/CLI.md index 423452bf..2d3db6f1 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -9,11 +9,7 @@ If more than one task is listed, Gulp will execute all of them concurrently, that is, as if they had all been listed as dependencies of a single task. -Gulp does not serialize tasks listed on the command line. From using -other comparable tools users may expect to execute something like -`gulp clean build`, with tasks named `clean` and `build`. This will not -produce the intended result, as the two tasks will be executed -concurrently. +By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the `--series` flag. e.g. `gulp clean build --series` Just running `gulp` will execute the task `default`. If there is no `default` task, gulp will error. @@ -41,7 +37,7 @@ gulp has very few flags to know about. All other flags are for tasks to use if n **--require** [path] Will require a module before running the gulpfile. This is useful for transpilers but also has other applications. -**--gulpfile** [path] +**--gulpfile** [path], **-f** [path] Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well. **--cwd** [path] @@ -80,5 +76,8 @@ gulp has very few flags to know about. All other flags are for tasks to use if n **--continue** Continue execution of tasks upon failure. +**--series** + Run tasks given on the CLI in series (the default is parallel). + **--log-level**, **-L** Set the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default.