-
Notifications
You must be signed in to change notification settings - Fork 61
ci: enable Lychee external link checks #785
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/usr/bin/env -S node --experimental-strip-types | ||
|
|
||
| import fs from 'node:fs' | ||
| import { externalLinkSource } from '../src/lib/external-link-source.ts' | ||
|
|
||
| const file = process.argv[2] | ||
| if (!file) throw new Error('Expected a source file path') | ||
|
|
||
| process.stdout.write(externalLinkSource(fs.readFileSync(file, 'utf8'))) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { externalLinkSource } from './external-link-source' | ||
|
|
||
| describe('external link source', () => { | ||
| it.each([ | ||
| ['root-relative Markdown', '[Docs](/docs/guide#section)', '[Docs](#)'], | ||
| ['relative Markdown', '[Sibling](../sibling)', '[Sibling](#)'], | ||
| ['root-relative image', '', ''], | ||
| ['reference definition', '[docs]: /docs/guide', '[docs]: #'], | ||
| ['JSX href', '<a href="/docs/guide">Docs</a>', '<a href="#">Docs</a>'], | ||
| ['JSX to', '<Card to="./guide" />', '<Card to="#" />'], | ||
| ['JSX src', "<img src='/developers/image.svg' />", "<img src='#' />"], | ||
| ['local autolink', '</docs/guide>', '<#>'], | ||
| ])('masks %s destinations', (_label, source, expected) => { | ||
| expect(externalLinkSource(source)).toBe(expected) | ||
| }) | ||
|
|
||
| it('preserves external URLs and line numbers', () => { | ||
| const source = [ | ||
| '[Docs](/docs/guide)', | ||
| '[GitHub](https://github.com/tempoxyz/docs)', | ||
| '<a href="https://tempo.xyz">Tempo</a>', | ||
| 'Bare URL: https://example.net/path', | ||
| ].join('\n') | ||
|
|
||
| const filtered = externalLinkSource(source) | ||
|
|
||
| expect(filtered).toContain('[GitHub](https://github.com/tempoxyz/docs)') | ||
| expect(filtered).toContain('<a href="https://tempo.xyz">Tempo</a>') | ||
| expect(filtered).toContain('Bare URL: https://example.net/path') | ||
| expect(filtered.split('\n')).toHaveLength(source.split('\n').length) | ||
| }) | ||
| }) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| const markdownDestination = /(\]\()<?(?:\/|#|\.\.?\/)[^\s)>]+>?/g | ||
| const markdownDefinition = /(^\s*\[[^\]]+\]:\s*<?)(?:\/|#|\.\.?\/)[^\s>]+>?/gm | ||
| const jsxAttribute = /(\b(?:href|src|to)\s*=\s*["'])(?:\/|#|\.\.?\/)[^"']*(["'])/g | ||
| const autolink = /<(?:\/(?:docs|developers)(?:\/[^>\s]*)?|#[^>\s]*|\.\.?\/[^>\s]*)>/g | ||
|
|
||
| export function externalLinkSource(source: string): string { | ||
| return source | ||
| .replace(markdownDestination, '$1#') | ||
| .replace(markdownDefinition, '$1#') | ||
| .replace(jsxAttribute, '$1#$2') | ||
| .replace(autolink, '<#>') | ||
| } |
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
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
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.