Skip to content

Fix MDX lint URL false positives in prose #79

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.

Sign up for GitHub

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
gontzess merged 1 commit into from
May 18, 2026
Merged

Fix MDX lint URL false positives in prose #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions tools/mdx-lint/mdx-lint.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,6 @@ function validateTree(tree) {
case "definition":
validateUrlNode(node);
break;
case "text":
if (containsDangerousUrl(node.value)) {
fail(node, "contains a dangerous URL scheme");
}
break;
}
});
}
Expand Down
13 changes: 13 additions & 0 deletions tools/mdx-lint/mdx-lint.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,19 @@ Read the public setup guide at https://example.com/docs.
`);
});

it("allows dangerous URL scheme names in plain prose", async () => {
await expectValid(`<Steps>
<Step>
In the permissions section, choose the relevant permissions:

To sync (read) data:

- Project: Read
</Step>
</Steps>
`);
});

it("rejects unknown JSX components", async () => {
await expectInvalid("<Unknown />\n", /disallowed JSX component "Unknown"/);
});
Expand Down