Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 05:50:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update MD010/no-hard-tabs to add ignore_code_languages parameter (fixes #383).

Browse source
This commit is contained in:
David Anson 2022-04-28 21:09:06 -07:00
parent 0f845e9ba1
commit b447c809bd
9 changed files with 112 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/Rules.md
View file

@ -396,7 +396,7 @@ Tags: whitespace, hard_tab
Aliases: no-hard-tabs
Parameters: code_blocks, spaces_per_tab (boolean; default true, number; default 1)
Parameters: code_blocks, ignore_code_languages, spaces_per_tab (boolean; default true, array of string; default empty, number; default 1)
Fixable: Most violations can be fixed by tooling
@ -429,6 +429,12 @@ set the `code_blocks` parameter to `false`. Code blocks and spans are included
by default since handling of tabs by Markdown tools can be inconsistent (e.g.,
using 4 vs. 8 spaces).
When code blocks are scanned (e.g., by default or if `code_blocks` is `true`),
the `ignore_code_languages` parameter can be set to a list of languages that
should be ignored (i.e., hard tabs will be allowed, though not required). This
makes it easier for documents to include code for languages that require hard
tabs.
By default, violations of this rule are fixed by replacing the tab with 1 space
character. To use a different number of spaces, set the `spaces_per_tab`
parameter to the desired value.