debian系统phpstorm如何进行代码格式化

Debian 下 PhpStorm 代码格式化指南

一 内置格式化与常用快捷键

• 在 Debian 上 PhpStorm 的内置格式化与快捷键与平台无关，可直接使用：
  • 格式化当前文件：Ctrl + Alt + L（Windows/Linux）。
  • 多行连续选择与对齐（适合临时整理等号、逗号等）：Ctrl + Alt + Shift + J。
  • 打开设置：File → Settings → Editor → Code Style，可按语言（如 PHP）配置缩进、空格、换行等风格。以上快捷键与设置路径适用于 Linux/Debian。

二 配置内置风格以对齐与短数组语法

• 设置 Tab/Space 与缩进：进入 File → Settings → Editor → Code Style → PHP → Tabs and Indents，按需设置 Tab size、Indent、Continuation indent 以及是否 Use tab character。
• 等号与数组键值对对齐：进入 Wrapping and Braces，勾选：
  • Align consecutive assignments（等号对齐）
  • Align key-value pairs（=> 对齐）
• 数组语法与逗号风格：进入 Code Conversion，勾选
  • Force short declaration style（array() 自动转为 []）
  • Add a comma after last element in multiline array（多行数组尾部逗号）
• 作用域选择：在 Scheme 处可选 Default（全局）或 Project（仅当前项目）。以上配置完成后，使用 Ctrl + Alt + L 即可按设定风格格式化。

三 使用 PHP-CS-Fixer 统一团队规范

• 安装与路径
  • 全局安装：在 Debian 终端执行
    • composer global require friendsofphp/php-cs-fixer
    • 将全局 bin 加入 PATH（示例）：echo ‘export PATH=“$HOME/.composer/vendor/bin:$PATH”’ >> ~/.bashrc && source ~/.bashrc
  • 确认可执行文件：which php-cs-fixer（应返回如 ~/.composer/vendor/bin/php-cs-fixer）。
• 在 PhpStorm 中配置外部工具（Tools → External Tools）
  • Name：php-cs-fixer
  • Program：php-cs-fixer
  • Arguments：fix “$FileDir$/$FileName$” --config=$ProjectFileDir$/.php-cs.dist（项目根目录放置 .php-cs.dist；如无则用默认配置）
  • Working directory：$ProjectFileDir$
• 一键调用：Tools → External Tools → php-cs-fixer，或在当前文件/目录上右键执行。以上步骤完成后即可用团队统一的 PHP-CS-Fixer 规则格式化代码。

四 保存时自动格式化与 Git 提交前检查

• 保存时自动执行 php-cs-fixer（File Watchers）
  • 安装 PHP-CS-Fixer（见上），然后在 Settings → Tools → File Watchers 添加自定义 Watcher：
    • Name：php-cs-fixer auto
    • File type：PHP
    • Scope：Project Files
    • Program：php-cs-fixer
    • Arguments：fix “$FileDir$/$FileName$” --config=$ProjectFileDir$/.php-cs.dist
    • Working directory：$ProjectFileDir$
    • Trigger the watcher on：On save
  • 启用后，每次保存文件会自动按 .php-cs.dist 规则修正格式。
• 可选：使用 PHPCS + phpcbf 做检查与自动修复
  • 安装：composer global require squizlabs/php_codesniffer
  • 在 PhpStorm 配置 phpcs/phpcbf 路径（Program 指向可执行文件），Arguments 可使用 –standard=PSR2 $FileDir$/$FileName$，Working directory 为 $ProjectFileDir$；也可为 phpcbf 配置快捷键或在提交前运行以自动修复可修复项。
• Git 提交前强制检查（团队推荐）
  • 使用 GrumPHP 在提交时自动跑 phpcs，不符合规范则阻止提交（示例配置包含 phpcs: standard: PSR2 等）。以上方案可确保提交到仓库的代码始终符合团队规范。