js STUDIO

grunt.config

Gruntファイルによって定義されたプロジェクト固有の設定データにアクセスします。

下記のメソッドはgrunt.initConfigにより、gruntオブジェクトでも利用可能な事に 注意してください。

grunt.config.init ☃

現在のプロジェクトのために、設定オブジェクトを初期化します。 固有のconfigObjectはタスクに使用され、grunt.configメソッドを使用することでアクセス可能です。 ほとんどの各プロジェクトのGruntfileはこのメソッドに呼び出されます。 

grunt.config.init(configObject)

特定の<% %>テンプレート文字列は、取得した設定データによって処理されることに注意してください。 この例は、 grunt-contrib-jshint プラグインのjsHintタスクのためのサンプル設定データを含んでいます。 

grunt.config.init({
  jshint: {
    all: ['lib/*.js', 'test/*.js', 'Gruntfile.js']
  }
});

「はじめに」 のガイドで更に多くの設定例を確認してみてください。

このメソッドは、grunt.initConfigからも利用可能です。

下記のメソッドはgruntの設定データに、 ドット区切りの'pkg.author.name'のような文字列か、 または['pkg', 'author', 'name']のようなプロパティ名の配列を通して、 アクセスすることが出来ます。

もし、プロパティ名にドット.が含まれる場合、 バックスラッシュでエスケープする必要があることに注意してください。(例:'concat.dist/built\\.js') 配列指定の場合は、grunt.config.escapeメソッドによってエスケープ処理を扱います。

grunt.config

プロジェクトのGrunt設定値の取得、設定を行います。 このメソッドは他のメソッドへのエリアスを提供し、2つの引数が渡されると、 grunt.config.setが呼び出され、 そうで無ければgrunt.config.getが呼び出されます。 

grunt.config([prop [, value]])

grunt.config.get

プロジェクトのGrunt設定値を取得します。 propが指定されていれば、プロパティ値を返し、プロパティ値が未定義ならばnullを返します。 もし、propが指定されていなければ、全体のconfigオブジェクトのコピーが返されます。

テンプレートの文字列は、grunt.config.process methodを使用して、 再帰的に処理されます。 

grunt.config.process method

grunt.config.process

<% %>テンプレートを探して、 Grunt設定値に再帰的に(grunt.template.processメソッドを通して)処理します。 このメソッドは、grunt.config.getRawではなく、grunt.config.getによって 呼び出されます。 

grunt.config.process(value)

もし、取得した値が完全な単一の'<%= foo %>'や、'<%= foo.bar %>'のようなテンプレート文字列で、且つ、 fooまたはfoo.barプロパティが文字列ではない(且つnullや未定義でもない)場合でも、それは正確な値として展開されます。 Gruntのタスクシステムは配列を自動的にフラットな文字列に展開してくれます。これは大変便利です。

grunt.config.getRaw

プロジェクトのエスケープされていないGrunt設定値を取得するには、<% %>テンプレート文字列を通さずに処理します。 もし、propが指定された場合、プロパティの値が返されますが、プロパティが定義されていなければnullになります。 もし、porpが指定されていなければ、全ての設定オブジェクトのコピーが返されます。 

grunt.config.getRaw([prop])

grunt.config.set

プロジェクトのGrunt設定に対し、値をセットします。 

grunt.config.set(prop, value)

指定された<% %>テンプレート文字列は、 設定データを取得できた場合にのみ処理されることに注意してください。

grunt.config.escape

propStringの.ドット文字列をエスケープします。 これは、ドット文字列を含むプロパティ名に対して使用されます。 

grunt.config.escape(propString)

下記のメソッドは、タスク内のthisオブジェクトから this.requiresConfigとして利用可能です。

grunt.config.requires

もし、1つまたは複数の設定プロパティがnullやundefinedで取得出来ない場合、 現在のタスクを失敗とみなすことが出来ます。 対象とするプロパティは、文字列または配列で指定可能です。 

grunt.config.requires(prop [, prop [, ...]])

このメソッドはタスク内で、this.requiresConfigとして利用可能です。

 Back to top

© 2010 - 2017 STUDIO KINGDOM