linkorb/conventions-checker

自动检查 LinkORB 规范的试点项目

维护者

详细信息

github.com/linkorb/conventions-checker

源代码

问题

安装: 917

依赖项: 5

建议者: 0

安全: 0

星标: 4

关注者: 7

分支: 2

公开问题: 0

v1.2.0 2019-12-20 06:20 UTC

Requires

MIT 14f3e7b0842b68c634f0fc082c6e51a59c7c6ece

  • LinkORB Engineering Team <engineering.woop@linkorb.com>
  • Igor Mukhin <igor.mukhin.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-20 16:44:03 UTC

README

在每个提交时自动执行规范检查。

安装

1. 将路径添加到 grumphp 配置文件，在你的 composer.json's extra

对于应用程序项目

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/linkorb/conventions-checker/config/app/grumphp.yml"
        }
    }

对于库项目

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/linkorb/conventions-checker/config/lib/grumphp.yml"
        }
    }

2. 在你的 composer.json 中添加检查器

composer require --dev linkorb/conventions-checker

用法

只需提交一些更改，如果你不遵循 规范，你将看到警告。

待办事项

  • 通过 composer.json 的 type ("应用程序" 或默认 "库") 自动定义项目类型并更新 composer.json 的 extra
  • 品牌 ASCII
  • 可能将其作为单独的 linkorb-checker.phar 分发