目录

  • 写在前面
  • 开始操作
  • 准备
  • 安装
  • vsc内安装php cs fixer和vscode-php-cs-fixer插件
  • composer
  • 安装php cs fixer
  • 配置
  • php cs fixer
  • 配置后问题及解决
  • 成功实现php文档格式化
  • 参考资料


写在前面

  • composer是PHP包、依赖库的安装工具。(就像npm是NodeJS的包管理工具)
  • php-cs-fixer是PHP 编码的格式化工具。
  • 下面的操作都是基于windows

开始操作

准备

  • 下载安装vscode并懂得一些基本操作
  • 下载安装wamp(因为我用的是wamp,如果用的不是wamp,本文仅供参考)
  • 下载composer(参考资料2)下载地址一

安装

vsc内安装php cs fixer和vscode-php-cs-fixer插件

只需要在vsc的插件商店里面搜索安装就好了,他们的使用方法也对应写在里面,在这里我只是记录一下我安装配置时的想法,仅供参考

vscode的hive sql格式化插件 vscode php格式化插件_参考资料

composer

composer的安装和使用建议参考对照-参考资料 2

安装的时候出现的一些问题

  1. 错误提示 php不是内部或者外部命令

    于是我选择重新安装,并修改明确我的php路径,但是这个时候却卡在了安装过程中。

    没有办法,我只能强制结束进程。接着我去检查了一下我的环境变量

    发现并没有php路径,所以我选择重新增加一次,并重启机器。然后在提示符里面再次检查,成功。

    至此,composer安装成功

安装php cs fixer

可以借鉴参考资料3(需要耐心等待)

vscode的hive sql格式化插件 vscode php格式化插件_php_02


vscode的hive sql格式化插件 vscode php格式化插件_composer_03


配置环境变量时需要注意的是appdate文件夹是隐藏文件夹!需要打开查看隐藏文件才可以查看。配置完以后记得重启电脑。

vscode的hive sql格式化插件 vscode php格式化插件_php_04


如果觉得等待时间过长的话可以直接去GitHub上面下载,然后再安装github的文档进行配置

下载php-cs-fixer.phar

配置

php cs fixer

打开vsc,进入文件-首选项-设置 然后选择用户或者工作区。然后在右上角找到一个打开设置,进入setting.json.

vscode的hive sql格式化插件 vscode php格式化插件_php_05


vscode的hive sql格式化插件 vscode php格式化插件_参考资料_06

配置列表(不需要所有的写,只需要配置自己需要的就好了;具体功能vsc插件都有说明,看不懂可以用翻译)(这里的配置不一定正确,还要根据自己的电脑的情况进行修改)

{
    "php-cs-fixer.executablePath": "php-cs-fixer",//由composer安装php-cs-fixer
    //TIP: 尝试使用"php-cs-fixer.bat" on Windows.
    "php-cs-fixer.executablePathWindows": "",   //eg: php-cs-fixer.bat
    "php-cs-fixer.onsave": false,
    "php-cs-fixer.rules": "@PSR2",
    "php-cs-fixer.config": ".php_cs;.php_cs.dist",
    "php-cs-fixer.allowRisky": false,
    "php-cs-fixer.pathMode": "override",
    "php-cs-fixer.exclude": [],
    "php-cs-fixer.autoFixByBracket": true,
    "php-cs-fixer.autoFixBySemicolon": false,
    "php-cs-fixer.formatHtml": false,
    "php-cs-fixer.documentFormattingProvider": true
}

运行一段代码进行尝试,出现问题

配置后问题及解决

PHP CS Fixer: executablePath not found, please check your settings. It will set to built-in php-cs-fixer.phar. Try again!

vscode的hive sql格式化插件 vscode php格式化插件_php_07


配置的过程中,我们并没有正确php-cs-fixer的路径,所以会出现这样的问题。那么接下来我们修改一下配置。(前提是我们安装好了php-cs-fixer)

一般来说只要安装好php-cs-fixer并配置好环境变量就不会出现这样的错误。

成功实现php文档格式化

vscode的hive sql格式化插件 vscode php格式化插件_composer_08

参考资料
  1. Composer下载安装使用
  2. Composer 安装与使用
    https://www.runoob.com/w3cnote/composer-install-and-usage.html
  3. 使用composer安装php-cs-fixer