lemberg/laravel-code-style-command

检查代码风格。

2.0.1 2019-03-14 10:52 UTC

This package is auto-updated.

Last update: 2024-09-15 18:29:33 UTC


README

此软件包在 PHP_CodeSniffer 脚本的基础上添加了简单的 artisan 命令。验证您应用程序中的 PSR2 编码标准。

要求

  • PHP >= 7.0
  • Laravel = 5.5.*|5.8.*

入门指南

在您的 composer.json 中添加此软件包

$ composer require --dev lemberg/laravel-code-style-command

就这样啦 :)

app/ 目录中检查您的代码风格。

$ php artisan code-style

示例输出

FILE: .../bkhrupa/work/lemberg/laravel-code-style-command/app/User.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 8 | ERROR | [x] Opening brace of a class must be on the line after
   |       |     the definition
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

Time: 116ms; Memory: 6Mb

Finished

高级用法

$ php artisan code-style --help

配置文件

发布 code-style.php 配置文件。

$ php artisan vendor:publish --provider="Lemberg\LaravelCsc\LaravelCscServiceProvider"

Git 预提交钩子

使用 git pre-commit 钩子

将以下代码添加到预提交钩子文件 .git/hooks/pre-commit 中。

#!/bin/bash

`php ./artisan code-style --print-command`

pre-commit 钩子必须是可执行的

$ chmod +x .git/hooks/pre-commit

许可证

请参阅 许可证文件 获取更多信息。