Fix metadata attribute

[tom-combet]

Q	A
Version	1.5.0
Bug?	no
New feature?	yes
Question?	no
Documentation?	no
Related tickets	none

It could be great to add a fix metadata attribute to any task, or at least a fix attribute for shell task.
GrumPHP would use it to autofix the code, as with PHP-CS-Fixer:

[veewee]

Hello,

I'm not sure how that fix metadata attribute should work?
Most of the commands are built internally and most don't have no fix command.

You might indeed want to add a fixer for a shell task.
However, it is possible to define multiple shell tasks at once.
So I don't think it is possible to do a fix parameter for shell commands either:
https://github.com/phpro/grumphp/blob/master/doc/tasks/shell.md

Can you give me a more concrete example of what you are trying to achieve?
Maybe a custom or extending task might be a better solution for your case?

[tom-combet]

Hi,

Thanks for your fast response!
So to be very precise, I added a shell task to add license headers to my files automatically, which comes from this repository. As many "code check" commands, there is a --dry-run option and I'm using it.
But then, I'd like that GrumPHP fixes it if I answer positively to "autofix" prompt (screenshot above). So in my case, it would run the same command without --dry-run.

Of course, it won't (and couldn't) be automatic. It would just be a "scripts-like" attribute, it would just execute the given scripts/commands. I see it like this:

# grumphp.yml
grumphp:
    tasks:
        shell:
            scripts: []
            triggered_by: [php]
            fix: []

So for my usecase:

# grumphp.yml
grumphp:
    tasks:
      header-stamp:
        metadata:
          task: shell
        scripts:
          - [
              "-c",
              'vendor/bin/header-stamp --dry-run 
              --extensions="php,js,css,scss,tpl,html.twig,vue" --exclude="config,var,vendor" --license="_dev/header-stamp/afl.txt"',
            ]
        fix:
          - [
              "-c",
              'vendor/bin/header-stamp
              --extensions="php,js,css,scss,tpl,html.twig,vue" --exclude="config,var,vendor" --license="_dev/header-stamp/afl.txt"',
            ]

In fact, I could do a custom task (I did a composer script atm), but it makes more sense to me to have it built into the dedicated autofix tool.

[veewee]

In this specific case, I would say that adding a custom task for this specific executable makes far more sense to me.

[tom-combet]

Hmm, if you say so...
In this case, the fix command (vendor/bin/header-stamp) is directly related to the check command (vendor/bin/header-stamp --dry-run), so creating a new task looks like a workaround to me. Furthermore, it has an inconvenient: I may want to not run the fix task sometimes. If I add a new task, it will run everytime without asking, wouldn't it?
Finally, this case isn't so specific: many tools provide a --dry-run option.

Thanks anyway for your consideration!

[veewee]

Adding it as a shell command is the workaround actually.

By adding it as a real task, you can provide the configuration though the GrumPHP configuration file.
That makes it all more flexible in how you want to run things.

The task itself can return a fixable result. That way the end user can always choose to run it or not.

[tom-combet]

Oh, wow, sorry for this misunderstanding!
I thought you told me to add a new SHELL task in the grumphp.yml and not writing a brand new PHP CUSTOM task.
You're right, I totally forgot I could do that. It would have been a bit faster with fix shell attribute but it will be indeed cleaner with a dedicated task.
Thanks for this awesome tool btw, I use it in all my PHP projects!