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

Update MD041/first-line-heading to add an allow_preamble parameter (fixes #1416).

Browse source
This commit is contained in:
David Anson 2025-03-22 16:15:59 -07:00
parent c061888937
commit 62dc79864d
17 changed files with 538 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

45
doc-build/md041.md
View file

@ -1,37 +1,50 @@
This rule is intended to ensure documents have a title and is triggered when
the first line in the file isn't a top-level (h1) heading:
the first line in a document is not a top-level ([HTML][HTML] `h1`) heading:
```markdown
This is a file without a heading
This is a document without a heading
```
To fix this, add a top-level heading to the beginning of the file:
To fix this, add a top-level heading to the beginning of the document:
```markdown
# File with heading
# Document Heading
This is a file with a top-level heading
This is a document with a top-level heading
```
Because it is common for projects on GitHub to use an image for the heading of
`README.md` and that is not well-supported by Markdown, HTML headings are also
permitted by this rule. For example:
`README.md` and that pattern is not well-supported by Markdown, HTML headings
are also permitted by this rule. For example:
```markdown
<h1 align="center"><img src="https://placekitten.com/300/150"/></h1>
This is a file with a top-level HTML heading
This is a document with a top-level HTML heading
```
Note: The `level` parameter can be used to change the top-level (ex: to h2) in
cases where an h1 is added externally.
In some cases, a document's title heading may be preceded by text like a table
of contents. This is not ideal for accessibility, but can be allowed by setting
the `allow_preamble` parameter to `true`.
If [YAML](https://en.wikipedia.org/wiki/YAML) front matter is present and
contains a `title` property (commonly used with blog posts), this rule will not
report a violation. To use a different property name in the front matter,
specify the text of a regular expression via the `front_matter_title` parameter.
To disable the use of front matter by this rule, specify `""` for
`front_matter_title`.
```markdown
This is a document with preamble text
# Document Heading
```
If [YAML][YAML] front matter is present and contains a `title` property
(commonly used with blog posts), this rule will not report a violation. To use a
different property name in the front matter, specify the text of a [regular
expression][RegExp] via the `front_matter_title` parameter. To disable the use
of front matter by this rule, specify `""` for `front_matter_title`.
The `level` parameter can be used to change the top-level heading (ex: to `h2`)
in cases where an `h1` is added externally.
Rationale: The top-level heading often acts as the title of a document. More
information: <https://cirosantilli.com/markdown-style-guide#top-level-header>.
[HTML]: https://en.wikipedia.org/wiki/HTML
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
[YAML]: https://en.wikipedia.org/wiki/YAML

47
doc/Rules.md
View file

@ -1670,48 +1670,63 @@ Aliases: `first-line-h1`, `first-line-heading`
Parameters:
- `allow_preamble`: Allow content before first heading (`boolean`, default
`false`)
- `front_matter_title`: RegExp for matching title in front matter (`string`,
default `^\s*title\s*[:=]`)
- `level`: Heading level (`integer`, default `1`)
This rule is intended to ensure documents have a title and is triggered when
the first line in the file isn't a top-level (h1) heading:
the first line in a document is not a top-level ([HTML][HTML] `h1`) heading:
```markdown
This is a file without a heading
This is a document without a heading
```
To fix this, add a top-level heading to the beginning of the file:
To fix this, add a top-level heading to the beginning of the document:
```markdown
# File with heading
# Document Heading
This is a file with a top-level heading
This is a document with a top-level heading
```
Because it is common for projects on GitHub to use an image for the heading of
`README.md` and that is not well-supported by Markdown, HTML headings are also
permitted by this rule. For example:
`README.md` and that pattern is not well-supported by Markdown, HTML headings
are also permitted by this rule. For example:
```markdown
<h1 align="center"><img src="https://placekitten.com/300/150"/></h1>
This is a file with a top-level HTML heading
This is a document with a top-level HTML heading
```
Note: The `level` parameter can be used to change the top-level (ex: to h2) in
cases where an h1 is added externally.
In some cases, a document's title heading may be preceded by text like a table
of contents. This is not ideal for accessibility, but can be allowed by setting
the `allow_preamble` parameter to `true`.
If [YAML](https://en.wikipedia.org/wiki/YAML) front matter is present and
contains a `title` property (commonly used with blog posts), this rule will not
report a violation. To use a different property name in the front matter,
specify the text of a regular expression via the `front_matter_title` parameter.
To disable the use of front matter by this rule, specify `""` for
`front_matter_title`.
```markdown
This is a document with preamble text
# Document Heading
```
If [YAML][YAML] front matter is present and contains a `title` property
(commonly used with blog posts), this rule will not report a violation. To use a
different property name in the front matter, specify the text of a [regular
expression][RegExp] via the `front_matter_title` parameter. To disable the use
of front matter by this rule, specify `""` for `front_matter_title`.
The `level` parameter can be used to change the top-level heading (ex: to `h2`)
in cases where an `h1` is added externally.
Rationale: The top-level heading often acts as the title of a document. More
information: <https://cirosantilli.com/markdown-style-guide#top-level-header>.
[HTML]: https://en.wikipedia.org/wiki/HTML
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
[YAML]: https://en.wikipedia.org/wiki/YAML
<a name="md042"></a>
## `MD042` - No empty links

47
doc/md041.md
View file

@ -6,44 +6,59 @@ Aliases: `first-line-h1`, `first-line-heading`
Parameters:
- `allow_preamble`: Allow content before first heading (`boolean`, default
`false`)
- `front_matter_title`: RegExp for matching title in front matter (`string`,
default `^\s*title\s*[:=]`)
- `level`: Heading level (`integer`, default `1`)
This rule is intended to ensure documents have a title and is triggered when
the first line in the file isn't a top-level (h1) heading:
the first line in a document is not a top-level ([HTML][HTML] `h1`) heading:
```markdown
This is a file without a heading
This is a document without a heading
```
To fix this, add a top-level heading to the beginning of the file:
To fix this, add a top-level heading to the beginning of the document:
```markdown
# File with heading
# Document Heading
This is a file with a top-level heading
This is a document with a top-level heading
```
Because it is common for projects on GitHub to use an image for the heading of
`README.md` and that is not well-supported by Markdown, HTML headings are also
permitted by this rule. For example:
`README.md` and that pattern is not well-supported by Markdown, HTML headings
are also permitted by this rule. For example:
```markdown
<h1 align="center"><img src="https://placekitten.com/300/150"/></h1>
This is a file with a top-level HTML heading
This is a document with a top-level HTML heading
```
Note: The `level` parameter can be used to change the top-level (ex: to h2) in
cases where an h1 is added externally.
In some cases, a document's title heading may be preceded by text like a table
of contents. This is not ideal for accessibility, but can be allowed by setting
the `allow_preamble` parameter to `true`.
If [YAML](https://en.wikipedia.org/wiki/YAML) front matter is present and
contains a `title` property (commonly used with blog posts), this rule will not
report a violation. To use a different property name in the front matter,
specify the text of a regular expression via the `front_matter_title` parameter.
To disable the use of front matter by this rule, specify `""` for
`front_matter_title`.
```markdown
This is a document with preamble text
# Document Heading
```
If [YAML][YAML] front matter is present and contains a `title` property
(commonly used with blog posts), this rule will not report a violation. To use a
different property name in the front matter, specify the text of a [regular
expression][RegExp] via the `front_matter_title` parameter. To disable the use
of front matter by this rule, specify `""` for `front_matter_title`.
The `level` parameter can be used to change the top-level heading (ex: to `h2`)
in cases where an `h1` is added externally.
Rationale: The top-level heading often acts as the title of a document. More
information: <https://cirosantilli.com/markdown-style-guide#top-level-header>.
[HTML]: https://en.wikipedia.org/wiki/HTML
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
[YAML]: https://en.wikipedia.org/wiki/YAML

48
lib/configuration-strict.d.ts vendored
View file

@ -406,14 +406,14 @@ export interface ConfigurationStrict {
MD025?:
| boolean
| {
/**
* Heading level
*/
level?: number;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md
@ -421,14 +421,14 @@ export interface ConfigurationStrict {
"single-title"?:
| boolean
| {
/**
* Heading level
*/
level?: number;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md
@ -436,14 +436,14 @@ export interface ConfigurationStrict {
"single-h1"?:
| boolean
| {
/**
* Heading level
*/
level?: number;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md026.md
@ -730,13 +730,17 @@ export interface ConfigurationStrict {
| boolean
| {
/**
* Heading level
* Allow content before first heading
*/
level?: number;
allow_preamble?: boolean;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md041.md
@ -745,13 +749,17 @@ export interface ConfigurationStrict {
| boolean
| {
/**
* Heading level
* Allow content before first heading
*/
level?: number;
allow_preamble?: boolean;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md041.md
@ -760,13 +768,17 @@ export interface ConfigurationStrict {
| boolean
| {
/**
* Heading level
* Allow content before first heading
*/
level?: number;
allow_preamble?: boolean;
/**
* RegExp for matching title in front matter
*/
front_matter_title?: string;
/**
* Heading level
*/
level?: number;
};
/**
* MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md042.md

52
lib/md041.mjs
View file

@ -3,6 +3,26 @@
import { addErrorContext, frontMatterHasTitle } from "../helpers/helpers.cjs";
import { filterByTypes, getHeadingLevel, getHtmlTagInfo, isHtmlFlowComment, nonContentTokens } from "../helpers/micromark-helpers.cjs";
const headingTagNameRe = /^h[1-6]$/;
/**
* Gets the HTML tag name of an htmlFlow token.
*
* @param {import("markdownlint").MicromarkToken} token Micromark Token.
* @returns {string | null} Tag name.
*/
function getHtmlFlowTagName(token) {
const { children, type } = token;
if (type === "htmlFlow") {
const htmlTexts = filterByTypes(children, [ "htmlText" ], true);
const tagInfo = (htmlTexts.length > 0) && getHtmlTagInfo(htmlTexts[0]);
if (tagInfo) {
return tagInfo.name.toLowerCase();
}
}
return null;
}
/** @type {import("markdownlint").Rule} */
export default {
"names": [ "MD041", "first-line-heading", "first-line-h1" ],
@ -10,6 +30,7 @@ export default {
"tags": [ "headings" ],
"parser": "micromark",
"function": function MD041(params, onError) {
const allowPreamble = !!params.config.allow_preamble;
const level = Number(params.config.level || 1);
const { tokens } = params.parsers.micromark;
if (
@ -18,22 +39,33 @@ export default {
params.config.front_matter_title
)
) {
let errorLineNumber = 0;
for (const token of tokens) {
if (!nonContentTokens.has(token.type) && !isHtmlFlowComment(token)) {
let isError = true;
if ((token.type === "atxHeading") || (token.type === "setextHeading")) {
isError = (getHeadingLevel(token) !== level);
} else if (token.type === "htmlFlow") {
const htmlTexts = filterByTypes(token.children, [ "htmlText" ], true);
const tagInfo = (htmlTexts.length > 0) && getHtmlTagInfo(htmlTexts[0]);
isError = !tagInfo || (tagInfo.name.toLowerCase() !== `h${level}`);
const { startLine, type } = token;
if (!nonContentTokens.has(type) && !isHtmlFlowComment(token)) {
let tagName = null;
if ((type === "atxHeading") || (type === "setextHeading")) {
// First heading needs to have the expected level
if (getHeadingLevel(token) !== level) {
errorLineNumber = startLine;
}
if (isError) {
addErrorContext(onError, token.startLine, params.lines[token.startLine - 1]);
break;
} else if ((tagName = getHtmlFlowTagName(token)) && headingTagNameRe.test(tagName)) {
// First HTML element needs to have an <h?> with the expected level
if (tagName !== `h${level}`) {
errorLineNumber = startLine;
}
break;
} else if (!allowPreamble) {
// First non-content needs to be a heading with the expected level
errorLineNumber = startLine;
break;
}
}
}
if (errorLineNumber > 0) {
addErrorContext(onError, errorLineNumber, params.lines[errorLineNumber - 1]);
}
}
}
};

14
schema/.markdownlint.jsonc
View file

@ -118,10 +118,10 @@
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md
"MD025": {
// Heading level
"level": 1,
// RegExp for matching title in front matter
"front_matter_title": "^\\s*title\\s*[:=]"
"front_matter_title": "^\\s*title\\s*[:=]",
// Heading level
"level": 1
},
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md026.md
@ -206,10 +206,12 @@
// MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md041.md
"MD041": {
// Heading level
"level": 1,
// Allow content before first heading
"allow_preamble": false,
// RegExp for matching title in front matter
"front_matter_title": "^\\s*title\\s*[:=]"
"front_matter_title": "^\\s*title\\s*[:=]",
// Heading level
"level": 1
},
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md042.md

10
schema/.markdownlint.yaml
View file

@ -108,10 +108,10 @@ MD024:
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md025.md
MD025:
# Heading level
level: 1
# RegExp for matching title in front matter
front_matter_title: "^\\s*title\\s*[:=]"
# Heading level
level: 1
# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md026.md
MD026:
@ -186,10 +186,12 @@ MD040:
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md041.md
MD041:
# Heading level
level: 1
# Allow content before first heading
allow_preamble: false
# RegExp for matching title in front matter
front_matter_title: "^\\s*title\\s*[:=]"
# Heading level
level: 1
# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md042.md
MD042: true

22
schema/build-config-schema.mjs
View file

@ -367,20 +367,32 @@ for (const rule of rules) {
break;
case "MD025":
case "MD041":
{
const md041Properties = (ruleName === "MD041") ?
{
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
}
} :
{};
scheme.properties = {
...md041Properties,
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
};
}
break;
case "MD043":
scheme.properties = {

75
schema/markdownlint-config-schema-strict.json
View file

@ -628,17 +628,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -651,17 +651,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -674,17 +674,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1117,17 +1117,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1140,17 +1145,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1163,17 +1173,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false

75
schema/markdownlint-config-schema.json
View file

@ -628,17 +628,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -651,17 +651,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -674,17 +674,17 @@
],
"default": true,
"properties": {
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1117,17 +1117,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1140,17 +1145,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false
@ -1163,17 +1173,22 @@
],
"default": true,
"properties": {
"allow_preamble": {
"description": "Allow content before first heading",
"type": "boolean",
"default": false
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
},
"level": {
"description": "Heading level",
"type": "integer",
"minimum": 1,
"maximum": 6,
"default": 1
},
"front_matter_title": {
"description": "RegExp for matching title in front matter",
"type": "string",
"default": "^\\s*title\\s*[:=]"
}
},
"additionalProperties": false

22
test/first-line-heading-allow-preamble-false.md Normal file
View file

@ -0,0 +1,22 @@
Text {MD041}
<!-- Comment -->
Text
<p>HTML</p>
Text
- List item
# Heading
Text
<!-- markdownlint-configure-file {
"first-line-heading": {
"allow_preamble": false
},
"no-inline-html": false
} -->

22
test/first-line-heading-allow-preamble-h1.md Normal file
View file

@ -0,0 +1,22 @@
Text
<!-- Comment -->
Text
<p>HTML</p>
Text
- List item
<h1>Heading</h1>
Text
<!-- markdownlint-configure-file {
"first-line-heading": {
"allow_preamble": true
},
"no-inline-html": false
} -->

22
test/first-line-heading-allow-preamble-violation.md Normal file
View file

@ -0,0 +1,22 @@
Text
<!-- Comment -->
Text
<p>HTML</p>
Text
- List item
## Heading {MD041}
Text
<!-- markdownlint-configure-file {
"first-line-heading": {
"allow_preamble": true
},
"no-inline-html": false
} -->

22
test/first-line-heading-allow-preamble.md Normal file
View file

@ -0,0 +1,22 @@
Text
<!-- Comment -->
Text
<p>HTML</p>
Text
- List item
# Heading
Text
<!-- markdownlint-configure-file {
"first-line-heading": {
"allow_preamble": true
},
"no-inline-html": false
} -->

2
test/markdownlint-test.mjs
View file

@ -907,7 +907,7 @@ test("readme", async(t) => {
});
test("validateJsonUsingConfigSchemaStrict", async(t) => {
t.plan(192);
t.plan(196);
// @ts-ignore
const ajv = new Ajv(ajvOptions);
const validateSchemaStrict = ajv.compile(configSchemaStrict);

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

@ -13752,6 +13752,160 @@ Generated by [AVA](https://avajs.dev).
`,
}
## first-line-heading-allow-preamble-false.md
> Snapshot 1
{
errors: [
{
errorContext: 'Text {MD041}',
errorDetail: null,
errorRange: null,
fixInfo: null,
lineNumber: 1,
ruleDescription: 'First line in a file should be a top-level heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md041.md',
ruleNames: [
'MD041',
'first-line-heading',
'first-line-h1',
],
},
],
fixed: `Text {MD041}␊
␊
<!-- Comment -->␊
␊
Text␊
␊
<p>HTML</p>␊
␊
Text␊
␊
- List item␊
␊
# Heading␊
␊
Text␊
␊
<!-- markdownlint-configure-file {␊
"first-line-heading": {␊
"allow_preamble": false␊
},␊
"no-inline-html": false␊
} -->␊
`,
}
## first-line-heading-allow-preamble-h1.md
> Snapshot 1
{
errors: [],
fixed: `Text␊
␊
<!-- Comment -->␊
␊
Text␊
␊
<p>HTML</p>␊
␊
Text␊
␊
- List item␊
␊
<h1>Heading</h1>␊
␊
Text␊
␊
<!-- markdownlint-configure-file {␊
"first-line-heading": {␊
"allow_preamble": true␊
},␊
"no-inline-html": false␊
} -->␊
`,
}
## first-line-heading-allow-preamble-violation.md
> Snapshot 1
{
errors: [
{
errorContext: '## Heading {MD041}',
errorDetail: null,
errorRange: null,
fixInfo: null,
lineNumber: 13,
ruleDescription: 'First line in a file should be a top-level heading',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md041.md',
ruleNames: [
'MD041',
'first-line-heading',
'first-line-h1',
],
},
],
fixed: `Text␊
␊
<!-- Comment -->␊
␊
Text␊
␊
<p>HTML</p>␊
␊
Text␊
␊
- List item␊
␊
## Heading {MD041}␊
␊
Text␊
␊
<!-- markdownlint-configure-file {␊
"first-line-heading": {␊
"allow_preamble": true␊
},␊
"no-inline-html": false␊
} -->␊
`,
}
## first-line-heading-allow-preamble.md
> Snapshot 1
{
errors: [],
fixed: `Text␊
␊
<!-- Comment -->␊
␊
Text␊
␊
<p>HTML</p>␊
␊
Text␊
␊
- List item␊
␊
# Heading␊
␊
Text␊
␊
<!-- markdownlint-configure-file {␊
"first-line-heading": {␊
"allow_preamble": true␊
},␊
"no-inline-html": false␊
} -->␊
`,
}
## first_heading_bad_atx.md
> Snapshot 1

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

Binary file not shown.