Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Refactor MD038/no-space-in-code to produce smaller/simpler edits and address an additional scenario.

Browse source
This commit is contained in:
David Anson 2025-02-07 20:03:30 -08:00
parent 656254e64f
commit b23fc96ab2
8 changed files with 699 additions and 610 deletions
Download patch file Download diff file Expand all files Collapse all files

38
doc-build/md038.md
View file

@ -1,38 +1,44 @@
This rule is triggered for code spans that have content with spaces next to the
beginning or ending backticks:
This rule is triggered for code spans containing content with unnecessary space
next to the beginning or ending backticks:
```markdown
`some text `
` some text`
` some text `
```
To fix this, remove any spaces at the beginning or ending:
To fix this, remove the extra space characters from the beginning and ending:
```markdown
`some text`
```
Note: Code spans containing only spaces are allowed by the specification:
```markdown
` ` or ` `
```
Note: A single leading and trailing space is allowed by the specification and
automatically trimmed by the parser (in order to allow for code spans that embed
backticks):
Note: A single leading *and* trailing space is allowed by the specification and
trimmed by the parser to support code spans that begin or end with a backtick:
```markdown
`` `backticks` ``
`` backtick` ``
```
Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick (though the space is not trimmed):
Note: When single-space padding is present in the input, it will be preserved
(even if unnecessary):
```markdown
`` ` embedded backtick``
` code `
```
Rationale: Violations of this rule are usually unintentional and may lead to
Note: Code spans containing only spaces are allowed by the specification and are
also preserved:
```markdown
` `
` `
```
Rationale: Violations of this rule are usually unintentional and can lead to
improperly-rendered content.

38
doc/Rules.md
View file

@ -1528,43 +1528,49 @@ Aliases: `no-space-in-code`
Fixable: Some violations can be fixed by tooling
This rule is triggered for code spans that have content with spaces next to the
beginning or ending backticks:
This rule is triggered for code spans containing content with unnecessary space
next to the beginning or ending backticks:
```markdown
`some text `
` some text`
` some text `
```
To fix this, remove any spaces at the beginning or ending:
To fix this, remove the extra space characters from the beginning and ending:
```markdown
`some text`
```
Note: Code spans containing only spaces are allowed by the specification:
```markdown
` ` or ` `
```
Note: A single leading and trailing space is allowed by the specification and
automatically trimmed by the parser (in order to allow for code spans that embed
backticks):
Note: A single leading *and* trailing space is allowed by the specification and
trimmed by the parser to support code spans that begin or end with a backtick:
```markdown
`` `backticks` ``
`` backtick` ``
```
Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick (though the space is not trimmed):
Note: When single-space padding is present in the input, it will be preserved
(even if unnecessary):
```markdown
`` ` embedded backtick``
` code `
```
Rationale: Violations of this rule are usually unintentional and may lead to
Note: Code spans containing only spaces are allowed by the specification and are
also preserved:
```markdown
` `
` `
```
Rationale: Violations of this rule are usually unintentional and can lead to
improperly-rendered content.
<a name="md039"></a>

38
doc/md038.md
View file

@ -6,41 +6,47 @@ Aliases: `no-space-in-code`
Fixable: Some violations can be fixed by tooling
This rule is triggered for code spans that have content with spaces next to the
beginning or ending backticks:
This rule is triggered for code spans containing content with unnecessary space
next to the beginning or ending backticks:
```markdown
`some text `
` some text`
` some text `
```
To fix this, remove any spaces at the beginning or ending:
To fix this, remove the extra space characters from the beginning and ending:
```markdown
`some text`
```
Note: Code spans containing only spaces are allowed by the specification:
```markdown
` ` or ` `
```
Note: A single leading and trailing space is allowed by the specification and
automatically trimmed by the parser (in order to allow for code spans that embed
backticks):
Note: A single leading *and* trailing space is allowed by the specification and
trimmed by the parser to support code spans that begin or end with a backtick:
```markdown
`` `backticks` ``
`` backtick` ``
```
Note: A single leading or trailing space is allowed if used to separate code
span markers from an embedded backtick (though the space is not trimmed):
Note: When single-space padding is present in the input, it will be preserved
(even if unnecessary):
```markdown
`` ` embedded backtick``
` code `
```
Rationale: Violations of this rule are usually unintentional and may lead to
Note: Code spans containing only spaces are allowed by the specification and are
also preserved:
```markdown
` `
` `
```
Rationale: Violations of this rule are usually unintentional and can lead to
improperly-rendered content.

129
lib/md038.mjs
View file

