kunstmaan/code-quality-config

为Kunstmaan项目提供的默认代码质量配置文件。

维护者

详情

github.com/Kunstmaan/code-quality-config

源代码

问题

安装数: 4,528

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 8

分支: 0

开放性问题: 0

类型：composer-plugin

0.6.1 2021-12-21 10:33 UTC

Requires

Requires (Dev)

MIT 1e51dab05bb00b68d49a8165e0fc3be2037d8ea7

  • Jeroen Thora <jeroen.thora.woop@kunstmaan.be>

This package is auto-updated.

Last update: 2024-09-21 16:53:59 UTC

README

为Kunstmaan项目提供的默认代码质量配置文件。

安装

$ composer require --dev kunstmaan/code-quality-config

使用

在安装过程中，该软件包将复制代码质量配置文件。

Php-cs-fixer

该软件包将生成一个默认配置文件，该文件适用于我们大多数项目。

.php_cs

<?php
require 'vendor/autoload.php';

return Kunstmaan\CodeQuality\PhpCsFixer\Config::fromFolders('src');

您也可以通过这种方式覆盖项目级别的规则，而不覆盖核心规则

<?php
require 'vendor/autoload.php';

return Kunstmaan\CodeQuality\PhpCsFixer\Config::fromFolders(['src'])->mergeRules([
   'php_unit_strict' => false,
]);

Grumphp

grumphp.yml

imports:
    - { resource: vendor/kunstmaan/code-quality-config/base-grumphp.yml }

parameters:
    convention.git_commit_message_matchers: { 'Must contain JIRA issue number': '/(^JIRA-\d+:|^\[no\-issue\]) [A-Z].+/' } #TODO: replace jira key or leave this parameter empty ([])

默认情况下，我们设置了提交消息匹配器，因此它必须包含一个jira问题编号。安装后，您应将此正则表达式更新为您的项目密钥。或者，将参数替换为空数组（[]）以禁用此检查。