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

Make it possible to specify a custom format for reporting broken links #297

Open
gromakovsky opened this issue Feb 4, 2024 · 0 comments

Comments

@gromakovsky
Copy link
Member

Clarification and motivation

xrefcheck is supposed to be used mainly on CI, e. g. GitHub Actions.
GitHub Actions has a special syntax for emitting warnings. AFAIU, it may look like this (image from the internet):
image

I think it would be neat to report broken links in such a way. And probably the best approach is to make xrefcheck accept some specification of a format in which it will report broken links.

Acceptance criteria

The user can run xrefcheck in such a way that it will report broken links in a user-defined format.
This format should be a function that takes:

  • file name
  • position in the file
  • a message like Resource unavailable (404 Not Found)
  • a link being checked
  • maybe something else

and returns formatted text to be printed instead of the default message.

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