markdownlint 0.31.1 → 0.32.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.32.1
+
+- Fix behavior of MD054
+
+## 0.32.0
+
+- Remove deprecated MD002/MD006
+- Remove rule aliases for "header"
+- Add MD054/link-image-style
+- Use `micromark` in MD005/MD007/MD030
+- Improve MD022/MD026/MD034/MD037/MD038/MD045/MD051
+- Improve JSON schema and related examples
+- Provide type declaration for Configuration object
+- Update dependencies
+
 ## 0.31.1
 
 - Improve MD032/MD034

package/CONTRIBUTING.md

@@ -73,8 +73,8 @@ In order to maintain the permissive MIT license this project uses, all
 contributions must be your own and released under that license. Code you add
 should be an original work and should not be copied from elsewhere. Taking code
 from a different project, Stack Overflow, or the like is not allowed. The use of
-tools such as GitHub Copilot that generate code from other projects is not
-allowed.
+tools such as GitHub Copilot, ChatGPT, LLMs (large language models), etc. that
+incorporate code from other projects is not allowed.
 
 Thank you!
 

package/README.md

@@ -67,7 +67,7 @@ and test cases came directly from that project.
 [nodejs-extensions]: https://github.com/Lombiq/NodeJs-Extensions
 [rubygems-mdl]: https://rubygems.org/gems/mdl
 [sublimelinter]: https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint
