Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-01-03 22:48:49 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

wip
Some checks are pending
Checkers / linkcheck (push) Waiting to run
Details
Checkers / spellcheck (push) Waiting to run
Details
CI / build (20, macos-latest) (push) Waiting to run
Details
CI / build (20, ubuntu-latest) (push) Waiting to run
Details
CI / build (20, windows-latest) (push) Waiting to run
Details
CI / build (22, macos-latest) (push) Waiting to run
Details
CI / build (22, ubuntu-latest) (push) Waiting to run
Details
CI / build (22, windows-latest) (push) Waiting to run
Details
CI / build (24, macos-latest) (push) Waiting to run
Details
CI / build (24, ubuntu-latest) (push) Waiting to run
Details
CI / build (24, windows-latest) (push) Waiting to run
Details
CI / pnpm (push) Waiting to run
Details
CodeQL / Analyze (push) Waiting to run
Details
TestRepos / build (latest, ubuntu-latest) (push) Waiting to run
Details
UpdateTestRepos / update (push) Waiting to run
Details

Browse source
This commit is contained in:
David Anson 2025-09-20 22:19:47 -07:00
parent 8021c087d4
commit d5abdb5a0b
12 changed files with 1606 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

58
test/configure-file-with-severity-alias.md Normal file
View file

@ -0,0 +1,58 @@
# Configure File With Severity Alias
Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.)
+ List item {MD004}
Text (text)[.] {MD011}
2. List item
<!-- markdownlint-disable -->
Text * text*
Text ` text`
Text [ text](.)
+ List item
Text (text)[.]
2. List item
<!-- markdownlint-restore -->
Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.)
+ List item {MD004}
Text (text)[.] {MD011}
2. List item
<!-- markdownlint-configure-file {
"default": false,
"no-space-in-emphasis": "error",
"no-space-in-code": "warning",
"no-space-in-links": false,
"ul-style": {
"severity": "error",
"style": "dash"
},
"no-reversed-links": {
"severity": "warning"
},
"ol-prefix": {
"severity": "off"
}
} -->

18
test/configure-file-with-severity.md → test/configure-file-with-severity-name.md
View file

@ -1,16 +1,16 @@
# Configure File With Severity
# Configure File With Severity Name
Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.) {MD039}
Text [ text](.)
+ List item {MD004}
Text (text)[.] {MD011}
2. List item {MD029}
2. List item
<!-- markdownlint-disable -->
@ -32,27 +32,27 @@ Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.) {MD039}
Text [ text](.)
+ List item {MD004}
Text (text)[.] {MD011}
2. List item {MD029}
2. List item
<!-- markdownlint-configure-file {
"default": false,
"MD037": "error",
"MD038": "error",
"MD039": "error",
"MD038": "warning",
"MD039": false,
"MD004": {
"severity": "error",
"style": "dash"
},
"MD011": {
"severity": "error"
"severity": "warning"
},
"MD029": {
"severity": "error"
"severity": "off"
}
} -->

56
test/configure-file-with-severity-tag.md Normal file
View file

@ -0,0 +1,56 @@
# Configure File With Severity Tag
Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.) {MD039}
+ List item
Text (text)[.] {MD011}
2. List item {MD029}
<!-- markdownlint-disable -->
Text * text*
Text ` text`
Text [ text](.)
+ List item
Text (text)[.]
2. List item
<!-- markdownlint-restore -->
Text * text* {MD037}
Text ` text` {MD038}
Text [ text](.) {MD039}
+ List item
Text (text)[.] {MD011}
2. List item {MD029}
<!-- markdownlint-configure-file {
"default": false,
"emphasis": "error",
"code": "warning",
"bullet": {
"severity": "off"
},
"links": {
"severity": "warning"
},
"ol": {
"severity": "error"
}
} -->

27
test/markdownlint-test.mjs
View file

