Skip to content

Add assertation for bad links and only log latest version of modules#146

Merged
BrandonChanSkybox merged 8 commits into
mainfrom
AddAssertationForBadLinks
Jul 15, 2026
Merged

Add assertation for bad links and only log latest version of modules#146
BrandonChanSkybox merged 8 commits into
mainfrom
AddAssertationForBadLinks

Conversation

@BrandonChanSkybox

@BrandonChanSkybox BrandonChanSkybox commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Logs an error when a @ link is broken when linking symbols and is passed.
Also only logs for the latest versions of a module

@BrandonChanSkybox
BrandonChanSkybox marked this pull request as ready for review July 7, 2026 21:15
@BrandonChanSkybox
BrandonChanSkybox requested review from a team and SBLMikeDemone July 7, 2026 21:19
result.push(str);

if (linkMatches.length > 0) {
log.error(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just to confirm the behavior here, this will do the whole run still right? Ideally if there are multiple issues the error output shows all of them at once so the dev can fix them all.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, it continues and the whole run is still done.
It should log every error and still generate .md and .d.ts files.

Throw new Error() would cause the run to stop and only log once

@SBLMikeDemone SBLMikeDemone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The removed comments from the snapshots seem concerning and I think may lead to us posting incorrect documentation

@SBLMikeDemone SBLMikeDemone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! I'd recommend updating the PR message to also document that this removes documentation on everything but the latest major version.

@BrandonChanSkybox
BrandonChanSkybox merged commit 1185370 into main Jul 15, 2026
3 checks passed
@BrandonChanSkybox
BrandonChanSkybox deleted the AddAssertationForBadLinks branch July 15, 2026 23:35
@BrandonChanSkybox BrandonChanSkybox changed the title Add assertation for bad links Add assertation for bad links and only log latest version of modules Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants