wowo-zz/php-cc

PHP代码检查工具

维护者

详细信息

github.com/wowo-zZ/php-cc

源代码

问题

安装: 312

依赖: 3

建议者: 0

安全性: 0

星标: 7

关注者: 2

分支: 2

开放问题: 1

类型:实用工具

1.02 2021-03-15 14:27 UTC

This package is auto-updated.

Last update: 2024-09-15 22:42:21 UTC


README

简介

PHP代码检查工具利用git hook、phplint、phpcs,在代码提交时对PHP代码进行语法检测、代码风格检查,发现问题将不允许提交。目前仅支持在Linux类系统上运行。

安装与使用

composer require wowo-zZ/php-cc

安装成功后执行:./vendor/bin/phpcc install 该命令会检查phplint、phpcs的安装情况,并将git原有的pre-commit钩子备份,再将php-cc的pre-commit钩子复制到.git/hooks中。

这样,在git提交之前,就会执行phplint和phpcs检查待提交的文件,如果不满足要求,则会阻止代码提交。

指令

config指令参数

注意事项

  1. 建议使用最新版本,最新版本可以在仓库的tags中查看;
  2. 包已提交到packagist,但国内安装较慢,推荐翻墙安装。

更新日志

  • 1.0: 使用Symfony后重新发布

待办事项列表

  • 支持检测结果处理时的强制模式(不通过无法提交)/人工选择模式(可以选择是否提交)
  • 支持phpcs过滤关键字,为了支持现有项目可能存在某些不便改造的代码风格
  • 支持合并pre-commit中的已有操作
  • 支持设置语言:en & zh-cn
  • 支持Windows

注意事项

phpcc的pre-commit会覆盖原有的pre-commit,但仍然会将它备份为pre-commit.bak.{timestamp}。所以之前在pre-commit中插入操作,请谨慎安装。