@ -226,6 +226,16 @@ const configTestExpected3511 = {
"MD041 1 error"
]
};
const configTestExpected3511warning = {
"./test/atx_heading_spacing.md": [
"MD019 3 warning",
"MD019 5 warning",
"MD041 1 warning"
],
"./test/first_heading_bad_atx.md": [
"MD041 1 warning"
]
};
const configTestExpected13511 = {
"./test/atx_heading_spacing.md": [
"MD018 1 error",
@ -237,6 +247,17 @@ const configTestExpected13511 = {
"MD041 1 error"
]
};
const configTestExpected13511warning = {
"./test/atx_heading_spacing.md": [
"MD018 1 warning",
"MD019 3 warning",
"MD019 5 warning",
"MD041 1 warning"
],
"./test/first_heading_bad_atx.md": [
"MD041 1 warning"
]
};
test("defaultUnset", getConfigTestImplementation(
{},
@ -273,7 +294,7 @@ test("defaultError", getConfigTestImplementation(
test("defaultWarning", getConfigTestImplementation(
// @ts-ignore
{ "default": "warning" },
configTestExpected13511
configTestExpected13511warning
));
test("defaultOff", getConfigTestImplementation(
@ -437,7 +458,7 @@ test("enableRulesObjectWarning", getConfigTestImplementation(
"severity": "warning"
}
},
configTestExpected3511
configTestExpected3511warning
));
test("enableRulesObjectOff", getConfigTestImplementation(
@ -1020,7 +1041,7 @@ test("readme", async(t) => {
});
test("validateJsonUsingConfigSchemaStrict", async(t) => {
t.plan(212);
t.plan(214);
// @ts-ignore
const ajv = new Ajv(ajvOptions);
const validateSchemaStrict = ajv.compile(configSchemaStrict);

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

@ -11203,7 +11203,7 @@ Generated by [AVA](https://avajs.dev).
`,
}
## configure-file-with-severity.md
## configure-file-with-severity-alias.md
> Snapshot 1
@ -11270,7 +11270,7 @@ Generated by [AVA](https://avajs.dev).
'MD011',
'no-reversed-links',
],
severity: 'error',
severity: 'warning',
},
{
errorContext: null,
@ -11291,8 +11291,430 @@ Generated by [AVA](https://avajs.dev).
'MD011',
'no-reversed-links',
],
severity: 'warning',
},
{
errorContext: '* t',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 3,
ruleDescription: 'Spaces inside emphasis markers',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md037.md',
ruleNames: [
'MD037',
'no-space-in-emphasis',
],
severity: 'error',
},
{
errorContext: '* t',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 31,
ruleDescription: 'Spaces inside emphasis markers',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md037.md',
ruleNames: [
'MD037',
'no-space-in-emphasis',
],
severity: 'error',
},
{
errorContext: '` text`',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 5,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
severity: 'warning',
},
{
errorContext: '` text`',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 33,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
severity: 'warning',
},
],
fixed: `# Configure File With Severity Alias␊
␊
Text *text* {MD037}␊
␊
Text \`text\` {MD038}␊
␊
Text [ text](.)␊
␊
- List item {MD004}␊
␊
Text [text](.) {MD011}␊
␊
2. List item␊
␊
<!-- markdownlint-disable -->␊
␊
Text * text*␊
␊
Text \` text\`␊
␊
Text [ text](.)␊
␊
+ List item␊
␊
Text (text)[.]␊
␊
2. List item␊
␊
<!-- markdownlint-restore -->␊
␊
Text *text* {MD037}␊
␊
Text \`text\` {MD038}␊
␊
Text [ text](.)␊
␊
- List item {MD004}␊
␊
Text [text](.) {MD011}␊
␊
2. List item␊
␊
<!-- markdownlint-configure-file {␊
"default": false,␊
"no-space-in-emphasis": "error",␊
"no-space-in-code": "warning",␊
"no-space-in-links": false,␊
"ul-style": {␊
"severity": "error",␊
"style": "dash"␊
},␊
"no-reversed-links": {␊
"severity": "warning"␊
},␊
"ol-prefix": {␊
"severity": "off"␊
}␊
} -->␊
`,
}
## configure-file-with-severity-name.md
> Snapshot 1
{
errors: [
{
errorContext: null,
errorDetail: 'Expected: dash; Actual: plus',
errorRange: [
1,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 1,
insertText: '-',
},
lineNumber: 9,
ruleDescription: 'Unordered list style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md004.md',
ruleNames: [
'MD004',
'ul-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Expected: dash; Actual: plus',
errorRange: [
1,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 1,
insertText: '-',
},
lineNumber: 37,
ruleDescription: 'Unordered list style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md004.md',
ruleNames: [
'MD004',
'ul-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: '(text)[.]',
errorRange: [
6,
9,
],
fixInfo: {
deleteCount: 9,
editColumn: 6,
insertText: '[text](.)',
},
lineNumber: 11,
ruleDescription: 'Reversed link syntax',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md011.md',
ruleNames: [
'MD011',
'no-reversed-links',
],
severity: 'warning',
},
{
errorContext: null,
errorDetail: '(text)[.]',
errorRange: [
6,
9,
],
fixInfo: {
deleteCount: 9,
editColumn: 6,
insertText: '[text](.)',
},
lineNumber: 39,
ruleDescription: 'Reversed link syntax',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md011.md',
ruleNames: [
'MD011',
'no-reversed-links',
],
severity: 'warning',
},
{
errorContext: '* t',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 3,
ruleDescription: 'Spaces inside emphasis markers',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md037.md',
ruleNames: [
'MD037',
'no-space-in-emphasis',
],
severity: 'error',
},
{
errorContext: '* t',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 31,
ruleDescription: 'Spaces inside emphasis markers',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md037.md',
ruleNames: [
'MD037',
'no-space-in-emphasis',
],
severity: 'error',
},
{
errorContext: '` text`',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 5,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
severity: 'warning',
},
{
errorContext: '` text`',
errorDetail: null,
errorRange: [
7,
1,
],
fixInfo: {
deleteCount: 1,
editColumn: 7,
},
lineNumber: 33,
ruleDescription: 'Spaces inside code span elements',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md038.md',
ruleNames: [
'MD038',
'no-space-in-code',
],
severity: 'warning',
},
],
fixed: `# Configure File With Severity Name␊
␊
Text *text* {MD037}␊
␊
Text \`text\` {MD038}␊
␊
Text [ text](.)␊
␊
- List item {MD004}␊
␊
Text [text](.) {MD011}␊
␊
2. List item␊
␊
<!-- markdownlint-disable -->␊
␊
Text * text*␊
␊
Text \` text\`␊
␊
Text [ text](.)␊
␊
+ List item␊
␊
Text (text)[.]␊
␊
2. List item␊
␊
<!-- markdownlint-restore -->␊
␊
Text *text* {MD037}␊
␊
Text \`text\` {MD038}␊
␊
Text [ text](.)␊
␊
- List item {MD004}␊
␊
Text [text](.) {MD011}␊
␊
2. List item␊
␊
<!-- markdownlint-configure-file {␊
"default": false,␊
"MD037": "error",␊
"MD038": "warning",␊
"MD039": false,␊
"MD004": {␊
"severity": "error",␊
"style": "dash"␊
},␊
"MD011": {␊
"severity": "warning"␊
},␊
"MD029": {␊
"severity": "off"␊
}␊
} -->␊
`,
}
## configure-file-with-severity-tag.md
> Snapshot 1
{
errors: [
{
errorContext: null,
errorDetail: '(text)[.]',
errorRange: [
6,
9,
],
fixInfo: {
deleteCount: 9,
editColumn: 6,
insertText: '[text](.)',
},
lineNumber: 11,
ruleDescription: 'Reversed link syntax',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md011.md',
ruleNames: [
'MD011',
'no-reversed-links',
],
severity: 'warning',
},
{
errorContext: null,
errorDetail: '(text)[.]',
errorRange: [
6,
9,
],
fixInfo: {
deleteCount: 9,
editColumn: 6,
insertText: '[text](.)',
},
lineNumber: 39,
ruleDescription: 'Reversed link syntax',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md011.md',
ruleNames: [
'MD011',
'no-reversed-links',
],
severity: 'warning',
},
{
errorContext: null,
errorDetail: 'Expected: 1; Actual: 2; Style: 1/1/1',
@ -11393,7 +11815,7 @@ Generated by [AVA](https://avajs.dev).
'MD038',
'no-space-in-code',
],
severity: 'error',
severity: 'warning',
},
{
errorContext: '` text`',
@ -11413,7 +11835,7 @@ Generated by [AVA](https://avajs.dev).
'MD038',
'no-space-in-code',
],
severity: 'error',
severity: 'warning',
},
{
errorContext: '[ text]',
@ -11433,7 +11855,7 @@ Generated by [AVA](https://avajs.dev).
'MD039',
'no-space-in-links',
],
severity: 'error',
severity: 'warning',
},
{
errorContext: '[ text]',
@ -11453,10 +11875,10 @@ Generated by [AVA](https://avajs.dev).
'MD039',
'no-space-in-links',
],
severity: 'error',
severity: 'warning',
},
],
fixed: `# Configure File With Severity␊
fixed: `# Configure File With Severity Tag␊
␊
Text *text* {MD037}␊
␊
@ -11464,7 +11886,7 @@ Generated by [AVA](https://avajs.dev).
␊
Text [text](.) {MD039}␊
␊
- List item {MD004}␊
+ List item␊
␊
Text [text](.) {MD011}␊
␊
@ -11492,7 +11914,7 @@ Generated by [AVA](https://avajs.dev).
␊
Text [text](.) {MD039}␊
␊
- List item {MD004}␊
+ List item␊
␊
Text [text](.) {MD011}␊
␊
@ -11500,17 +11922,15 @@ Generated by [AVA](https://avajs.dev).
␊
<!-- markdownlint-configure-file {␊
"default": false,␊
"MD037": "error",␊
"MD038": "error",␊
"MD039": "error",␊
"MD004": {␊
"severity": "error",␊
"style": "dash"␊
"emphasis": "error",␊
"code": "warning",␊
"bullet": {␊
"severity": "off"␊
},␊
"MD011": {␊
"severity": "error"␊
"links": {␊
"severity": "warning"␊
},␊
"MD029": {␊
"ol": {␊
"severity": "error"␊
}␊
} -->␊

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

Binary file not shown.