推荐一款 phpcs 插件规范 Laravel 代码 (规范从本地写代码到版本控制）

2022-03-05 07:25:25

我相信每个公司都有一套完备的代码规范标准，但标准是标准，如何能有效的让所有人遵守，那就要工具的辅助和实时提醒了。

如前端 vue 的大家基本都会使用 eslint 来约束我们的代码，一旦多一个空格都会提示你有问题，当 npm run dev 或者 npm run watch 就会提示你哪哪哪不符合规范。

在 Laravel 开发中，照样也有类似的工具，这也是本文的所要推荐的：

phpcs

在开始使用 phpcs 之前，我们简单来说说 Laravel 的代码规范标准

Laravel 代码规范

Laravel follows the PSR-2 coding standard and the PSR-4 autoloading standard.

来自 Laravel 的说明：https://laravel.com/

几个代码规范的含义

其实现在很多网站已经挂出 PSR-2 编码规范的说明了，推荐看下面这个：

https://laravel-china.org/docs/psr/psr-2-coding-style-guide/1606

但我在实际使用时，除了能够按照上面说的规范来，还有一块重要的内容他们没提。

文件和类注释 

主要包含以上内容块：文件说明、PHP 版本号、还有就是按顺序的这五要素：(category, package, author, license, link)，而且这五要素排版要对齐哦，一般人我不告诉哦~~~

方法注释 

主要包含：方法说明、空一行、参数块 (类型、参数名、含义 —— 这个需要对齐)、空一行、最后

return 类型。

安装 phpcs

使用 phpcs 之前，还是需要先知道这个东西是什么吧？

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

摘自：https://github.com/squizlabs/PHP_CodeSniffer

主要包含两个工具：phpcs 和 phpcbf (这个之后再说)。phpcs 主要对 PHP、JavaScript、CSS 文件定义了一系列代码规范标准，如我们会使用的，也是 Laravel 使用的PHP PSR-2 标准，能够检测出不符合我们定义的代码规范的代码，并发出警告和错误，当然我们也可以设置报错的级别。

对于 phpcs 的使用，主要有两个途径：

1、在本地开发过程中，实时对我们的代码进行检测，让代码提交版本库时，就已经符合规范标准了；

2、在服务器对提交的代码进行检测，如果不符合标准的，则不入代码库，打回要求修改。

下面我们开始说说根据不同方法，如何安装 phpcs 工具的。

composer

写 Laravel 代码的同学，对使用 composer 应该很熟悉了，这种方法比较推崇。但主要区分为是「全局安装」还是按「项目安装」。

这里我本人推荐采用「全局安装」，可以在各个 IDE 上直接填入全局安装的 phpcs 可执行路径。但如果你的版本库是使用「git」的话，那我推荐使用「项目安装」，下文就知道原因了。

注：我使用这种方式「全局安装」后，发现每回都关联不了「VSCode」，这个原因待查。