Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Comments to ignore links #1444

Closed
ehmicky opened this issue Jun 14, 2024 · 1 comment
Closed

Comments to ignore links #1444

ehmicky opened this issue Jun 14, 2024 · 1 comment
Labels
question Further information is requested

Comments

@ehmicky
Copy link
Contributor

ehmicky commented Jun 14, 2024

Links can be ignored in many different ways, including with --include, --exclude and .lycheeignore. However, sometimes, it would be nice to ignore only one specific link in a given file.

A common way to do this is often to add a comment like <!-- lychee-disable-next -->, like markdown-link-check does, ESLint, and so on.

One challenge is that those comments would be file format-specific. Other tools often opt to only implement this for Markdown, but there might be some creative solutions to make this format-agnostic.

I checked the issues and I do not think this has been asked before. What are your thoughts on this?

@mre
Copy link
Member

mre commented Jun 14, 2024

As you said, we would need to handle various file formats, making the tool more complex and harder to maintain.
For instance, markdown-link-check also has edge-cases like .mdx support (tcort/markdown-link-check#171) or anchor links (tcort/markdown-link-check#196).

--exclude and .lycheeignore should support that already, no? For example, instead of annotating a link in a file, why not add it to .lycheeignore?

@mre mre added the question Further information is requested label Jun 14, 2024
@lycheeverse lycheeverse locked and limited conversation to collaborators Jun 14, 2024
@mre mre converted this issue into discussion #1447 Jun 14, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants