Skip to content
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

Link checker parses headings inside component #2230

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

@Eric-Arellano Eric-Arellano commented Nov 1, 2024

The link checker was failing to detect inline class methods (related to #2210) because it does not peek inside <Class> components.

To fix this, we now use our own parsing code for headings.

It's possible there will be future edge cases this PR does not account for in its heading parsing. Our link checker will fail in that case and we can forward fix.

@Eric-Arellano Eric-Arellano changed the title Link checker parses headers inside component Link checker parses headings inside component Nov 1, 2024
Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This solution looks good. Though if we hit more problems like this we might want to consider spinning up the server and making requests. It would be slower, but it'd be guaranteed correct.

@Eric-Arellano
Copy link
Collaborator Author

Though if we hit more problems like this we might want to consider spinning up the server and making requests. It would be slower, but it'd be guaranteed correct.

I don't think so - think about how slow checkPagesRender.ts is. It's important our link checker handles all historical API docs as well; the closed source link checker doesn't do that because its live render approach is too slow.

@Eric-Arellano Eric-Arellano added this pull request to the merge queue Nov 4, 2024
Merged via the queue into main with commit c12e2ac Nov 4, 2024
3 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/fix-linkchecker branch November 4, 2024 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants