【WebStorm教程】WebStorm Code inspections代码检查、运行检查

在 WebStorm 中,有一组代码检查可以检测和纠正项目中的异常代码。IDE 可以发现并突出显示各种问题,定位死代码,发现可能的错误、拼写问题,并改进整体代码结构。
检查可以在所有项目文件中或仅在特定范围内(例如,仅在生产代码或修改文件中)扫描您的代码。
每项检查都有一个严重级别——问题影响代码的程度。严重性在编辑器中以不同的方式突出显示,以便您可以快速区分关键问题和不太重要的事情。WebStorm 带有一组预定义的严重级别,您可以创建自己的级别。
检查及其设置在配置文件中分组。每个配置文件都包含有关已启用检查的信息、它们分析的文件范围以及它们的严重性级别。
访问所有可用的检查及其设置
- 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到Editor | 检查。
用于过滤检查列表。例如,您可以按严重性或语言过滤检查。
即时分析当前文件
IDE 会不断检查您的代码并搜索问题。编辑器右上角的小部件显示在当前文件中检测到的每个严重性的问题数量:
该小部件具有简化的视图。要启用它,请将鼠标悬停在小部件上,单击
,然后选择Compact View。
单击小部件以在“问题”工具窗口的“当前文件”选项卡上打开问题列表。您还可以通过选择查看 |访问问题工具窗口。工具窗口 | 问题或按。Alt+6
对于每个问题,您可以通过按Alt+Enter或单击来查看建议的快速修复。F4您也可以通过按或双击工具窗口中的问题跳转到编辑器中的相应行。
或者,单击以能够在工具窗口中查看和修复问题。
滚动条中的彩色条纹还标记了检测到的代码问题,并帮助您在不滚动文件的情况下快速访问相应的行。将鼠标悬停在条带上的标记上以在工具提示中查看检测到的问题。单击标记可跳转到相应的行。
导航到检测到的问题
您可以通过单击小部件或按F2或相应地在文件中从一个突出显示的问题跳转到另一个问题Shift+F2。默认情况下,IDE 会根据问题的严重性为您导航:错误 > 警告 > 弱警告 > 服务器问题 > 错别字。
您可以配置 WebStorm 以一一解决问题,无论其严重程度如何。将鼠标悬停在编辑器右上角的小部件上,单击,选择'Next Error' Action (F2) Goes Through,然后启用All Problems。
手动运行检查
某些检查需要全局代码分析,这就是它们在编辑器中被禁用的原因。这些检查列在Settings/Preferences | 编辑 | 检查。单击并选择仅显示批处理模式检查。
如果您想获得所有检测到的问题的完整报告,请手动运行检查。
运行所有检查
- 从主菜单中,选择代码 | 检查代码......
要指定要分析的文件的范围,请执行以下操作之一:
- 选择整个项目或未提交的文件。
- 选择自定义范围,然后从列表中选择适当的范围。
- 如果配置的自定义范围都不适合您,请单击
并配置新范围,如范围和文件颜色中所述。
- 选择要应用的检查配置文件。
要创建新配置文件或修改现有配置文件之一,请单击配置。
- 单击“确定”开始分析。
运行单次检查
如果您想跟踪特定问题,运行单次检查很有用。如果您在文件中发现警告,您可以检查整个项目或文件的必要范围,以确保代码库中不再有此类警告。
- 从主菜单中,选择代码 | 分析代码 | 按名称运行检查...或按Ctrl+Alt+Shift+I。
- 在弹出窗口中输入检查名称。使用 CamelHumps 将驼峰式单词和空格与单词的首字母匹配。建议列表将向您显示与您的搜索请求相匹配的检查。
如果您不确定您选择的检查是否正确,您可以查看其说明。为此,请在弹出窗口中选择一项检查并按Ctrl+Q。
- 双击必要的检查以打开其设置。
- 在打开的对话框中,选择要分析的文件范围。
文件掩码选项可帮助您缩小要检查的文件数量。
选中该复选框并指定与您要分析的文件名称匹配的字符和通配符模式。使用逗号分隔多个文件掩码。
- 某些检查可能有其他选项,系统会提示您进行配置。
这些设置将仅应用于此运行,不会影响您当前配置文件中的此检查配置。
IDE 将在专用工具窗口工具窗口中显示检查结果。您可以在那里检查并修复检测到的问题。
在将代码提交到 Git 之前分析代码
如果您的项目受 Git 版本控制,您可以配置 IDE 以在提交修改文件之前对其进行分析。
- 按Ctrl+K或选择Git | 从主菜单提交。
- 在“提交工具”窗口中,单击
并在“提交前”区域中,选中“分析代码”复选框。
或者,如果您使用的是Commit Changes对话框,请在Before Commit区域中选中分析代码复选框。
- 单击配置并选择IDE 将从中运行检查的所需检查配置文件。
提交工具窗口
提交更改对话框
- 单击提交。
WebStorm 通过从选定的配置文件运行检查来分析修改文件中的代码。
如果检测到任何错误或警告,您将看到通知。
- 在通知中,单击“查看”以查看“消息”工具窗口中检测到的问题的列表。单击提交以提交您的更改而不修复检测到的问题。
离线运行检查
除了从 IDE 运行代码检查外,您还可以从命令行启动检查,而无需实际运行 WebStorm。检查结果将存储在 XML 文件中。有关详细信息,请参阅从命令行运行代码检查。
更改范围的顺序
默认情况下,所有启用的代码检查都会分析项目中的所有文件。根据您的需要,您可以在具有不同设置的多个文件范围内运行相同的检查。
如果一个文件包含在两个或多个范围内,并且您在这些范围内启用检查,WebStorm 将根据它们在范围列表中的顺序处理它们 - 最上面的范围将具有最高优先级,因此将对其进行分析第一的。
- 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中,选择Editor | 检查。
- 从列表中选择任何检查。
- 从In All Scopes列表中,选择Edit Scopes Order。
- 选择必要的范围,并使用
和
在列表中上下移动它。
- 如果需要,创建一个新范围。为此,请单击
( Edit Scopes ),指定范围设置,然后选择要包含在其中的文件和文件夹。