.flowconfig

すべての Flow プロジェクトには .flowconfig ファイルが含まれています。.flowconfig を変更することで Flow を設定できます。新しいプロジェクトや Flow の使用を開始するプロジェクトでは、flow init を実行してデフォルトの .flowconfig を生成できます。

.flowconfig の形式

.flowconfig では、INI ファイルに似ているカスタム形式を使用します。

.flowconfig は複数のセクションで構成されています

• [バージョン]
• [オプション]
• [インクルード]
• [無視]
• [型指定なし]
• [宣言]
• [ライブラリ]
• [リント]
• [strict]

コメント

# または ; または 💩 に続く、0 以上の空白から始まる行は無視されます。たとえば

# This is a comment
  # This is a comment
; This is a comment
  ; This is a comment
💩 This is a comment
  💩 This is a comment

.flowconfig を配置する場所

.flowconfig の場所は重要です。Flow は .flowconfig が含まれるディレクトリを プロジェクトのルートとして扱います。デフォルトでは、Flow はプロジェクトのルートにあるすべてのソースコードを含めます。[インクルード] セクション のパスは、プロジェクトのルートに対して相対的です。他の構成でもマクロ <PROJECT_ROOT> を使用してプロジェクトのルートを参照できます。

ほとんどの人は .flowconfig をプロジェクトのルート（つまり package.json の隣）に配置します。src/ ディレクトリにすべてのコードを配置する人もいるので、.flowconfig を src/.flowconfig に配置します。

例

.flowconfig が mydir にある場合、ディレクトリ構造を以下のように指定します

otherdir
└── src
    ├── othercode.js
mydir
├── .flowconfig
├── build
│   ├── first.js
│   └── shim.js
├── lib
│   └── flow
├── node_modules
│   └── es6-shim
└── src
    ├── first.js
    └── shim.js

.flowconfig ディレクティブを使用する方法の例を以下に示します。

[include]
../otherdir/src

[ignore]
.*/build/.*

[libs]
./lib

これで flow は、.flowconfig のパス外のディレクトリをそのチェックに含め、build ディレクトリを無視し、lib 内の宣言を使用します。