Add .pre-commit-hooks.yaml

[rkm]

Hi! pre-commit now supports the dotnet language natively, which is stable as of v2.9.0. This PR adds a .pre-commit-hooks.yaml file so that dotnet format can be easily integrated into the workflows of developers who use pre-commit.

A sample .pre-commit-config.yaml to use this hook would then look like:

repos: - repo: https://github.com/dotnet/format rev: "v4.0.130203" # Or a more recent commit sha hooks: - id: dotnet-format args: [--include]

I'm not sure how best to document this. Many maintainers add a section in their project README which provides a sample hook like the one above. I see from #692 that there are already some notes in the docs/integrations.md file, which I could add this to instead?

Closes #692

[chriselion]

Do you need to worry about #699 for large projects?

I added pre-commit support for my team's repo a few months ago (before pre-commit supported dotnet natively), and wrote the files names to a temp file before passing to dotnet-format just to be on the safe side.

[jmarolf]

Thanks for this @rkm! In order to merge this we will need to update the integrations.md file to talk about how you set this up. I'll review the pre-commit hook format so I can review this as best I can.

NOTE: dotnet-format supports both C# and Visual Basic so I think the language parameter should reflect that but I will need to do more research.

[chriselion]

The language field tells pre-commit what language to execute in, so I think that needs to stay as it is. But if you wanted to support Visual Basic file extensions, you could change the types to types_or and add the extension there.

[chriselion]

@jmarolf Sorry for the bump, but any update on this?

[jmarolf]

To merge this we need integrations.md to be updated to describe how someone consumed pre-commit hooks

[chriselion]

Ah sorry, that was a misunderstanding on my part; I interpreted

In order to merge this we will need to update the integrations.md file to talk about how you set this up

to mean that you or the other maintainers would update integrations.md. I'll see if I can push to this branch (or make another PR against it)

[dnfadmin]

All CLA requirements met.

[chriselion]

@jmarolf - I updated integrations.md, and also changed the file types so that Visual Basic files will be checked too.

[JoeRobich]

Thanks for contributing this!

[chriselion]

Thanks @JoeRobich! Any chance you'll be doing a release that includes this change anytime soon? I can update the integrations.md with a specific tag once it exists.