feat: added support for pre-commit

[MattTimms]

Adds support for pre-commit as per discussion #1360

Relies on the docker image releases, & this referenced image tag shouble be incremented with each package release; i.e. updating the entry field in .pre-commit-hooks.yaml.

An example .pre-commit-config.yaml is provided in the changes to the README.

[knightdave]

Hello,
I just was about to create new fork and implement pre-commit hook for my beloved lychee, but I saw this PR.

Do you think it would be beneficial to add 2 types of hooks - system and docker based like in hadolint hooks or kube-linter hooks?

I'm about to implement pre-commit for documentation link checking for quite big project with hundreds of developers and some of environments where they are working don't have access to install docker engine, but they could download binary and put in local user path.

Please consider this in your PR!

[knightdave]

---
- id: lychee-docker
  name: lychee
  description: "Run 'lychee' docker image for fast, async, stream-based link checking"
  entry: lycheeverse/lychee:0.14
  language: docker_image
  args: []
  types: [text]
  pass_filenames: true
  require_serial: true
  additional_dependencies: []
- id: lychee
  name: lychee
  description: "Run 'lychee' for fast, async, stream-based link checking"
  entry: lychee
  language: system
  args: []
  types: [text]
  pass_filenames: true
  require_serial: true

[knightdave]

I rechecked commit and it looks like it could be good to add --no-progress or -n as default argument. Without that it sometimes wait for enter or

Without -n

With -n

[MattTimms]

Good find. I've had a quick look over the other args from --help & seems like --no-progress is the only that makes sense being a default.

[MattTimms]

Yeah, great suggestion @knightdave & I agree. When I was looking into originally, I was focused on getting it running from source rather than a system executable from release, which I reckon the latter is more common. I do like the idea of not requiring docker too.

[knightdave]

Looks perfect! Thank you for adding all suggestions.

[mre]

Thanks for your contribution @MattTimms and for the insights @knightdave. Great team effort!