是否可以将标志传递给Gulp以使其以不同方式运行任务?

时间:2014-04-11 22:30:12

标签: javascript node.js gulp

通常在Gulp任务中看起来像这样:

gulp.task('my-task', function() {
    return gulp.src(options.SCSS_SOURCE)
        .pipe(sass({style:'nested'}))
        .pipe(autoprefixer('last 10 version'))
        .pipe(concat('style.css'))
        .pipe(gulp.dest(options.SCSS_DEST));
});

是否可以将命令行标志传递给gulp(这不是一项任务)并让它根据该条件有条件地运行任务?例如

$ gulp my-task -a 1

然后在我的gulpfile.js中:

gulp.task('my-task', function() {
        if (a == 1) {
            var source = options.SCSS_SOURCE;
        } else {
            var source = options.OTHER_SOURCE;
        }
        return gulp.src(source)
            .pipe(sass({style:'nested'}))
            .pipe(autoprefixer('last 10 version'))
            .pipe(concat('style.css'))
            .pipe(gulp.dest(options.SCSS_DEST));
});

11 个答案:

答案 0 :(得分:520)

Gulp没有为此提供任何类型的util,但您可以使用众多命令args解析器之一。我喜欢yargs。应该是:

var argv = require('yargs').argv;

gulp.task('my-task', function() {
    return gulp.src(argv.a == 1 ? options.SCSS_SOURCE : options.OTHER_SOURCE)
        .pipe(sass({style:'nested'}))
        .pipe(autoprefixer('last 10 version'))
        .pipe(concat('style.css'))
        .pipe(gulp.dest(options.SCSS_DEST));
});

您还可以将其与gulp-if结合使用来有条件地管道流,这对于dev与prod构建非常有用:

var argv = require('yargs').argv,
    gulpif = require('gulp-if'),
    rename = require('gulp-rename'),
    uglify = require('gulp-uglify');

gulp.task('my-js-task', function() {
  gulp.src('src/**/*.js')
    .pipe(concat('out.js'))
    .pipe(gulpif(argv.production, uglify()))
    .pipe(gulpif(argv.production, rename({suffix: '.min'})))
    .pipe(gulp.dest('dist/'));
});

使用gulp my-js-taskgulp my-js-task --production拨打电话。

答案 1 :(得分:101)

修改