-[super-linter]: https://github.com/github/super-linter
+[super-linter]: https://github.com/super-linter/super-linter
 [vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
 
 ### References
@@ -86,12 +86,10 @@ playground for learning and exploring.
 
 <!-- markdownlint-disable line-length -->
 
-- **[MD001](doc/md001.md)** *heading-increment/header-increment* - Heading levels should only increment by one level at a time
-- ~~**[MD002](doc/md002.md)** *first-heading-h1/first-header-h1* - First heading should be a top-level heading~~
-- **[MD003](doc/md003.md)** *heading-style/header-style* - Heading style
+- **[MD001](doc/md001.md)** *heading-increment* - Heading levels should only increment by one level at a time
+- **[MD003](doc/md003.md)** *heading-style* - Heading style
 - **[MD004](doc/md004.md)** *ul-style* - Unordered list style
 - **[MD005](doc/md005.md)** *list-indent* - Inconsistent indentation for list items at the same level
-- ~~**[MD006](doc/md006.md)** *ul-start-left* - Consider starting bulleted lists at the beginning of the line~~
 - **[MD007](doc/md007.md)** *ul-indent* - Unordered list indentation
 - **[MD009](doc/md009.md)** *no-trailing-spaces* - Trailing spaces
 - **[MD010](doc/md010.md)** *no-hard-tabs* - Hard tabs
@@ -103,9 +101,9 @@ playground for learning and exploring.
 - **[MD019](doc/md019.md)** *no-multiple-space-atx* - Multiple spaces after hash on atx style heading
 - **[MD020](doc/md020.md)** *no-missing-space-closed-atx* - No space inside hashes on closed atx style heading
 - **[MD021](doc/md021.md)** *no-multiple-space-closed-atx* - Multiple spaces inside hashes on closed atx style heading
-- **[MD022](doc/md022.md)** *blanks-around-headings/blanks-around-headers* - Headings should be surrounded by blank lines
-- **[MD023](doc/md023.md)** *heading-start-left/header-start-left* - Headings must start at the beginning of the line
-- **[MD024](doc/md024.md)** *no-duplicate-heading/no-duplicate-header* - Multiple headings with the same content
+- **[MD022](doc/md022.md)** *blanks-around-headings* - Headings should be surrounded by blank lines
+- **[MD023](doc/md023.md)** *heading-start-left* - Headings must start at the beginning of the line
+- **[MD024](doc/md024.md)** *no-duplicate-heading* - Multiple headings with the same content
 - **[MD025](doc/md025.md)** *single-title/single-h1* - Multiple top-level headings in the same document
 - **[MD026](doc/md026.md)** *no-trailing-punctuation* - Trailing punctuation in heading
 - **[MD027](doc/md027.md)** *no-multiple-space-blockquote* - Multiple spaces after blockquote symbol
@@ -117,35 +115,30 @@ playground for learning and exploring.
 - **[MD033](doc/md033.md)** *no-inline-html* - Inline HTML
 - **[MD034](doc/md034.md)** *no-bare-urls* - Bare URL used
 - **[MD035](doc/md035.md)** *hr-style* - Horizontal rule style
-- **[MD036](doc/md036.md)** *no-emphasis-as-heading/no-emphasis-as-header* - Emphasis used instead of a heading
+- **[MD036](doc/md036.md)** *no-emphasis-as-heading* - Emphasis used instead of a heading
 - **[MD037](doc/md037.md)** *no-space-in-emphasis* - Spaces inside emphasis markers
 - **[MD038](doc/md038.md)** *no-space-in-code* - Spaces inside code span elements
 - **[MD039](doc/md039.md)** *no-space-in-links* - Spaces inside link text
 - **[MD040](doc/md040.md)** *fenced-code-language* - Fenced code blocks should have a language specified
 - **[MD041](doc/md041.md)** *first-line-heading/first-line-h1* - First line in a file should be a top-level heading
 - **[MD042](doc/md042.md)** *no-empty-links* - No empty links
-- **[MD043](doc/md043.md)** *required-headings/required-headers* - Required heading structure
+- **[MD043](doc/md043.md)** *required-headings* - Required heading structure
 - **[MD044](doc/md044.md)** *proper-names* - Proper names should have the correct capitalization
 - **[MD045](doc/md045.md)** *no-alt-text* - Images should have alternate text (alt text)
 - **[MD046](doc/md046.md)** *code-block-style* - Code block style
 - **[MD047](doc/md047.md)** *single-trailing-newline* - Files should end with a single newline character
 - **[MD048](doc/md048.md)** *code-fence-style* - Code fence style
-- **[MD049](doc/md049.md)** *emphasis-style* - Emphasis style should be consistent
-- **[MD050](doc/md050.md)** *strong-style* - Strong style should be consistent
+- **[MD049](doc/md049.md)** *emphasis-style* - Emphasis style
+- **[MD050](doc/md050.md)** *strong-style* - Strong style
 - **[MD051](doc/md051.md)** *link-fragments* - Link fragments should be valid
 - **[MD052](doc/md052.md)** *reference-links-images* - Reference links and images should use a label that is defined
 - **[MD053](doc/md053.md)** *link-image-reference-definitions* - Link and image reference definitions should be needed
+- **[MD054](doc/md054.md)** *link-image-style* - Link and image style
 
 <!-- markdownlint-restore -->
 
 See [Rules.md](doc/Rules.md) for more details.
 
-~~Struck through~~ rules are deprecated and provided for backward-compatibility.
-
-> All rules with `heading` as part of their name are also available as `header`
-> aliases (e.g. `heading-increment` is also available as `header-increment`).
-> The use of `header` is deprecated and provided for backward-compatibility.
-
 ### Custom Rules
 
 In addition to built-in rules, custom rules can be used to address
@@ -165,26 +158,24 @@ rules at once.
 - **`atx_closed`** - `MD020`, `MD021`
 - **`blank_lines`** - `MD012`, `MD022`, `MD031`, `MD032`, `MD047`
 - **`blockquote`** - `MD027`, `MD028`
-- **`bullet`** - `MD004`, `MD005`, `MD006`, `MD007`, `MD032`
+- **`bullet`** - `MD004`, `MD005`, `MD007`, `MD032`
 - **`code`** - `MD014`, `MD031`, `MD038`, `MD040`, `MD046`, `MD048`
 - **`emphasis`** - `MD036`, `MD037`, `MD049`, `MD050`
 - **`hard_tab`** - `MD010`
-- **`headers`** - `MD001`, `MD002`, `MD003`, `MD018`, `MD019`, `MD020`, `MD021`,
+- **`headings`** - `MD001`, `MD003`, `MD018`, `MD019`, `MD020`, `MD021`,
   `MD022`, `MD023`, `MD024`, `MD025`, `MD026`, `MD036`, `MD041`, `MD043`
-- **`headings`** - `MD001`, `MD002`, `MD003`, `MD018`, `MD019`, `MD020`,
-  `MD021`, `MD022`, `MD023`, `MD024`, `MD025`, `MD026`, `MD036`, `MD041`,
-  `MD043`
 - **`hr`** - `MD035`
 - **`html`** - `MD033`
-- **`images`** - `MD045`, `MD052`, `MD053`
-- **`indentation`** - `MD005`, `MD006`, `MD007`, `MD027`
+- **`images`** - `MD045`, `MD052`, `MD053`, `MD054`
+- **`indentation`** - `MD005`, `MD007`, `MD027`
 - **`language`** - `MD040`
 - **`line_length`** - `MD013`
-- **`links`** - `MD011`, `MD034`, `MD039`, `MD042`, `MD051`, `MD052`, `MD053`
+- **`links`** - `MD011`, `MD034`, `MD039`, `MD042`, `MD051`, `MD052`, `MD053`,
+  `MD054`
 - **`ol`** - `MD029`, `MD030`, `MD032`
 - **`spaces`** - `MD018`, `MD019`, `MD020`, `MD021`, `MD023`
 - **`spelling`** - `MD044`
-- **`ul`** - `MD004`, `MD005`, `MD006`, `MD007`, `MD030`, `MD032`
+- **`ul`** - `MD004`, `MD005`, `MD007`, `MD030`, `MD032`
 - **`url`** - `MD034`
 - **`whitespace`** - `MD009`, `MD010`, `MD012`, `MD027`, `MD028`, `MD030`,
   `MD037`, `MD038`, `MD039`
@@ -518,7 +509,7 @@ specify a custom `RegExp` or use the value `null` to disable the feature.
 The default value:
 
 ```javascript
-/((^---\s*$[\s\S]*?^---\s*)|(^\+\+\+\s*$[\s\S]*?^(\+\+\+|\.\.\.)\s*)|(^\{\s*$[\s\S]*?^\}\s*))(\r\n|\r|\n|$)/m
+/((^---\s*$[\s\S]+?^---\s*)|(^\+\+\+\s*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{\s*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m
 ```
 
 Ignores [YAML](https://en.wikipedia.org/wiki/YAML),