Flow CLI

flowコマンドラインツールは、単純なケースで簡単に使用できるように作られています。

flowコマンドを使用すると、.flowconfigファイルが存在する場合、現在のディレクトリを型チェックします。フローサーバーは必要に応じて自動的に起動されます。

さらに、CLIツールは、サーバーを制御し、Flowと統合するビルドツールを作成するための他のさまざまなオプションとコマンドを提供しています。たとえば、Nuclideエディターは、Flowと統合して、UIで自動補完、型のエラーなどを提供します。

CLIの詳細を確認するには、次のコマンドを入力します。

flow --help

これにより、flowが実行できるすべてに関する情報が表示されます。このコマンドを実行すると、次のような出力が表示されます。

Usage: flow [COMMAND] [PROJECT_ROOT]

Valid values for COMMAND:
  ast              Print the AST
  autocomplete     Queries autocompletion information
  batch-coverage   Shows aggregate coverage information for a group of files or directories
  check            Does a full Flow check and prints the results
  check-contents   Run typechecker on contents from stdin
  config           Read or write the .flowconfig file
  coverage         Shows coverage information for a given file
  cycle            Output .dot file for cycle containing the given file
  find-module      Resolves a module reference to a file
  find-refs        Gets the reference locations of a variable or property
  force-recheck    Forces the server to recheck a given list of files
  get-def          Gets the definition location of a variable or property
  graph            Outputs dependency graphs of flow repositories
  init             Initializes a directory to be used as a flow root directory
  ls               Lists files visible to Flow
  lsp              Acts as a server for the Language Server Protocol over stdin/stdout [experimental]
  print-signature  Prints the type signature of a file as extracted in types-first mode
  server           Runs a Flow server in the foreground
  start            Starts a Flow server
  status           (default) Shows current Flow errors by asking the Flow server
  stop             Stops a Flow server
  type-at-pos      Shows the type at a given file and position
  version          Print version information

Default values if unspecified:
  COMMAND         status
  PROJECT_ROOT    current folder

Status command options:
  --color              Display terminal output in color. never, always, auto (default: auto)
  --from               Specify client (for use by editor plugins)
  --help               This list of options
  --json               Output results in JSON format
  --no-auto-start      If the server is not running, do not start it; just exit
  --old-output-format  Use old output format (absolute file names, line and column numbers)
  --one-line           Escapes newlines so that each error prints on one line
  --quiet              Suppresses the server-status information that would have been printed to stderr
  --retries            Set the number of retries. (default: 3)
  --show-all-errors    Print all errors (the default is to truncate after 50 errors)
  --strip-root         Print paths without the root
  --temp-dir           Directory in which to store temp files (default: /tmp/flow/)
  --timeout            Maximum time to wait, in seconds
  --version            Print version number and exit

カスタムプロジェクトルートを使用した例

mydir
├── frontend
│   ├── .flowconfig
│   └── app.js
└── backend

flow check frontend

次に、--helpフラグを追加して、特定のCOMMANDをさらに詳しく調べることができます。

たとえば、自動補完がどのように機能するかについての詳細を確認する場合は、次のコマンドを使用できます。

flow autocomplete --help