Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linkchecker pre-commit hook configuration #772

Open
d33bs opened this issue Nov 4, 2023 · 0 comments
Open

Add linkchecker pre-commit hook configuration #772

d33bs opened this issue Nov 4, 2023 · 0 comments

Comments

@d33bs
Copy link

d33bs commented Nov 4, 2023

Summary

Thanks for the great effort on this project, it's been helpful!

This is a feature request to add a pre-commit hook configuration for linkchecker. Pre-commit provides the capability for custom hooks which may be used by others. Often, projects which provide the capability to perform checks will have a .pre-commit-hooks.yaml file. This provides a certain level of trust and development alignment (see Black's .pre-commit-hooks.yaml as an example).

Steps to develop and use

I think a .pre-commit-hooks.yaml file could be added with something like the following to enable this functionality:

- id: linkchecker
  name: linkchecker
  description: "Check for broken links in web sites."
  entry: linkchecker
  language: python
  # additional defaults?

Usage outside of this for others would entail configuring their .pre-commit-config.yaml with something like:

repos:
  - repo: https://github.com/linkchecker/linkchecker
    rev: vx.x.x
    hooks:
      - id: linkchecker
      # optional config below...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant