Formatting Files from Command Line
Command-line source code formatter is a special functionality within PhpStorm that lets you format arbitrary files outside a project.
- In the command line, run
format
command the using the following syntax:format [-h] [-r|-R] [-s|-settings settingsPath] [-m|-mask masks] path1 [path2...]
The command launches PhpStorm, which formats the specified files and then quits.
The command options are as follows:
Option | Description |
---|---|
format | The full path to the format.bat (format.sh on macOS and Linux) script located in the <IDE_HOME>/bin directory. |
-h | (optional) Show the help message and quit. |
-r|-R | (optional) Scan directories specified in path1,path2... recursively. |
-s|-settings settingsPath | (optional) Format code according to the code style settings file provided in the settingsPath . You can use one of the following:
If the parameter is omitted, the default code style settings will be used. |
-m|-mask masks | (optional) A comma-separated list of file masks that define the files to be processed. The * (any string) and ? (any single character) wildcards are supported. |
pathN | The path to a file or directory to be processed. |
Examples
- Format all files in the C:\Data\src directory including all subdirectories using the default code style settings:
<IDE_HOME>\bin\format.bat -r C:\Data\src
- Non-recursively format all the .xml and .html files in the C:\Data\src directory using code style settings from C:\Data\settings.xml:
<IDE_HOME>\bin\format.bat -s C:\Data\settings.xml -m * .xml,*.html C:\Data\src
- Format all files in the ~/MyProject/src directory including all subdirectories using the default code style settings:
<IDE_HOME>/bin/format.sh -r ~/MyProject/src
- Non-recursively format all the .xml and .html files in the ~/MyProject/src directory using code style settings from ~/Data/settings.xml:
<IDE_HOME>/bin/format.sh -s ~/Data/settings.xml -m * .xml,*.html ~/MyProject/src
Last modified: 27 July 2018