当前位置：首页 > article >正文

Sublime Text 的PHP格式化插件phpfmt 的 setting 配置参数说明

article 2024/11/5 8:29:15

phpfmt.sublime-settings 是 Sublime Text 中 phpfmt 插件的配置文件，用于定义代码格式化的各种参数。以下是一些常见的配置参数及其说明：

1、`version`

指定配置文件的版本，根据 phpfmt 插件的版本，此值可能有所不同。

2、`php_bin`

指定 PHP 可执行文件的路径。例如："php_bin": "c:/PHP/php.exe"（Windows）或 "php_bin": "/usr/local/bin/php"（Linux/macOS）。

3、`format_on_save`

布尔值，指定是否在保存文件时自动格式化代码。示例："format_on_save": true

`4、``indent_with_space`

布尔值，指定是否使用空格进行缩进。如果为 false，则使用制表符（Tab）进行缩进。

5、`enable_auto_align`

布尔值，指定是否启用自动对齐功能。

6、`psr1` 和 `psr2`

布尔值，分别指定是否遵循 PSR-1 和 PSR-2 编码标准。

7、`psr1_naming`

布尔值，指定是否遵循 PSR-1 命名规范。

8、`passes`

数组，指定要应用的格式化步骤或“传递”。

示例如下：

"passes": [  
  "MergeElseIf",  
  "AlignEquals",  
  "ShortArray"  
]

9、`indent_size`

设置缩进的大小（空格数或制表符宽度）。通常与 indent_with_space 一起使用。

10、`exclude`

指定不应用格式化的文件或目录路径模式。使用通配符（如 *、**）来匹配多个文件或目录。

11、`additional_config`

指定额外的配置文件路径，该文件包含额外的 phpfmt 配置选项。这允许用户在不修改插件默认配置的情况下添加自定义配置。

12、`convert_short_array_syntax`

当设置为 true 时，将旧式的数组语法（如 array()）转换为短数组语法（如 []）。

13、`single_quote`

当设置为 true 时，将双引号字符串转换为单引号字符串（如果可能）。

14、总结

整个配置示例如下：

{  
  "version": 4,  
  "php_bin": "c:/PHP/php.exe",  
  "format_on_save": true,  
  "indent_with_space": true,  
  "enable_auto_align": true,  
  "psr1": true,  
  "psr1_naming": true,  
  "psr2": true,  
  "passes": [  
    "MergeElseIf",  
    "AlignEquals",  
    "AlignDoubleArrow",  
    "ShortArray"  
  ]  
}

演示效果图如下：