@ -1,23 +1,9 @@
// @ts-check
import { addErrorContext } from "../helpers/helpers.cjs";
import { addErrorContext, newLineRe } from "../helpers/helpers.cjs";
import { getDescendantsByType } from "../helpers/micromark-helpers.cjs";
import { filterByTypesCached } from "./cache.mjs";
const leftSpaceRe = /^\s(?:[^`]|$)/;
const rightSpaceRe = /[^`]\s$/;
const allSpaceRe = /^\s*$/;
const trimCodeText = (text, start, end) => {
text = text.replace(/^\s+$/, "");
if (start) {
text = text.replace(/^\s+?(\s`|\S)/, "$1");
}
if (end) {
text = text.replace(/(`\s|\S)\s+$/, "$1");
}
return text;
};
/** @type {import("markdownlint").Rule} */
export default {
"names": [ "MD038", "no-space-in-code" ],
@ -27,68 +13,59 @@ export default {
"function": function MD038(params, onError) {
const codeTexts = filterByTypesCached([ "codeText" ]);
for (const codeText of codeTexts) {
const sequences = getDescendantsByType(codeText, [ "codeTextSequence" ]);
const startSequence = sequences[0];
const endSequence = sequences[sequences.length - 1];
const datas = getDescendantsByType(codeText, [ "codeTextData" ]);
const startData = datas[0];
const endData = datas[datas.length - 1];
if (startSequence && endSequence && startData && endData) {
const spaceLeft = leftSpaceRe.test(startData.text);
const spaceRight = rightSpaceRe.test(endData.text);
if (
(spaceLeft || spaceRight) &&
!datas.every((data) => allSpaceRe.test(data.text))
) {
let lineNumber = startSequence.startLine;
let range = undefined;
let fixInfo = undefined;
if (startSequence.startLine === endSequence.endLine) {
range = [
startSequence.startColumn,
endSequence.endColumn - startSequence.startColumn
];
fixInfo = {
"editColumn": startSequence.endColumn,
"deleteCount": endSequence.startColumn - startSequence.endColumn,
"insertText": trimCodeText(startData.text, true, true)
};
} else if (spaceLeft && (startSequence.endLine === startData.startLine)) {
range = [
startSequence.startColumn,
startData.endColumn - startSequence.startColumn
];
fixInfo = {
"editColumn": startSequence.endColumn,
"deleteCount": startData.endColumn - startData.startColumn,
"insertText": trimCodeText(startData.text, true, false)
};
} else if (spaceRight && (endData.text.trim().length > 0)) {
lineNumber = endSequence.endLine;
range = [
endData.startColumn,
endSequence.endColumn - endData.startColumn
];
fixInfo = {
"editColumn": endData.startColumn,
"deleteCount": endData.endColumn - endData.startColumn,
"insertText": trimCodeText(endData.text, false, true)
};
}
if (range) {
const context = params
.lines[lineNumber - 1]
.substring(range[0] - 1, range[0] - 1 + range[1]);
addErrorContext(
onError,
lineNumber,
context,
spaceLeft,
spaceRight,
range,
fixInfo
);
}
if (datas.length > 0) {
const paddings = getDescendantsByType(codeText, [ "codeTextPadding" ]);
// Check for extra space at start of code
const startPadding = paddings[0];
const startData = datas[0];
const startMatch = /^(\s+)(\S)/.exec(startData.text) || [ null, "", "" ];
const startBacktick = (startMatch[2] === "`");
const startCount = startMatch[1].length - ((startBacktick && !startPadding) ? 1 : 0);
const startSpaces = startCount > 0;
// Check for extra space at end of code
const endPadding = paddings[paddings.length - 1];
const endData = datas[datas.length - 1];
const endMatch = /(\S)(\s+)$/.exec(endData.text) || [ null, "", "" ];
const endBacktick = (endMatch[1] === "`");
const endCount = endMatch[2].length - ((endBacktick && !endPadding) ? 1 : 0);
const endSpaces = endCount > 0;
// Check if safe to remove 1-space padding
const removePadding = startSpaces && endSpaces && startPadding && endPadding && !startBacktick && !endBacktick;
const context = codeText.text.replace(newLineRe, "\n");
// If extra space at start, report violation
if (startSpaces) {
const startColumn = (removePadding ? startPadding : startData).startColumn;
const length = startCount + (removePadding ? startPadding.text.length : 0);
addErrorContext(
onError,
startData.startLine,
context,
true,
false,
[ startColumn, length ],
{
"editColumn": startColumn,
"deleteCount": length
}
);
}
// If extra space at end, report violation
if (endSpaces) {
const endColumn = (removePadding ? endPadding : endData).endColumn;
const length = endCount + (removePadding ? endPadding.text.length : 0);
addErrorContext(
onError,
endData.endLine,
context,
false,
true,
[ endColumn - length, length ],
{
"editColumn": endColumn - length,
"deleteCount": length
}
);
}
}
}

2
test/md038-scenarios.md
View file

@ -54,6 +54,6 @@
`` `code `` (fixed)
`` `code` `` {Could be MD038}
`` `code` `` {MD038}
`` `code` `` (fixed)

1050
test/snapshots/markdownlint-test-scenarios.mjs.md
View file

File diff suppressed because it is too large Load diff

BIN
test/snapshots/markdownlint-test-scenarios.mjs.snap
View file

Binary file not shown.

14
test/spaces_inside_codespan_elements.md
View file

@ -60,11 +60,11 @@ text and ``\`code with ignored escaped \` backticks``
` `` ` text `code`
``` ` leading space allowed for backtick``` text `code`
``` ` surrounding space allowed for backtick ``` text `code`
``` ` multiple leading spaces not allowed``` text `code` {MD038}
``trailing space allowed for backtick ` `` text `code`
`` surrounding space allowed for backtick ` `` text `code`
``multiple trailing spaces not allowed ` `` text `code` {MD038}
@ -126,13 +126,13 @@ Again, 2 characters: ` ab `
Again, 1 character: ` a `
Many internal spaces: ` code code code code code code `
text ``` ` leading space
allowed for backtick``` text
text ``` ` surrounding space
allowed for backtick ``` text
text ``` ` multiple leading {MD038}
spaces not allowed``` text
text ``trailing space
text `` surrounding space
allowed for backtick ` `` text
text ``multiple trailing spaces
@ -150,7 +150,7 @@ Code
Text
```
Code
Code {MD038}
```
Text
@ -160,7 +160,7 @@ Code
Text
```
Code
Code {MD038}
```
Text