brainsum / drupal-dev-tools
Drupal 开发工具。
Requires
- php: >=8.1
- composer-plugin-api: ^1.1 || ^2
- drupal/core-dev: ^10.0.0
- drupal/devel: ^5.0
- ergebnis/composer-normalize: ^2.28
- friendsoftwig/twigcs: ^6.2
- johnatas-x/grumphp-drupal-check: ^2.2
- laravel/serializable-closure: ^1.3
- mxr576/ddqg: dev-no-insecure-versions
- mxr576/ddqg-composer-audit: ^1.2
- php-parallel-lint/php-parallel-lint: ^1.3
- roave/security-advisories: dev-latest
- sebastian/phpcpd: ^6.0
Suggests
- drupal/examples: ^4.0
README
关于
包 / 标准化开发工具的 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.yml
和 phpcs.xml
文件现在应该创建在项目根目录中。它们应该可以正常使用,但你应该查看它们并根据当前项目进行必要的自定义。例如,phpcs.xml 描述、命名、检查文件夹等;grumphp.yml PHP 版本等。
如果由于某种原因它们没有创建,你可以根据需要从 vendor/brainsum/drupal-dev-tools/distfiles
文件夹中的文件复制它们的内 容。
如果你只想使用 grumphp.yml
的一些设置,而不是整个文件,请参阅 convention/grumphp.yml
,因为 distfiles/grumphp.yml
只是一个导入文件,不包含其他指令。
GrumPHP
设置
有关预定义设置,请参阅 distfiles/grumphp.yml
和 convention/grumphp.yml
。
注意,我们还在尝试在项目根目录中创建一个 phpcs.xml
文件。该文件的源代码也在 distfiles
文件夹中。