git.iko.soy/typeable/remark-validate-links
on main help sign in
Add support for anchors to top of doc

Closes GH-48. Reviewed-by: Titus Wormer <tituswormer@gmail.com>

commit46af9ebace45bf97d828278dd2df75e9b6b7b99b authorFlorian Reuschel <Florian.Reuschel@gmx.de> dateThu 12 Dec 2019, 22:31 (7 years ago) parent13a54a5
5 files changed+28−3
compare with main
unifiedsplit
lib/find/config.js+12−1 lib/find/find.js+6−1 test/fixtures/github.md+4 test/fixtures/gitlab.md+4 test/index.js+2−1
lib/find/config.js+12−1
@@ -6,6 +6,7 @@ module.exports = config
66
77var viewPaths = {github: 'blob', gitlab: 'blob', bitbucket: 'src'}
88var headingPrefixes = {github: '#', gitlab: '#', bitbucket: '#markdown-header-'}
9+var topAnchors = {github: '#readme', gitlab: '#readme'}
910var lineLinks = {github: true, gitlab: true}
1011
1112function config(ctx) {
@@ -17,7 +18,13 @@ function config(ctx) {
1718 return
1819 }
1920
20− urlConfig = {prefix: '', headingPrefix: '#', lines: false, hostname: null}
21+ urlConfig = {
22+ prefix: '',
23+ headingPrefix: '#',
24+ lines: false,
25+ hostname: null,
26+ topAnchor: null
27+ }
2128
2229 if (repo) {
2330 info = hostedGitInfo.fromUrl(repo)
@@ -36,6 +43,10 @@ function config(ctx) {
3643 urlConfig.lines = lineLinks[info.type]
3744 }
3845
46+ if (info.type in topAnchors) {
47+ urlConfig.topAnchor = topAnchors[info.type]
48+ }
49+
3950 urlConfig.hostname = info.domain
4051 }
4152
lib/find/find.js+6−1
@@ -167,6 +167,7 @@ function normalize(url, config) {
167167 var numberSignIndex = url.indexOf(numberSign)
168168 var lines = config.lines
169169 var prefix = config.headingPrefix
170+ var topAnchor = config.topAnchor
170171 var filePath
171172 var hash
172173
@@ -176,9 +177,13 @@ function normalize(url, config) {
176177 filePath = url.slice(0, numberSignIndex)
177178 hash = url.slice(numberSignIndex).toLowerCase()
178179
180+ // Ignore the hash if it references the top anchor of the environment
181+ if (topAnchor && hash === topAnchor) {
182+ hash = undefined
183+ }
179184 // Ignore the hash if it references lines in a file or doesn’t start
180185 // with a heading prefix.
181− if (
186+ else if (
182187 (lines && lineExpression.test(hash)) ||
183188 hash.slice(0, prefix.length) !== prefix
184189 ) {
test/fixtures/github.md+4
@@ -65,3 +65,7 @@ Valid: [b](http://example.com).
6565Valid: [b](http://example.com/foo/bar/baz).
6666
6767Valid: [b](http://bitbucket.com/wooorm/test/blob/foo-bar/examples/world.md#hello).
68+
69+## Top Anchor
70+
71+This links to the start of the document [link](#readme).
test/fixtures/gitlab.md+4
@@ -61,3 +61,7 @@ Valid: [b](http://example.com).
6161Valid: [b](http://example.com/foo/bar/baz).
6262
6363Valid: [b](http://bitbucket.com/wooorm/test/blob/foo-bar/examples/world.md#hello).
64+
65+## Top Anchor
66+
67+This links to the start of the document [link](#readme).
test/index.js+2−1
@@ -663,8 +663,9 @@ test('remark-validate-links', function(t) {
663663 ' 49:10-49:40 warning Link to unknown heading in `examples/world.md`: `hello` missing-heading-in-file remark-validate-links',
664664 ' 51:10-51:38 warning Link to unknown file: `examples/world.md` missing-file remark-validate-links',
665665 ' 51:10-51:38 warning Link to unknown heading in `examples/world.md`: `hello` missing-heading-in-file remark-validate-links',
666+ ' 71:41-71:56 warning Link to unknown heading: `readme` missing-heading remark-validate-links',
666667 '',
667− '⚠ 14 warnings'
668+ '⚠ 15 warnings'
668669 ].join('\n'),
669670 'should report'
670671 )