-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
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
feat(v2): broken links detection #3059
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7ba1373
add broken links checker
slorber d339208
polish
slorber b39e2bf
finalize broken links detection feature
slorber aa9ebe4
note broken links is only for prod build
slorber 20ebac2
fix broken link on template
slorber bef0634
fix test snapshot
slorber 0470d93
Merge branch 'master' into slorber/broken-links-checker
slorber 5af0b3b
fix bad merge
slorber 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 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 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 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 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 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 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 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 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 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,50 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import React, {ReactNode, useContext, createContext} from 'react'; | ||
|
||
type LinksCollector = { | ||
collectLink: (link: string) => void; | ||
}; | ||
|
||
type StatefulLinksCollector = LinksCollector & { | ||
getCollectedLinks: () => string[]; | ||
}; | ||
|
||
export const createStatefulLinksCollector = (): StatefulLinksCollector => { | ||
// Set to dedup, as it's not useful to collect multiple times the same link | ||
const allLinks = new Set<string>(); | ||
return { | ||
collectLink: (link: string): void => { | ||
allLinks.add(link); | ||
}, | ||
getCollectedLinks: (): string[] => { | ||
return [...allLinks]; | ||
}, | ||
}; | ||
}; | ||
|
||
const Context = createContext<LinksCollector>({ | ||
collectLink: () => { | ||
// noop by default for client | ||
// we only use the broken links checker server-side | ||
}, | ||
}); | ||
|
||
export const useLinksCollector = () => { | ||
return useContext(Context); | ||
}; | ||
|
||
export const ProvideLinksCollector = ({ | ||
children, | ||
linksCollector, | ||
}: { | ||
children: ReactNode; | ||
linksCollector: LinksCollector; | ||
}) => { | ||
return <Context.Provider value={linksCollector}>{children}</Context.Provider>; | ||
}; |
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
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
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
13 changes: 13 additions & 0 deletions
13
packages/docusaurus/src/server/__tests__/__snapshots__/brokenLinks.test.ts.snap
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`brokenLinks getBrokenLinksErrorMessage 1`] = ` | ||
"Broken links found! | ||
|
||
- Page path = /docs/mySourcePage: | ||
-> link to ./myBrokenLink (resolved as: /docs/myBrokenLink) | ||
-> link to ../otherBrokenLink (resolved as: /otherBrokenLink), | ||
|
||
- Page path = /otherSourcePage: | ||
-> link to /badLink | ||
" | ||
`; |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI I removed it because this template link is actually broken (this was failing the CI).
It is interpreted as an internal SPA link, and ReactRouter shows the 404:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well then, I am glad this feature already found one broken link :)