PhpStorm 2021.3 Help

新观察者对话框

当您单击“文件观察器”页面上的“添加  添加按钮”或“编辑  编辑按钮”按钮时,该对话框打开。使用该对话框基于预定义的 PhpStorm File Watcher 模板创建项目 File Watcher,或编辑现有项目 File Watcher。

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

姓名

名称字段中,输入文件观察程序的名称。默认情况下,PhpStorm 建议所选预定义模板的名称。

要观看的文件

文件类型

使用此列表指定预期的输入文件类型。File Watcher 将仅将此类文件视为分析和处理的主题。文件类型是根据文件类型和文件扩展名之间的关联来识别的。

范围

使用此列表来定义文件观察器可以应用到的文件范围。

这些文件中的更改将立即或在保存或帧停用时调用文件观察器,具体取决于自动保存编辑文件的状态以触发观察器复选框。

从列表中选择一个预定义范围。对于项目级文件观察器,您还可以单击以在打开的“范围”对话框中浏览按钮配置自定义范围。

  • 所有地方:下面列出的所有范围。

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

  • 项目生产文件:项目内容根目录中的所有文件,不包括测试源。

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

  • Scratches and Consoles:位于项目工具窗口中的Scratches and Consoles目录中的所有文件。

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

  • 当前文件:在活动编辑器选项卡中打开的文件。

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

  • All Changed Files:所有已更改的文件,即与所有现有更改列表关联的所有文件。

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

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

仅跟踪根文件

根文件是在指定范围内的import任何其他文件中不包含(例如 via )的文件。

  • 选中此复选框后,文件观察器仅针对根文件运行。

  • 清除该复选框后,文件观察程序将针对调用它的文件以及在指定范围内递归包含此文件的所有文件运行。

请注意,Scope设置会覆盖Track only root files复选框设置:如果依赖项超出指定范围,则不会应用 File Watcher。

示例假设您有两个文件root.scssanother.scss,其中root.scss导入another.scss。选中Track only root files复选框后,编辑another.scss会仅在root.scss上调用 File Watcher 。否则,如果清除该复选框,文件观察器将处理这两个文件。

在更改上运行的工具

在此区域中,配置与工具的交互:指定要使用的可执行文件、传递给它的参数以及 PhpStorm 应在何处查找工具的输出。

程序

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

论据

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

参数通常使用宏来指定,例如,$FileName$$FileNameWithoutExtension$,将被实际文件名替换。

手动键入宏或单击并从打开的对话框中插入宏图标的列表中选择相关模式。

要刷新的输出路径

在此字段中,告诉 PhpStorm 它应该在哪里搜索工具的输出:生成的源代码、源映射、依赖项或文件本身。输出的位置是特定于工具的。

输出路径通常使用宏指定。您可以手动键入它们,或单击插入宏图标并从打开的对话框中的列表中选择相关的。

请注意,更改输出路径以刷新字段中的值不会使工具将其输出存储在其他位置。如果您仍然需要这样做,请在“参数”字段中指定所需的自定义输出位置:键入以冒号作为分隔符的输出路径并使用宏。

工作目录和环境变量

工作目录

在此字段中,指定工具将应用到的目录。因为该工具总是在文件的上下文中调用,所以默认工作目录是当前文件的目录。默认工作目录是通过$FileDir$宏在所有预定义模板中指定的。要指定自定义工作目录,请在字段中键入它的路径,或单击并在“选择路径”对话框浏览图标中选择目录,或单击并从“”对话框的列表中选择所需的宏。插入宏图标

环境变量

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

高级选项

自动保存编辑的文件以触发观察者

  • 选中此复选框后,PhpStorm 会在您编辑文件后立即保存文件,以便文件观察器立即唤醒。

  • 当复选框被清除时,文件观察器在保存(文件 | 全部保存)或当您从 PhpStorm 移动焦点时(在帧停用时)启动。

触发外部变化的观察者

  • 选中此复选框后,文件观察器会在其范围内对文件进行的任何更改时唤醒,包括在 PhpStorm 之外所做的更改或在您签出版本控制系统中的分支后所做的更改。

  • 当复选框被清除时,文件观察器仅在其范围内的文件从 PhpStorm 更新并忽略其他更改时启动,例如,从您的版本控制系统收到的更改。

无论语法错误如何都触发观察程序

  • 选中该复选框后,无论文件的语法正确性如何,文件观察程序都会启动。文件观察器将在更新、保存或帧停用时启动,具体取决于自动保存编辑文件的状态以触发观察器复选框。

  • 清除此复选框后,文件观察器将忽略文件中语法无效的所有触发器,并仅在无错误文件中启动。

从标准输出创建输出文件

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

  • 选中此复选框后,PhpStorm 会读取本机工具的输出standard output stream (stdout)并从中生成结果文件。生成文件的名称取自Output paths to refresh字段。如果该字段包含多个名称,则使用列表中的第一个。

显示控制台

从此列表中,选择您希望文件观察器何时打开控制台。

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

  • 出错时:使用此选项,仅当Exit code不同于0.

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

输出滤波器

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

例如,要显示有用的错误消息,请键入$FILE_PATH$:$LINE$ $MESSAGE$

最后修改:2021 年 9 月 23 日