Add Mago as task

[yannicka]

Mago is a new linter/analyzer for PHP: https://github.com/carthage-software/mago, as PHPStan. It would be good for it to work with GrumPHP.

[veewee]

I'dd surely accept a PR for that!

[johnatas-x]

Hey,

I opened a PR on this topic: #1216
I’m not sure this is the best approach, but I decided to group all Mago commands into a single task.

It is possible to configure which command(s) should run, as well as the options for each command.
I did not make the arguments (paths) configurable, as I believe it is better to manage them directly in mago.toml.

By default, the formatter, linter, and analyzer are enabled with the --staged option (which seems most appropriate in a GrumPHP pre-commit context). The guard is disabled.

I tested this in a Drupal context by running the task twice: once in pre-commit (with priority 1 to run the formatter before other tasks), and once in CI. To enable one or the other, I use a variable on the enabled metadata.

Example of my Mago configuration:

parameters:
  env(IS_DDEV_PROJECT): 'false'
  env(IS_MR_PIPELINE): 'false'
grumphp:
  tasks:
    mago:
      formatter: true
      formatter_options: ['--staged']
      linter: false
      linter_options: []
      analyzer: false
      analyzer_options: []
      guard: true
      guard_options: []
      metadata:
        blocking: true
        enabled: '%env(bool:IS_DDEV_PROJECT)%'
        label: null
        priority: 1
        task: null
    mago_ci:
      formatter: true
      formatter_options: [ '--check' ]
      linter: false
      linter_options: []
      analyzer: false
      analyzer_options: []
      guard: true
      guard_options: []
      metadata:
        blocking: true
        enabled: '%env(bool:IS_MR_PIPELINE)%'
        label: null
        priority: 0
        task: mago

What do you think about this first version? I still have a few open questions:

• Is a single task with the 4 commands better than having 4 separate tasks with one command each?
• Should we add a parameter to control the execution order of the commands?
• Considering Mago’s advanced config file discovery, do you think there is value in making the config file path configurable, for more exotic setups?

[johnatas-x]

The PR has been updated 😉