PyCharm 2025.3 Help

Flow

Flow 是一款静态类型检查器,可为 JavaScript 引入类型注解。 PyCharm 能识别 Flow 结构,并在所有操作系统上为其提供语法高亮。

开始之前

请确保您的计算机上已安装 Node.js

安装并配置 Flow

  • 在嵌入式 终端Alt+F12 )中,使用下列任一命令:

    • 要全局安装 Flow,请运行:

      npm install --global flow-bin
    • 要将 Flow 作为开发依赖安装,请运行:

      npm install --save-dev flow-bin

请参阅 Flow 官方网站 了解更多信息。

为了使 PyCharm 识别 Flow 结构、正确提供语法高亮、正确报告错误并避免误报错误高亮,请将项目中的 JavaScript 语言级别更改为 Flow ,向项目添加一个 .flowconfig 配置文件,并在每个需要检查的文件顶部添加一个 // @flow 注释。

将项目语言级别更改为 Flow

  1. 设置 对话框(Ctrl+Alt+S )中,转到 语言 & 框架 | JavaScript。 将打开 JavaScript 页面。

  2. JavaScript 语言版本 列表中,选择 Flow

  3. Flow 包或可执行文件 字段中,指定 node_modules\flow-bin 包的路径或 Flow 二进制可执行文件的路径。 要使用 node_modules\.bin\flow ,请确保 Node.js 的路径已添加到 PATH 环境变量中。

  4. 将 Flow 服务器用于: 区域,通过选中或清除以下复选框来指定代码辅助的依据:

    • 类型检查: 选中该复选框后,将基于从 Flow 服务器接收的数据提供语法和错误高亮。 清除此复选框后,仅提供 PyCharm 的基本内部高亮。

    • 导航、代码补全和类型提示: 选中该复选框后,用于引用解析和代码补全的建议列表将同时包含通过与 Flow 集成获取的建议以及由 PyCharm 计算的建议。 清除此复选框后,引用仅通过 PyCharm 的计算进行解析。

    仅在指定了 Flow 可执行文件路径时,复选框才可用。

  5. 请保持选中 自动保存所有已修改的文件 复选框,以确保持续应用 Flow,因为 Flow 仅会在保存所有其他已修改文件后才检查当前文件。

启用 Flow

  1. 要添加 .flowconfig ,请打开嵌入式 终端Alt+F12 ),然后键入:

    flow init

    要将 .flowconfig 添加到特定文件夹,请键入:

    cd <path to the folder to check>

    flow init

  2. 要在文件中启用 Flow,请在文件顶部添加一个 // @flow 注释:只需键入 flow ,按下 Tab ,PyCharm 会将其展开为 // @flow

    如果您尚未拥有 .flowconfig ,PyCharm 会显示一个工具提示,提示您将配置文件添加到当前文件夹。

    工具提示:将 .flowconfig 添加到当前文件夹

    要在当前文件夹与项目根之间进行选择,请点击 更多操作 或按 Alt+Enter

    工具提示:更多操作

监控错误

PyCharm 允许您在 问题 工具窗口中查看 Flow 检测到的错误。 要打开该工具窗口,请从主菜单中选择 视图 | 工具窗口 | 问题 ,或点击编辑器右上角的小部件。

检查小部件

该工具窗口包含两个窗格。

  • 错误 窗格显示在活动编辑器选项卡中打开的文件中检测到的所有不一致项列表。 顶部显示文件的完整路径。

    错误窗格

    要获取有关错误的更多信息,请在其描述的上下文菜单中选择 显示错误详细信息

    错误窗格:显示详细信息
  • 项目错误 窗格显示当前项目中所有文件检测到的所有不一致项列表。 错误消息按其被检测到的文件进行分组。

    项目错误窗格

详细了解请参阅 运行检查获取结果并修复问题

最后修改日期: 2025年 12月 2日