Skip to content

fix(lint-mdx): stop flagging closing code fences as missing a language #1805

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

Open
bayrakdarerdem wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(lint-mdx): stop flagging closing code fences as missing a language #1805

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
30 changes: 25 additions & 5 deletions scripts/lint-mdx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,17 +183,37 @@ function checkCodeBlocks(content, filePath) {
const issues = [];
const lines = content.split("\n");
let inCodeGroup = false;
// Length (in backticks) of the fence currently open, or 0 when not inside
// a code block. Tracked (rather than a boolean) because MDX lets a fence
// of 4+ backticks nest a literal 3-backtick fence as content -- e.g. a
// ` ```` ` block used to show what a fenced code sample looks like. Only
// a fence with at least as many backticks as the one that opened the
// block can close it (matching CommonMark); shorter backtick runs inside
// are just text.
let openFenceLength = 0;

for (let i = 0; i < lines.length; i++) {
const line = lines[i];

if (line.includes("<CodeGroup>")) inCodeGroup = true;
if (line.includes("</CodeGroup>")) inCodeGroup = false;

// Check for code block opening
const codeBlockMatch = line.match(/^```(\S*)/);
const codeBlockMatch = line.match(/^(`{3,})(\S*)/);
if (codeBlockMatch) {
const lang = codeBlockMatch[1];
const fenceLength = codeBlockMatch[1].length;

if (openFenceLength > 0) {
// Inside a block: only a fence at least as long as the one that
// opened it actually closes the block. A shorter run of backticks
// is nested content, not a real fence.
if (fenceLength >= openFenceLength) {
openFenceLength = 0;
}
continue;
}

openFenceLength = fenceLength;
const lang = codeBlockMatch[2];

// Check for empty language
if (!lang) {
Expand All @@ -205,9 +225,9 @@ function checkCodeBlocks(content, filePath) {
}

// In CodeGroup, should have language AND label
if (inCodeGroup && lang && !lang.includes(" ") && !/\s+\S+/.test(line.slice(3 + lang.length))) {
if (inCodeGroup && lang) {
// Check if there's a label after the language
const afterLang = line.slice(3 + lang.length).trim();
const afterLang = line.slice(fenceLength + lang.length).trim();
if (!afterLang) {
issues.push({
line: i + 1,
Expand Down