[Feature request] Add a flag to the CLI that would commit and add the hash to a .git-blame-ignore-revs file

[baronfel]

I propose we add a command to the CLI to make hiding purely-formatting commits easier. Formatting commits can clutter history, but are necessary to the maintenance of consistent style, so a tool that made it easier to keep code and history clean would be very useful. I saw this in a discussion of scala steward, a Scala formatting tool, and thought it was a very nifty idea.

The existing way of Fantomas deals with this problem is to leave it to the user to commit and add the commit SHA to .git-blame-ignore-revs.

Pros and Cons

The advantages of making this adjustment to Fantomas are a nicer user experience in tools that support hiding formatting commits.

The disadvantages of making this adjustment to Fantomas are increased scope and complexity, and moving the tool into a space it doesn't 100% sit in at the moment - Fantomas doesn't make commits, it just makes changes that you can then put into commits.

Extra information

Estimated cost (XS, S, M, L, XL, XXL): M

Affidavit (please submit!)

Please tick this by placing a cross in the box:

• I have read the Contribution Guidelines.
• I have searched both open and closed suggestions on this site and believe this is not a duplicate

Please tick all that apply:

• This is not a breaking change to Fantomas
• I or my company would be willing to help implement and/or test this
• This suggestion is part of the Microsoft style guide (please add a link to section if so)
• This suggestion is part of the G-Research style guide (please add a link to section if so)

[nojaf]

Hello, as always thank you for your continued interest in this project!
I'm not quite sure about this one. I agree with the pros and cons, it could be a useful addition though it is outside our ballpark.

This would need to be a 5.1 feature if we agree to have this. Since the beta of 5.0 will still be around for some more time, it gives us some space to think about it.

One thing we could do, to start out is providing some bash or pwsh examples of how people could do this outside of Fantomas. Seems like a one-time setup in a $profile until we figure out there is more interest for this.