.flowconfig

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

.flowconfig формат

Файл .flowconfig использует специальный формат, отдаленно напоминающий INI-файлы.

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

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

Комментарии

Поддержка комментариев была добавлена в версии v0.23.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 включает весь исходный код в пределах корня проекта. Пути в разделе [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.