vscode配置PHP代码检查和格式化工具PHP Sniffer & Beautifier

这里介绍的是在 vscode 中配置插件 PHP Sniffer & Beautifier ,达到代码质量管理,包括代码检查和格式化的使用。

如果你使用的 IDEphpstorm ,查看这篇文章:phpstorm 配置使用代码质量工具PHP CodeSniffer

在计算机上安装php_codesniffer包

在计算机某个目录(假设目录为/tool_path)中使用 composer 安装需要的 php_codesniffer 包。

composer require squizlabs/php_codesniffer

安装插件PHP Sniffer & Beautifier

在插件中搜索 PHP Sniffer & Beautifier 安装启用即可。

在setting.json中添加配置:

    "phpsab.executablePathCBF": "/tool_path/vendor/bin/phpcbf",
    "phpsab.executablePathCS": "/tool_path/vendor/bin/phpcs",
    "phpsab.fixerEnable": true,
    "phpsab.snifferShowSources": true,
    "phpsab.standard": "PSR2",
    "[php]": {
        "editor.defaultFormatter": "valeryanm.vscode-phpsab"
    },
    "phpsab.debug": true,

其中的 phpsab.executablePathCBFphpsab.executablePathCS 指向的目录就是你安装 squizlabs/php_codesniffer 的目录下的执行文件,如果是 windows 系统,应该是类似 D:\\tool_path\\vendor\\bin\\phpcbf.batD:\\tool_path\\vendor\\bin\\phpcs.bat 的文件。

重启后,如果代码有格式不正确跟配置的标准(这里配置的是PSR2)格式不符,则会出现波浪线提示。

一键fix/format格式化代码

  1. ctrl + shift + P 选择命令 PHPCBF: Fix this file
  2. 快捷键 alt + shift + F
  3. 在编辑区右键选择 Format Document

如果安装了 PHP Intelephense 插件,可能导致格式化不生效,右键 Format Document With 然后选择 PHP Sniffer & Beautifier 并将其设置为默认格式化工具即可。

标题:vscode配置PHP代码检查和格式化工具PHP Sniffer & Beautifier

原文链接:https://beltxman.com/4055.html

若无特殊说明本站内容为 行星带 原创,未经同意请勿转载。

发表评论

您的电子邮箱地址不会被公开。

Scroll to top