brainsum/drupal-dev-tools

Dev tools for Drupal development.

4.5 2024-02-27 21:34 UTC

Requires

• php: >=8.1
• composer-plugin-api: ^1.1 || ^2
• drupal-composer/drupal-security-advisories: 9.x-dev
• drupal/core-dev: ^10.0.0
• drupal/devel: ^5.0
• ergebnis/composer-normalize: ^2.28
• friendsoftwig/twigcs: ^6.2
• laravel/serializable-closure: ^1.3
• metadrop/grumphp-drupal-check: ^0.4.0
• php-parallel-lint/php-parallel-lint: ^1.3
• roave/security-advisories: dev-latest
• sebastian/phpcpd: ^6.0

Suggests

• drupal/examples: ^4.0

gpl-3.0-or-later

• szato

README

About

Package / Composer plugin for standardizing development tools.

Setup

Preparation

If you already have a grumphp.yml and/or phpcs.xml file in your project, you should rename them. E.g. mv grumphp.yml grumphp.yml.backup If you want to add new tasks and rules on a case-by-case basis, check the files in the distfiles folder of this package. Note: This package is not going to overwrite existing ones, but it might not work with them either.

Installation

In your project, simply use

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

Settings

Extend

In the grumphp.yml file in your project, add the following:

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

This will signal grumphp to import everything from this package.

You can customize the rules when needed, too:

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

For more information, see:

• GrumPHP Conventions

Override

The files grumphp.yml and phpcs.xml should now be created in your project root. They should be good to go, but you should take a look at them and customize them for the current project as necessary. E.g, phpcs.xml descriptions, namings, checked folders, etc.; grumphp.yml php version, etc.

If they, for some reason, don't get created, you can copy their contents from the files from vendor/brainsum/drupal-dev-tools/distfiles as needed.

If you just want to use some settings from grumphp.yml, not the whole thing, see convention/grumphp.yml, as distfiles/grumphp.yml is only an import file and doesn't contain any other directives.

GrumPHP

Settings

For the pre-defined settings see distfiles/grumphp.yml and convention/grumphp.yml.

Note, we are also trying to create a phpcs.xml file in the project root. The source for that file is also in the distfiles folder.