mlc icon indicating copy to clipboard operation
mlc copied to clipboard

Support `ignore` or `disable` lines and blocks in checked files

Open nuke-web3 opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe.

I would like a way to disable or ignore specific parts of flies that otherwise should be link checked. For example, I use some hacks in a project that will eventually be valid links once a static site generator renders it (here).

Describe the solution you'd like

This is a common pattern: have a comment in line or comments around some block to disable for that line/block

  • https://github.com/tcort/markdown-link-check#disable-comments
  • https://prettier.io/docs/en/ignore.html#markdown

Describe alternatives you've considered

I otherwise need to amass a running list of links in the config #65 supports to ignore that gets unwieldy in the case of many links you want to skip (mostly throws 403 or the link as sites block bots...?). Not as bad for me, I have a very specific syntax on internal links that would be broken ( "*slides.*" works to skip the file not the links within it.)

Additional context

I am keen on Markdown support, but a nice-to-have would be this implemented for all langs mlc supports.

nuke-web3 avatar Sep 03 '23 01:09 nuke-web3

Thanks for the feature request. I can see the need for this.

becheran avatar Sep 03 '23 18:09 becheran

Here for a concrete example for a few singleton places where I would like to ignore warnings:

https://github.com/Polkadot-Blockchain-Academy/pba-book/actions/runs/6292457415

And calling out a few directly that I would want to ignore and perhaps one incorrect redirect detected:

FALSE
[Warn] content/substrate/interact/slides.md (250, 1) =>
https://polkadot.js.org/docs/substrate/rpc#getstoragekey-storagekey-at-blockhash-storagedata - Request was redirected to
https://polkadot.js.org/docs/substrate/rpc/


IGNORE
[Warn] content/overview.md (9, 42) =>
https://dot.li/pba-github - Request was redirected to
https://www.polkadot.network/development/academy/?utm_source=github&utm_medium=social&utm_campaign=pba

IGNORE
[Warn] content/README.md (3, 68) =>
https://dot.li/pba-github - Request was redirected to
https://www.polkadot.network/development/academy/?utm_source=github&utm_medium=social&utm_campaign=pba

IGNORE
[Warn] content/README.md (34, 20) =>
https://dot.li/pba-github - Request was redirected to
https://www.polkadot.network/development/academy/?utm_source=github&utm_medium=social&utm_campaign=pba

IGNORE
[Warn] content/blockchain-contracts/bytecode/slides.md (612, 50) =>
https://github.com/riscv/riscv-isa-manual/releases/download/Ratified-IMAFDQC/riscv-spec-20191213.pdf - Request was redirected to
https://objects.githubusercontent.com/github-production-release-asset-2e65be/80689539/a01b5800-1dc9-11ea-9620-b496f77e1471?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIWNJYAX4CSVEH53A%2F20230924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230924T201850Z&X-Amz-Expires=300&X-Amz-Signature=11c60dec5d14f06c9623163362bcd7571799271d9b4616a88255bce3b22062f0&X-Amz-SignedHeaders=host&actor_id=0&key_id=0&repo_id=80689539&response-content-disposition=attachment%3B%20filename%3Driscv-spec-20191213.pdf&response-content-type=application%2Foctet-stream

IGNORE
[Warn] content/substrate/intro/slides.md (1011, 3) =>
https://www.reddit.com/r/rust/comments/5y3cxb/how_many_security_exploits_would_rust_prevent/ - Request was redirected to
https://www.reddit.com/r/rust/comments/5y3cxb/how_many_security_exploits_would_rust_prevent/?rdt=55748

IGNORE
[Warn] content/economics/basics/slides.md:947:3 =>
https://www.nature.com/articles/s41562-021-01070-3 - Request was redirected to
https://www.nature.com/articles/s41562-021-01070-3?error=cookies_not_supported&code=029a70cd-ec0e-4b23-bc1d-9b525d69f2a7

IGNORE
[Warn] content/security/infrastucutre/slides.md (120, 1) =>
https://www.reddit.com/r/hetzner/comments/wucxs4/comment/ilfoj8u/ - Request was redirected to
https://www.reddit.com/r/hetzner/comments/wucxs4/comment/ilfoj8u/?rdt=62331

nuke-web3 avatar Sep 24 '23 21:09 nuke-web3