WebStorm 2025.2 Help

新建 Watcher 对话框

单击 添加   添加按钮编辑   编辑按钮 按钮,在 File Watcher 页面 中打开此对话框。 使用此对话框可根据预定义的 WebStorm File Watcher 模板创建项目 File Watcher,或编辑现有项目 File Watcher。

每个模板都包含对所选工具最优的设置。 因此,在大多数情况下,您只需指定该工具可执行文件的路径。

名称

名称 字段中输入 File Watcher 的名称。 默认情况下,WebStorm 会建议使用所选预定义模板的名称。

要监视的文件

文件类型

使用此列表指定输入文件的预期类型。 File Watcher 仅会分析并处理此类型的文件。 文件类型是根据 文件类型与文件扩展名之间的关联 识别的。

范围

使用此列表定义 File Watcher 可应用于的文件范围。

这些文件的更改会根据 自动保存已编辑文件以触发 Watcher 复选框的状态,在保存时、失去焦点时或立即触发 File Watcher。

从列表中选择一个预定义范围。 对于项目级别的 File Watcher,您也可以单击 浏览按钮 ,在打开的 范围 对话框中配置自定义范围。

  • 所有位置: 以下列出的所有范围。

  • 项目文件: 项目内容根下的所有文件(请参阅 配置项目结构)。

  • 项目生产文件: 项目内容根下的所有非测试源文件。

  • 项目测试文件: 项目测试源根下的所有文件。

  • 临时文件与控制台:临时文件与控制台 目录中的所有文件,该目录位于 项目 工具窗口中。

  • 打开的文件: 所有当前在编辑器中打开的文件。

  • 当前文件: 当前活动编辑器标签页中打开的文件。

VCS 范围: 这些范围仅在您的 项目处于版本控制状态 时可用。

  • 所有已更改文件: 所有变更文件,即所有关联到现有变更列表的文件。

  • 默认变更列表: 与变更列表 Default 关联的所有文件。

或者,单击 浏览按钮 并在打开的 范围 对话框中配置一个 自定义范围

仅跟踪根文件

根文件 是未被任何其他文件 在指定范围中 (例如通过 import )包含的文件。

  • 选中此复选框时,File Watcher 仅对 根文件 运行。

  • 取消选中复选框后,File Watcher 会对其被调用的文件以及该文件在指定范围内递归包含的所有文件运行。

请注意, 范围 设置会覆盖 仅跟踪根文件 复选框的设置:如果依赖项不在指定范围内,File Watcher 将不会应用于该依赖项。

示例 假设您有两个文件 root.scss another.scss ,其中 root.scss 引用 another.scss 。 选中 仅跟踪根文件 复选框时,编辑 another.scss 只会在 root.scss 上触发 File Watcher。 否则,如果未选中复选框,File Watcher 会处理这两个文件。

更改时运行的工具

在此区域配置与工具的交互方式:指定要使用的可执行文件、传递给它的参数,以及 WebStorm 应该在哪里查找工具的输出结果。

程序

在此字段中,指定工具可执行文件的路径( .com .exe .cmd .bat ,或其他,具体取决于所用工具)。

参数

在此字段中定义传递给工具的参数,以此影响其行为。

参数通常使用 指定,例如 $FileName$$FileNameWithoutExtension$ ,这些宏将在运行时被替换为实际的文件名。

您可以手动输入宏,或单击 插入宏图标 ,在打开的 对话框中从列表中选择相应的模式。

要刷新的输出路径

在此字段中,告知 WebStorm 应该在哪里查找工具的输出内容,包括生成的源代码、source map、依赖项,或文件本身。 输出位置因工具而异。

输出路径通常使用 指定。 您可以手动输入宏,或单击 插入宏图标 ,在打开的对话框中选择相应的宏。

要指定多个宏,请使用冒号 : 作为分隔符,例如 $FileNameWithoutExtension$.css:$FileNameWithoutExtension$.css.map

工作目录与环境变量

工作目录

在此字段中,指定要应用工具的目录。 由于工具始终在文件上下文中调用,因此默认工作目录为当前文件所在的目录。 所有预定义模板中都通过 $FileDir$ 宏指定了默认工作目录。 要指定自定义工作目录,请在字段中输入其路径,或单击 浏览图标 并在 选择路径 对话框中选择目录,或单击 插入宏图标 ,从 对话框中的列表中选择所需的

环境变量

在此字段中,指定工具所需但未在操作系统级别指定的环境变量。

高级选项

自动保存已编辑文件以触发监视程序

  • 选中此复选框后,WebStorm 会在您编辑文件后立即保存该文件,从而立即启动 File Watcher。

  • 如果取消选中该复选框,File Watcher 将在保存文件(文件 | 全部保存 )或您切换离开 WebStorm 后(窗口失去焦点时)启动。

当发生外部更改时触发监视程序

  • 选中该复选框后,File Watcher 会在其作用域内的文件内容发生任何更改时被触发,包括从 WebStorm 外部编辑或在版本控制系统中检出分支后的更改。

  • 取消选中此项时,只有当作用域内的文件在 WebStorm 中被更新时监视器才会启动,并忽略其他更改,例如来自版本控制系统的更改。

忽略语法错误仍触发监视程序

  • 启用此复选框后,File Watcher 将在无论文件是否有语法错误的情况下启动。 File Watcher 将根据 自动保存已编辑文件以触发 Watcher 复选框的状态,在文件更新、保存或窗口失去焦点时启动。

  • 取消选中该复选框时,File Watcher 将忽略语法无效的文件中的所有触发器,仅在无错误的文件中启动。

通过 stdout 创建输出文件

  • 在大多数情况下,应取消此复选框,因为大多数工具会直接将其输出写入相关文件中。

  • 选中此复选框后,WebStorm 会读取本地工具的 standard output stream (stdout) 输出,并从中生成结果文件。 生成文件的名称取自 要刷新的输出路径 字段。 如果该字段包含多个名称,则使用列表中的第一个名称。

显示控制台

从此列表中选择在何时由 File Watcher 打开控制台。

  • 始终: 选择此选项后,工具执行完成后将始终打开控制台。

  • 出错时: 选择此选项后,仅当 Exit code0 不同时,工具执行完成后才会打开控制台。

  • 从不: 选择此选项可完全禁止打开控制台。

输出过滤器

在此字段中,指定与工具关联的输出过滤器。 根据这些过滤器,工具输出中的绝对文件路径和行号会转换为超链接。 单击这些链接将在编辑器中打开相应文件。

例如,为了显示有用的错误信息,请键入 $FILE_PATH$:$LINE$ $MESSAGE$

最后修改日期: 2025年 9月 26日