README

Angry bearded

This tool is a pre-configured GrumPHP for Drupal 10 projects.

The rules are voluntarily hard, don't hesitate to adapt the .dist files to your needs.

.editorconfig file and a Qodana template are included too.

Installation

When using drupal/core-composer-scaffold (recommended)

In most cases, you would already be using the drupal/core-composer-scaffold package if you have set up using the latest Drupal templates. This package uses core-composer-scaffold to set up configuration files in your project. To make this work, add this package name in your composer's extra.drupal-scaffold.allowed-packages section.

 "name": "my/project",
  ...
  "extra": {
    "drupal-scaffold": {
      "allowed-packages": [
        "johnatas-x/angry-bearded"
      ],
      ...
    }
  }

Now, run composer require to include the package in your application. Since the package is now allowed, the core-composer-scaffold package will copy the configuration files.

See More about scaffolding for more details.

Without drupal/core-composer-scaffold

If you're not using the scaffolding plugin, the package won't copy the configuration files as expected.

First, run composer require to include the package in your application.

composer require --dev johnatas-x/angry-bearded

If you don't already have a grumphp.yml file in your project, GrumPHP would ask you to create one. Answer "No" to the prompt.

Then, copy all the *.dist from the library to your project root. The files copied are:

.editorconfig.dist
grumphp.yml.dist
phpcs.xml.dist
phpmd.xml.dist
phpstan.neon.dist
phpstan-drupal.neon.dist
qodana.yaml.dist

cp vendor/johnatas-x/angry-bearded/*.dist .

Usage

No additional steps required, but if git hooks aren't fired, run php ./vendor/bin/grumphp git:init. For additional commands, look at grumhp's documentation.

Customising

Almost all customising begins with first copying the grumphp.yml.dist file to your project. Make sure you have the file.
⚠️ If some phpstan exceptions do not apply to your project, comment out the lines otherwise an error will be raised.
By default, Drupal logo is used on success output, you can use GrumPHP's logo modifying ascii in grumphp.yml

Adding tasks

There are various tasks you can add and customise in your grumphp.yml. Read the online documentation for GrumPHP tasks to see the tasks you can use and configure.

Forcing commit message format

To configure commit message structure, use the git_commit_message task. For example, to enforce the commit message contains the Jira issue ID, use the rule as the following snippet. More options are documented online.

# grumphp.yml
grumphp:
  tasks:
    git_commit_message:
      matchers:
        Must contain issue number: /YouTrack #\d+/

Disable commit banners

GrumPHP supports banners to celebrate (or scold) on your commit. This is fun but it is possible it gets on your nerves. If you don’t want it, edit the grumphp.yml file and replace the following parameters:

# grumphp.yml
grumphp:
    ascii: ~

You could even disable specific ones like this:

# grumphp.yml
grumphp:
    ascii:
        succeeded: ~

More about scaffolding

As described before, this package uses drupal/core-composer-scaffold plugin to scaffold a few files to the project root. This is not required but there is a good chance you are already using it if you're building a Drupal site.

The scaffolding operation runs with every composer operation and overwrites files. Only the file grumphp.yml.dist is not overwritten during subsequent operations. If you are customising any of the other configuration files and don't want the updates to overwrite your changes, you can override the behaviour in your composer.json file. For example, to skip phpmd.xml.dist from being overwritten, add this to your composer.json:

  "name": "my/project",
  ...
  "extra": {
    "drupal-scaffold": {
      "file-mapping": {
        "[project-root]/phpmd.xml.dist": false
      }
    }
  }

For more details, read the "Excluding Scaffold files" section of the documentation for the core-composer-scaffold plugin.

johnatas-x / angry-bearded

Maintainers

Details