avirdz/laravel-git-sniffer

此包已被弃用且不再维护。未建议替代包。

一个Artisan命令，通过pre-commit git钩子检查代码规范。

维护者

详情

github.com/avirdz/laravel-git-sniffer

源代码

问题

安装次数: 42 036

依赖者: 0

建议者: 0

安全: 0

星标: 5

关注者: 2

分支: 10

v1.4.0 2019-10-10 22:55 UTC

Requires

MIT 97a4e69787908c869b47e3fa4c1c6aaa9f59652f

  • Jesus Aviles <avirdz.woop@gmail.com>

gitHOOKlaravelphpcscodesnifferpre-commit

This package is auto-updated.

Last update: 2023-09-11 11:48:22 UTC

README

一个Artisan命令，通过pre-commit git钩子检查代码规范

使用composer安装

composer require avirdz/laravel-git-sniffer

将提供者添加到app配置（如果你使用Laravel >= 5.5，则无需执行此操作）

Avirdz\LaravelGitSniffer\GitSnifferServiceProvider

使用Artisan发布配置

php artisan vendor:publish --provider="Avirdz\LaravelGitSniffer\GitSnifferServiceProvider" --tag=config

运行Artisan命令复制pre-commit钩子

php artisan git-sniffer:copy

如果你与其他开发者一起工作，并且希望每次有人克隆并运行composer install时自动复制钩子，只需将复制命令添加到composer scripts中即可，无论如何，它仅在定义的环境中运行，默认为本地环境。

"post-install-cmd": [
    "...laravel commands..."
    "php artisan git-sniffer:copy"
],

配置

键 值 描述
env (string) 默认: local 命令将在其中执行的环境。
phpcs_bin (string) 默认: ./vendor/bin/phpcs Php_CodeSniffer的bin，作为依赖项安装。
standard (string) 默认: PSR2 代码规范
encoding (string) 默认: utf-8 源文件的编码
extensions (array) 默认: php 要检查的有效PHP文件扩展名
phpcs_ignore (array) 默认: ./resources/views/* 默认忽略Blade模板
temp (string) 默认: .tmp_staging 将要复制暂存文件的临时目录
eslint_bin (string) ESLint的bin
eslint_config (string) eslintrc配置文件的路径
eslint_extensions (array) 默认: js 要检查的有效JS文件扩展名
eslint_ignore_path (string) .eslintignore文件的路径。

注意：Eslint默认忽略所有隐藏文件和目录，由于存在临时暂存文件夹且默认为隐藏，因此您需要将其添加到eslintignore文件的第一行。

!.tmp_staging
otherfile.js

如果您留空eslint_bin配置，则会被忽略，同样对于phpcs_bin也是如此，但您至少需要配置其中一个。

资源

这是一个相同的脚本，只是翻译成PHP以与Laravel命令一起使用。

许可

MIT