.flowconfig

Каждый проект Flow содержит файл .flowconfig. Настроить Flow можно, изменив .flowconfig. В новых проектах или проектах, в которых только начинают использовать Flow, можно создать файл .flowconfig по умолчанию, выполнив команду flow init.

Формат .flowconfig​

В .flowconfig используется пользовательский формат, отдалённо напоминающий файлы INI.

.flowconfig состоит из разных разделов:

• [version]
• [options]
• [include]
• [ignore]
• [untyped]
• [declarations]
• [libs]
• [lints]
• [strict]

Комментарии​

Строки, начинающиеся с нуля или более пробелов, за которыми следует #, ; или 💩, игнорируются. Например:

# 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 включает весь исходный код в корне проекта. Пути в разделе [include] задаются относительно корня проекта. В некоторых других настройках также можно ссылаться на корень проекта с помощью макроса <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.