brainsum/drupal-dev-tools

Drupal 开发工具。

安装次数: 4,128

依赖项: 0

建议者: 0

安全: 0

星星: 5

关注者: 6

分支: 1

开放问题: 5

类型:composer-plugin

5.0.1 2024-05-24 14:24 UTC

This package is auto-updated.

Last update: 2024-09-24 15:08:25 UTC


README

Build Status

关于

包 / 标准化开发工具的 Composer 插件。

设置

准备

如果你已经在项目中有了 grumphp.yml 和/或 phpcs.xml 文件,你应该将它们重命名。例如,mv grumphp.yml grumphp.yml.backup。如果你想逐个添加任务和规则,请查看该包 distfiles 文件夹中的文件。注意:此包不会覆盖现有的文件,但也可能无法与它们一起使用。

安装

在你的项目中,只需使用

composer require --dev brainsum/drupal-dev-tools:^5.0.0

设置

扩展

在你的项目中 grumphp.yml 文件中添加以下内容

imports:
    - { resource: vendor/brainsum/drupal-dev-tools/convention/grumphp.yml }

这将向 grumphp 发送信号,以从该包导入所有内容。

当需要时,您也可以自定义规则

parameters:
    convention.git_commit_message_whitelist: ['/^([A-Z]+-[\d]+ )+\| [A-Za-z\d\s\.]+([^.])+\.{1}$/s']

有关更多信息,请参阅

覆盖

grumphp.ymlphpcs.xml 文件现在应该创建在项目根目录中。它们应该可以正常使用,但你应该查看它们并根据当前项目进行必要的自定义。例如,phpcs.xml 描述、命名、检查文件夹等;grumphp.yml PHP 版本等。

如果由于某种原因它们没有创建,你可以根据需要从 vendor/brainsum/drupal-dev-tools/distfiles 文件夹中的文件复制它们的内 容。

如果你只想使用 grumphp.yml 的一些设置,而不是整个文件,请参阅 convention/grumphp.yml,因为 distfiles/grumphp.yml 只是一个导入文件,不包含其他指令。

GrumPHP

设置

有关预定义设置,请参阅 distfiles/grumphp.ymlconvention/grumphp.yml

注意,我们还在尝试在项目根目录中创建一个 phpcs.xml 文件。该文件的源代码也在 distfiles 文件夹中。