gulp-utildeprecated,应该避免使用,因此建议使用minimist代替gulp-util已使用过。{/ p>

所以我更改了gulpfile中的一些行以删除gulp-util

var argv = require('minimist')(process.argv.slice(2));

gulp.task('styles', function() {
  return gulp.src(['src/styles/' + (argv.theme || 'main') + '.scss'])
    …
});

<强>原始

在我的项目中,我使用以下标志:

gulp styles --theme literature

Gulp为此提供了一个对象gulp.env。它在较新版本中已弃用,因此您必须使用gulp-util。任务看起来像这样:

var util = require('gulp-util');

gulp.task('styles', function() {
  return gulp.src(['src/styles/' + (util.env.theme ? util.env.theme : 'main') + '.scss'])
    .pipe(compass({
        config_file: './config.rb',
        sass   : 'src/styles',
        css    : 'dist/styles',
        style  : 'expanded'

    }))
    .pipe(autoprefixer('last 2 version', 'safari 5', 'ie 8', 'ie 9', 'ff 17', 'opera 12.1', 'ios 6', 'android 4'))
    .pipe(livereload(server))
    .pipe(gulp.dest('dist/styles'))
    .pipe(notify({ message: 'Styles task complete' }));
});

在所有子任务期间都可以使用环境设置。所以我也可以在监视任务上使用这个标志:

gulp watch --theme literature

我的风格任务也有效。

侨 拉尔夫

答案 2 :(得分:57)

这是我发现的快速配方:

gulpfile.js

var gulp   = require('gulp');

// npm install gulp yargs gulp-if gulp-uglify
var args   = require('yargs').argv;
var gulpif = require('gulp-if');
var uglify = require('gulp-uglify');

var isProduction = args.env === 'production';

gulp.task('scripts', function() {
  return gulp.src('**/*.js')
    .pipe(gulpif(isProduction, uglify())) // only minify if production
    .pipe(gulp.dest('dist'));
});

CLI

gulp scripts --env production

Original Ref(不再提供):https://github.com/gulpjs/gulp/blob/master/docs/recipes/pass-params-from-cli.md

替代最小化

来自更新后的参考:https://github.com/gulpjs/gulp/blob/master/docs/recipes/pass-arguments-from-cli.md

gulpfile.js

// npm install --save-dev gulp gulp-if gulp-uglify minimist

var gulp = require('gulp');
var gulpif = require('gulp-if');
var uglify = require('gulp-uglify');

var minimist = require('minimist');

var knownOptions = {
  string: 'env',
  default: { env: process.env.NODE_ENV || 'production' }
};

var options = minimist(process.argv.slice(2), knownOptions);

gulp.task('scripts', function() {
  return gulp.src('**/*.js')
    .pipe(gulpif(options.env === 'production', uglify())) // only minify if production
    .pipe(gulp.dest('dist'));
});

CLI

gulp scripts --env production

答案 3 :(得分:39)

有一种非常简单的方法可以在不解析参数的情况下执行on/off标志。 gulpfile.js只是一个像其他文件一样执行的文件,所以你可以这样做:

var flags = {
  production: false
};

gulp.task('production', function () {
  flags.production = true;
});

使用类似gulp-if的内容来有条件地执行步骤

gulp.task('build', function () {
  gulp.src('*.html')
    .pipe(gulp_if(flags.production, minify_html()))
    .pipe(gulp.dest('build/'));
});

执行gulp build会生成一个不错的html,而gulp production build会缩小它。

答案 4 :(得分:32)

如果你有一些严格的(有序的!)参数,那么只需勾选process.argv即可获得它们。

var args = process.argv.slice(2);

if (args[0] === "--env" && args[1] === "production");

执行:gulp --env production

...但是,我认为这是 tooo 严格而不是防弹!所以,我摆弄了一下......最后得到了这个效用函数:

function getArg(key) {
  var index = process.argv.indexOf(key);
  var next = process.argv[index + 1];
  return (index < 0) ? null : (!next || next[0] === "-") ? true : next;
}

它吃了一个参数名称,并将在process.argv中搜索它。如果没有找到任何内容,则会吐出null。否则,如果它们没有下一个参数,或者下一个参数是一个命令而不是一个值(我们用短划线表示不同),则会返回true。 (那是因为密钥存在,但是没有价值)。如果之前的所有情况都会失败,那么下一个参数值就是我们得到的。

<强> > gulp watch --foo --bar 1337 -boom "Foo isn't equal to bar."

getArg("--foo") // => true
getArg("--bar") // => "1337"
getArg("-boom") // => "Foo isn't equal to bar."
getArg("--404") // => null

好的,现在已经足够......这是一个使用 gulp 的简单示例:

var gulp = require("gulp");
var sass = require("gulp-sass");
var rename = require("gulp-rename");

var env = getArg("--env");

gulp.task("styles", function () {
  return gulp.src("./index.scss")
  .pipe(sass({
    style: env === "production" ? "compressed" : "nested"
  }))
  .pipe(rename({
    extname: env === "production" ? ".min.css" : ".css"
  }))
  .pipe(gulp.dest("./build"));
});

运行gulp --env production

答案 5 :(得分:7)

我构建了一个插件,用于将命令行中的参数注入任务回调。

gulp.task('mytask', function (production) {
  console.log(production); // => true
});

// gulp mytask --production

https://github.com/stoeffel/gulp-param

如果有人发现错误或对其有所改进,我很乐意合并PR。

答案 6 :(得分:4)

如果您正在使用打字稿(gulpfile.ts),请为yargs执行此操作(基于@Caio Cunha的优秀答案https://stackoverflow.com/a/23038290/1019307以及上述其他评论):

安装

npm install --save-dev yargs

typings install dt~yargs --global --save

.ts个文件

将此添加到.ts文件:

import { argv } from 'yargs';

...

  let debug: boolean = argv.debug;

必须在每个.ts文件中单独完成(甚至导入tools/tasks/project的{​​{1}}个文件。)

运行

gulpfile.ts/js

或在gulp build.dev --debug 下将arg传递给gulp:

npm

答案 7 :(得分:2)

从命令行传递参数

// npm install --save-dev gulp gulp-if gulp-uglify minimist

var gulp = require('gulp');
var gulpif = require('gulp-if');
var uglify = require('gulp-uglify');

var minimist = require('minimist');

var knownOptions = {
  string: 'env',
  default: { env: process.env.NODE_ENV || 'production' }
};

var options = minimist(process.argv.slice(2), knownOptions);

gulp.task('scripts', function() {
  return gulp.src('**/*.js')
    .pipe(gulpif(options.env === 'production', uglify())) // only minify in production
    .pipe(gulp.dest('dist'));
});

然后用:

运行gulp
$ gulp scripts --env development

Source

答案 8 :(得分:2)

var isProduction = (process.argv.indexOf("production")>-1);

CLI gulp production调用我的生产任务并为任何条件设置标志。

答案 9 :(得分:1)

我们希望为不同的环境传递不同的配置文件 - 一个用于生产开发测试。这是gulp文件中的代码:

//passing in flag to gulp to set environment
//var env = gutil.env.env;

if (typeof gutil.env.env === 'string') {
  process.env.NODE_ENV = gutil.env.env;
}

这是app.js文件中的代码:

  if(env === 'testing'){
      var Config = require('./config.testing.js');
      var Api = require('./api/testing.js')(Config.web);
    }
    else if(env === 'dev'){
       Config = require('./config.dev.js');
        Api = require('./api/dev.js').Api;
    }
    else{
       Config = require('./config.production.js');
       Api = require('./api/production.js')(Config.web);
    }

然后运行它gulp --env=testing

答案 10 :(得分:1)

此问题发布已经有一段时间了,但是也许会对某人有所帮助。

我使用的是GULP CLI 2.0.1(全局安装)和GULP 4.0.0(本地安装),这是在没有任何附加插件的情况下的操作方法。我认为代码是不言自明的。

var cp = require('child_process'), 
{ src, dest, series, parallel, watch } = require('gulp');

// == availableTasks: log available tasks to console
function availableTasks(done) {
  var command = 'gulp --tasks-simple';
  if (process.argv.indexOf('--verbose') > -1) {
    command = 'gulp --tasks';
  }
  cp.exec(command, function(err, stdout, stderr) {
    done(console.log('Available tasks are:\n' + stdout));
  });
}
availableTasks.displayName = 'tasks';
availableTasks.description = 'Log available tasks to console as plain text list.';
availableTasks.flags = {
  '--verbose': 'Display tasks dependency tree instead of plain text list.'
};
exports.availableTasks = availableTasks;

并从控制台运行:

gulp availableTasks

然后运行并查看差异:

gulp availableTasks --verbose