Make rel links checker more precise. #85
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The predicate used to detect a link pointing to "foo" where the actual page is at "foo/index.md" was too narrow and prevented to link to other filetypes such as .csv. It nows check if the linked file has an extension rather than this extension just being ".md", which enables to link to CSV files for example.
vrto
reviewed
May 30, 2022
| if isPathOnly && u.Path != "" && !strings.HasSuffix(u.Path, ".md") { | ||
| // Require that relative paths link to the actual .md file, i.e not the the "foo" folder in the case of | ||
| // of "foo/index.md", so that browsing docs on the file system works. | ||
| if isPathOnly && u.Path != "" && filepath.Ext(u.Path) == "" { |
There was a problem hiding this comment.
Do we have unit tests for these checks or not?
I think filepath.Ext(u.Path) == "" should be filepath.Ext(u.Path) != ""
There was a problem hiding this comment.
@vrto that would break the predicate, what we want to catch here are links to "foo" which works because the page is an "index.md". So we only want to focus on paths where we don't have any extension at all.
There was a problem hiding this comment.
Ah, this was building a problem case, sorry I misread. All good!
burmudar
reviewed
May 30, 2022
burmudar
approved these changes
May 30, 2022
Co-authored-by: William Bezuidenhout <william.bezuidenhout+github@gmail.com>
vrto
approved these changes
May 30, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The predicate used to detect a link pointing to "foo" where the actual
page is at "foo/index.md" was too narrow and prevented to link to other
filetypes such as .csv.
It nows check if the linked file has an extension rather than this
extension just being ".md", which enables to link to CSV files for
example.
Test plan