Hook request: Check for 404 links in README

[pat-s]

I just came across a few dead links in a README and was wondering if this could be catched via pre-commit hook :)

[lorenzwalthert]

Great idea. What’s really awesome about pre-commit is that it supports many languages and it handles all dependencies for supported languages. So my approach would be

• to look for an available hook that does this. I could not find one.
• look for a tool that does this, written in any of the supported languages. I found this one in node: https://github.com/tcort/markdown-link-check and it seems under active development.

We can find instructions here on how to add a hook and potentially also check the existing node repo https://github.com/pre-commit/mirrors-eslint to get a feel for it. Are you interested in contributing?

Unfortunately, multiple files can't be passed to the hook at the same time, but there is an open issue for this: tcort/markdown-link-check#78

[lorenzwalthert]

Try this adding this to your .pre-commit-config.yaml:

    -   repo: https://github.com/lorenzwalthert/precommit-markdown-link-check
        rev: v0.0.0.9002  # Use the sha / tag you want to point at
        hooks:
        -   id: markdown-link-check

See https://github.com/lorenzwalthert/precommit-markdown-link-check. Note that it can only check md or rmd READMEs as of now because of tcort/markdown-link-check#78.

[lorenzwalthert]

Should we close this as resolved? I wonder if we should link the repo elsewhere. Or maybe wait and hope tcort/markdown-link-check#78 gets fixed soon? Because the general use case would be to apply this to all files, also .Rmd files and maybe even .R files. for link checking.

[pat-s]

Sorry, forgot to reply. Didn't I do that somewhere else? Worked for me and I like it a lot!

I think you can def link it even if tcort/markdown-link-check#78 would be a nice addition.

[pat-s]

@lorenzwalthert

The new r-lib/urlchecker could be a great hook :) Takes a while though - maybe in combination with caching?

[lorenzwalthert]

https://github.com/tcort/markdown-link-check works now for multiple inputs and pre-commit support was added there, hence, I suggest that. My repo https://github.com/lorenzwalthert/precommit-markdown-link-check is archived and should not be used anymore.