PhpStorm 2021.3 Help

从命令行格式化文件

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

命令行格式化程序在后台启动 PhpStorm 实例并应用格式化。如果另一个 PhpStorm 实例已经在运行,它将无法工作。在这种情况下,您可以从正在运行的实例执行代码样式格式化。使用命令行格式化程序自动定期维护具有许多贡献者的大型代码库,以确保一致的编码风格。

为了能够格式化文件,请安装并启用支持 PhpStorm 中相应文件类型的插件(例如,用于格式化 shell 脚本文件的Shell Script插件)。

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

句法
phpstorm64.exe 格式 [<options>] <path ...>
例子

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

phpstorm64.exe 格式 C:\Data\src\hello.html C:\Data\src\world.html

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

phpstorm64.exe 格式 -r C:\Data\src

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

phpstorm64.exe 格式 -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src

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

句法
format.sh [<选项>] <路径 ...>
例子

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

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

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

格式.sh -r ~/Data/src

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

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

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

句法
phpstorm.sh 格式 [<options>] <path ...>
例子

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

phpstorm.sh 格式 ~/Data/src/hello.html ~/Data/src/world.html

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

phpstorm.sh 格式 -r ~/Data/src

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

phpstorm.sh 格式 -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

选项

选项

描述

-h

显示帮助信息并退出。

-m|-mask

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

-r|-R

递归处理指定目录。

-s|-settings

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

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

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

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

格式化程序还会在父目录中查找.editorconfig文件,您可以显式使用 EditorConfig 进行格式化,而不是使用 PhpStorm 代码样式设置。有关更多信息,请参阅使用 EditorConfig 在目录级别管理代码样式

最后修改:2021 年 10 月 27 日