枯痕个人博客
立即登录 马上注册
当前位置: 大后端 > PhpStorm 使用 PHPCS 检查代码规范及自动修正和Git提交检查

在团队开发中,每个人的代码风格都不一样,为了日后方便更新和维护,必须考虑协作和编码规范。

本文就介绍如何在 PhpStorm 中配置 PSR2 代码规范检查和保存自动格式化修复,以及利用 Git Hook 对提交的代码进行检查。

正文

安装PHP-CS

composer global require "squizlabs/php_codesniffer=*"

安装完成后会在全局依赖包目录生成 phpcbf 和 phpcs 文件

查看 composer 全局依赖包路径,下面会用到

composer global config bin-dir --absolute

配置 PhpStorm 使用 PSR-2 标准

1. 代码风格

2. 设置 PHP-CS 路径

3. 代码检查

如果没有下拉选项,可以点击旁边的刷新按钮

还有这个

配置到这里后,打开一个 PHP 文件,就会在不符合 PSR-2 的代码下边加一条波浪线

使用

1
Ctrl + Alt + L
将会自动格式化成 PSR-2 的风格

集成 PHP-CS

经过上面的操作,Phpstorm 代码格式化的规则基本与 PHP-CS 的规则基本一致了,但也有一小部分不一致,所以后面还要用到 phpcs 和 phpcbf

参数说明

Program:

1
phpcs/phpcbf
路径

Arguments:

--standard=PSR2 $FileDir$/$FileName$ ## 当前文件
--standard=PSR2 $FileDir$ ## 当前文件夹

Working directory:

1
$ProjectFileDir$

使用方法

配置保存自动格式化和修复

1. 为 phpcbf 添加快捷键

2. 录制宏

步骤:

Ctrl + Alt + L
Ctrl + Alt + Shift + P
Ctrl + S

3. 为宏配置快捷键

先删除默认的保存快捷键

1
Ctrl + S
,另外配置一个别的快捷键
1
Ctrl + Alt + Shift + S

为宏配置快捷键

利用 Git Hook 对提交的代码进行检查

安装 GrumPHP

composer require --dev phpro/grumphp

安装完后会自动生成一个

1
grumphp.yml

请修改成:

parameters:
  git_dir: .
  bin_dir: vendor/bin
  tasks:
    phpcs:
      standard: PSR2
      ignore_patterns:
        - ./database/*
        - ./vendor/*

这样

1
git commit
的时候就会对提交的代码进行检查,只有符合 PSR-2 规范的代码才能通过。

原文链接:https://cloud.tencent.com/developer/article/1509643

「梦想一旦被付诸行动,就会变得神圣,如果觉得我的文章对您有用,请帮助本站成长」

赞(0) 打赏
欢迎打赏您的小可爱~~~~

支付宝扫一扫打赏

微信扫一扫打赏

上一篇:

下一篇:

相关推荐

0 条评论关于"PhpStorm 使用 PHPCS 检查代码规范及自动修正和Git提交检查"

最新评论

    暂无留言哦~~

博客简介

枯痕个人博客: xiaole.biz,一个关注Web后端开发技术、关注用户体验、坚持更多原创实战教程的个人网站,愿景:成为宇宙中最具有代表性的后端博客,期待您的参与。

精彩评论

友情链接

他们同样是一群网虫,却不是每天泡在网上游走在淘宝和网游之间、刷着本来就快要透支的信用卡。他们或许没有踏出国门一步,但同学却不局限在一国一校,而是遍及全球!申请交换友链

站点统计

  • 文章总数: 105 篇
  • 草稿数目: 1 篇
  • 分类数目: 26 个
  • 独立页面: 4 个
  • 评论总数: 9 条
  • 链接总数: 5 个
  • 标签总数: 169 个
  • 注册用户: 8 人
  • 访问总量: 8,756,204 次
  • 最近更新: 2021年7月23日
服务热线:
 156144**650

 QQ在线交流

 旺旺在线