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.

Sign up for GitHub

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

Jump to bottom

feature request: check text fragments #1545

Open
SKalt opened this issue Oct 26, 2024 · 5 comments
Open

feature request: check text fragments #1545

SKalt opened this issue Oct 26, 2024 · 5 comments
Labels
enhancement New feature or request

Comments

@SKalt
Copy link

SKalt commented Oct 26, 2024

Text fragments are a standardized way to link to webpage text without relying on HTML ID attributes. They are supported by all modern browsers. I'd like to use lychee to make sure my text fragment links are valid!

Example:

<!-- file.html -->
<html>
  <body>
    <div>
      <a href="https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments#:~:text=without%20relying%20on%20the%20presence%20of%20IDs">
        valid
      </a>
      <a href="https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments#:~:text=asdfawefaweafa">
        invalid
      </a>
    </div>
  </body>
</html>
; lychee --version
# lychee 0.16.1
; lychee -vv --include-fragments ./file.html
#     [200] https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments#:~:text=without%20relying%20on%20the%20presence%20of%20IDs
#     [200] https://developer.mozilla.org/en-US/docs/Web/URI/Fragment/Text_fragments#:~:text=asdfawefaweafa

Desired behavior: if lychee is configured to check fragments and is passed a #:~:text=... fragment, lychee should throw an error if the text is not found within the linked document.
@mre
Copy link
Member

mre commented Oct 26, 2024

@HU90m, this one has your name on it. 😆

@mre mre added the enhancement New feature or request label Oct 28, 2024
@thiru-appitap
Copy link

My (first attempt) implementation of the Text Fragment feature - i had the audacity to include a new flag "include-text-fragments" to explicitly support the fragment directive (aka text fragment) feature.

Contributing Guidelines instruction is followed and cargo clippy & test run were successful.

I've forked the code into my repository since I didn't have permission to create feature branch in the main repository. I am ready to execute a pull-request for review - please let me know!

@HU90m
Copy link
Contributor

HU90m commented Dec 25, 2024

Just took a gander at your changes. The branch definitely looks ready for a PR. I'll have a proper peruse and ask my questions once you have.

Thanks for going through the effort of adding good number of tests!

@HU90m
Copy link
Contributor

HU90m commented Dec 25, 2024

Ah, you already have! Sorry I missed this.

@thiru-appitap
Copy link

I have fixed few lint and clippy issues (missed it in the first couple of commits :-() - do review at your available time and let me know your comments!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@mre @SKalt @HU90m @thiru-appitap