WebStorm 2025.2 Help

从命令行格式化文件

WebStorm 可以根据配置的代码样式设置 格式化您的代码。 您还可以从命令行将代码样式格式应用于指定的文件。

命令行格式化程序会在后台启动一个 WebStorm 实例并应用格式设置。 如果已经有其他 WebStorm 实例正在运行,则此功能将无法使用。 在这种情况下,您可以通过正在运行的实例执行代码样式格式化操作。 使用命令行格式化程序对拥有众多协作者的大型代码库执行自动化定期维护,以确保代码风格一致。

要格式化文件,需在 WebStorm 中安装并启用支持相应文件类型的插件(例如用于格式化 Shell 脚本文件的 Shell Script 插件)。

可在安装目录的 bin 路径下找到用于运行 WebStorm 的可执行文件。 要将该可执行文件用作命令行启动器,请按照 命令行界面 中的说明将其添加到系统 PATH 中。

语法
webstorm64.exe format [<options>] <path ...>
示例

使用默认代码样式设置,从 C:\Data\src 目录中格式化两个特定文件:

webstorm64.exe format -allowDefaults C:\Data\src\hello.html C:\Data\src\world.html

使用默认代码样式设置,递归格式化 C:\Data\src 目录及其所有子目录中的所有文件:

webstorm64.exe format -allowDefaults -r C:\Data\src

使用 C:\Data\settings.xml 中的代码样式设置,非递归地格式化 .xml .html 文件夹中 C:\Data\src 目录下的所有文件:

webstorm64.exe format -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src

WebStorm 包含用于运行命令行代码格式化程序的脚本。 默认情况下,脚本位于应用程序包中: WebStorm.app/Contents/bin/format.sh

语法
./format.sh [<options>] <path ...>
示例

使用默认代码样式设置,从 ~/Data/src 目录中格式化两个特定文件:

./format.sh -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

使用默认代码样式设置,递归格式化 ~/Data/src 目录及其所有子目录中的所有文件:

./format.sh -allowDefaults -r ~/Data/src

使用 ~/Data/settings.xml 中的代码样式设置,非递归地格式化 .xml .html 文件夹中 ~/Data/src 目录下的所有文件:

./format.sh -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

可在安装目录的 bin 路径下找到用于运行 WebStorm 的脚本。 要将该脚本用作命令行启动器,请按照 命令行界面 中的说明将其添加到系统 PATH 中。

语法
webstorm.sh format [<options>] <path ...>
示例

使用默认代码样式设置,从 ~/Data/src 目录中格式化两个特定文件:

webstorm.sh format -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

使用默认代码样式设置,递归格式化 ~/Data/src 目录及其所有子目录中的所有文件:

webstorm.sh format -allowDefaults -r ~/Data/src

使用 ~/Data/settings.xml 中的代码样式设置,非递归地格式化 .xml .html 文件夹中 ~/Data/src 目录下的所有文件:

webstorm.sh format -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

选项

选项

描述

-h

显示帮助信息并退出。

-m|-mask

指定以逗号分隔的文件掩码列表,用于定义要处理的文件。 您可以使用 * (任意字符串)和 ? (任意单个字符)通配符。

-r|-R

递归处理指定目录。

-s|-settings

指定用于格式化的代码样式设置文件。 可以是以下任意一种:

  • 导出代码样式设置的文件:打开 编辑器 | 代码样式 设置页面 Ctrl+Alt+S ,点击 显示方案操作按钮 ,然后选择 导出

  • 存储在项目目录中的 .idea/codeStyleSettings.xml 文件(适用于 WebStorm 2017.2 及更早版本)。

  • 存储在项目目录中的 .idea/codeStyles/Project.xml 文件(适用于 WebStorm 2017.3 及更高版本)。

格式化程序还会在父目录中查找 .editorconfig 文件,并在 WebStorm 的代码样式设置基础上应用这些文件。 在这种情况下,如果 EditorConfig 中的设置与您的代码样式方案设置重叠,WebStorm 将使用 EditorConfig 中的设置。 剩余的设置将从您的代码样式方案中获取。 如需了解更多信息,请参见 使用 EditorConfig 按目录级别管理代码风格

如果未指定该选项,该文件将被跳过。 如果父文件夹中存在项目,则其设置将被隐式使用,同时还会应用 EditorConfig。

-allowDefaults

在未为某个文件或一组文件定义代码样式时(例如未设置 -s 且文件不属于任何项目),使用默认的代码样式设置。 否则,该文件或文件集合将被忽略。

-charset

保留编码,并强制读取和写入源文件时使用指定的字符集,例如: -charset ISO-8859-15

如果命令行格式化程序无法正确处理源文件中的特殊字符,此选项将非常有用。

-d|-dry

以验证模式运行格式化程序。 格式化程序将在内存中执行相同的格式化操作,并在任意格式化后的文件与原文件不同时以非零状态退出。

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