# 設定ファイル

Houl の設定ファイルには .json もしくは、オブジェクトをエクスポートする .js ファイルを使うことができます。設定ファイルにはプロジェクトのソースコードが入ったディレクトリ、出力先ディレクトリ、ソースコードをどのように変換するか、などを設定することができます。利用可能なオプションは以下のとおりです。

# ルール

ルール によってソースコードをどのように変換するかを指定することができます。設定ファイルの rules はキーが変換するソースコードの拡張子と対応するオブジェクトです。例えば、.js ファイルを変換したいとき、rules オブジェクトに js プロパティを追加します。

rules オブジェクトのそれぞれの値はオブジェクト、文字列、または、関数になります。文字列、関数が指定されたときは task として扱われます。

# プリセット

Houl は npm で公開されている外部のプリセットを読み込めます。設定ファイルの preset フィールドを指定することで読み込めます。例えば、houl-preset-foo というプリセットを使いたいときは、そのパッケージ名を preset に書きます。

{
  "input": "./src",
  "output": "./dist",
  "preset": "houl-preset-foo"
}

# プリセットオプションの指定

preset フィールドの options プロパティで任意のオプションの値をプリセットに渡すことができます。

{
  "input": "./src",
  "output": "./dist",
  "preset": {
    "name": "houl-preset-foo",
    "options": {
      "exclude": "**/_*/**"
    }
  }
}

指定されたオプションはプリセットの設定ファイルが関数の形式で定義されていれば、その中で使用できます。

module.exports = function(options) {
  return {
    exclude: options.exclude,
    rules: {
      // ...
    }
  }
}

# プリセット設定の拡張

特有の要件に対応するため、既存のプリセットのルールを拡張したい場合があるかもしれません。そのような場合は、対応するルールに追加のオプションを指定するだけで良いです。

例えば、プリセットの設定が次のようなときを考えます。

{
  "rules": {
    "js": {
      "task": "script"
    }
  }
}

また、ユーザーの設定が以下の通りだとします。

{
  "preset": "houl-preset-foo",
  "rules": {
    "js": {
      "exclude": "**/_*/**"
    }
  }
}

上記は次の設定と同じ意味を持ちます。

{
  "rules": {
    "js": {
      "task": "script",
      "exclude": "**/_*/**"
    }
  }
}

プリセットをより柔軟に変更したいときは、preset.modifyConfig オプションを使えます。modifyConfig には第 1 引数に生のプリセットの設定オブジェクトが渡される関数を指定します。プリセットの設定をその関数内で変更したり、任意で新しい設定オブジェクトを返すことができます。

module.exports = {
  input: './src',
  output: './dist',
  preset: {
    name: 'houl-preset-foo',
    modifyConfig: config => {
      // プリセット内の `foo` タスクを削除
      // タスクを削除するには `null` を代入するのではなく
      // `delete` 文を使う必要があります
      delete config.rules.foo
    }
  }
}

# 開発オプション

dev フィールドには開発サーバー関連のオプションを渡せます。dev フィールドは次のようなプロパティを含むオブジェクトを期待します。

下記は proxy 設定の例です。

{
  "dev": {
    "proxy": {
      "/foo": "http://foo.com/",
      "/bar": {
        "target": "https://bar.com/",
        "secure": true
      }
    }
  }
}

proxy オブジェクトのキーはどのパスに向けたリクエストをプロキシすべきかを表しています。上記の設定は開発サーバーへのリクエスト /foo を http://foo.com/ にプロキシし、/bar を https://bar.com/ にプロキシします。

# 設定例

設定ファイルの完全な例は以下のとおりです。

{
  "input": "./src",
  "output": "./dist",
  "exclude": ["**/_*", "**/private/**"],
  "taskFile": "./houl.task.js",
  "preset": "houl-preset-foo",
  "rules": {
    "js": {
      "task": "scripts",
      "exclude": "**/vendor/**",
      "progeny": {
        "extension": "es6"
      }
    },
    "scss": {
      "task": "styles",
      "outputExt": "css",
      "options": {
        "fooValue": "foo"
      }
    }
  }
}