js STUDIO

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を実行すると、デフォルトのtargetはdevとなり、CSSはexpandedフォーマットで出力されます。

もし、grunt deploy --target=stagingを実行すると、stagingがtargetとなり、 CSSはcompressedフォーマットで出力されます。

grunt.optionは、タスク内でも同様に使用することができます。 

grunt.registerTask('upload', 'Upload code to specified target.', function(n) {
  var target = grunt.option('target');
  // targetに対しての何らかの処理を行う
});
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()

 Back to top

© 2010 - 2017 STUDIO KINGDOM