fix(linkindex): stop trimming leading/trailing hyphens from GithubSlug - #121
Merged
Conversation
Traced the real github-slugger (the package GitHub extracted from its own rendering pipeline) and it trims nothing at all -- not a leading/trailing hyphen from stripped punctuation, and not even literal leading/trailing whitespace. GithubSlug's strings.Trim(s, "-") diverged from that, so a heading like "`--json` output" slugged to "json-output" instead of the "--json-output" GitHub actually assigns, breaking check's anchor matching for README.md's own "#--json-output" links (#120).
This file contains hidden or 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
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.
Summary
GithubSlugtrimmed leading/trailing hyphens withstrings.Trim(s, "-"), but the real github-slugger (the package GitHub itself extracted from its rendering pipeline) trims nothing at all -- not a punctuation-derived hyphen, and not even literal leading/trailing whitespace.GithubSlug("--jsonoutput")returned"json-output", but GitHub's real anchor for that heading is--json-output-- which is exactly what README.md's own[--jsonoutput](#--json-output)links assume, andmarkfluence check README.mdreported both as "anchor not found" until this fix.Test plan
make check(vet, fmt-check, test, build, lint) passesinternal/linkindex/slug_test.gocases to the verified-correct values, including the"---"case the issue flagged as needing re-verificationmarkfluence check README.mdno longer reports "anchor not found" for the#--json-outputlinksFixes #120