grunt.option

Grunt 選項 API 用於在多個任務之間共用參數，以及存取在命令列中設定的參數。

一個範例是針對您的建置目標是開發還是暫存的旗標。在命令列中：grunt deploy --target=staging 會導致 grunt.option('target') 傳回 "staging"。

一個利用 target 選項的 Gruntfile 範例可以是

grunt.initConfig({
  compass: {
    dev: {
      options: {
        /* ... */
        outputStyle: 'expanded'
      },
    },
    staging: {
      options: {
        /* ... */
        outputStyle: 'compressed'
      },
    },
  },
});
var target = grunt.option('target') || 'dev';
grunt.registerTask('deploy', ['compass:' + target]);

當您執行 grunt deploy 時，您的樣式表會預設為 dev 目標，並以展開格式輸出 CSS。如果您執行 grunt deploy --target=staging，則會執行 staging 目標，而您的 CSS 會以壓縮格式呈現。

grunt.option 也可用於任務中，例如

grunt.registerTask('upload', 'Upload code to specified target.', function(n) {
  var target = grunt.option('target');
  // do something useful with target here
});
grunt.registerTask('deploy', ['validate', 'upload']);

請注意，布林選項可以使用只有一個鍵而沒有值的鍵來指定。例如，在命令列上執行 grunt deploy --staging 會導致 grunt.option('staging') 傳回 true。

grunt.option ☃

取得或設定選項。

grunt.option(key[, val])

布林選項可以透過在 key 前加上 no- 來否定。例如

grunt.option('staging', false);
var isDev = grunt.option('no-staging');
// isDev === true

grunt.option.init

初始化 grunt.option。如果省略 initObject，選項將初始化為空物件，否則會設定為 initObject。

grunt.option.init([initObject])

grunt.option.flags

將選項傳回為命令列參數陣列。

grunt.option.flags()

grunt.option.keys

@since 1.2.0+

傳回所有選項鍵。

grunt.option.keys()