starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 17:26:22 +03:00

[GH-ISSUE #165] MD003: Settings in .markdownlint.json do not match parameter values #1991

New issue

Closed

opened 2026-03-07 20:03:27 +03:00 by kerem · 5 comments

kerem commented

2026-03-07 20:03:27 +03:00

Owner

Originally created by @chronoviking on GitHub (Feb 7, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/165

Per the documentation, the values for MD003 are:

Parameters: style ("consistent", "atx", "atx_closed", "setext", "setext_with_atx", "setext_with_atx_closed"; default "consistent")

However, when trying to add a value for MD003 in the .markdownlist.json file, it notifies the user that it should be a boolean value.

Whether the value is marked as false or "setext_with_atx", having mixed headings still show as an error.

Expected:

The .markdownlint.json file should prompt for the correct values for MD003
The value of MD003 should be respected by the interpreter

Originally created by @chronoviking on GitHub (Feb 7, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/165 Per the documentation, the values for MD003 are: > Parameters: style ("consistent", "atx", "atx_closed", "setext", "setext_with_atx", "setext_with_atx_closed"; default "consistent") However, when trying to add a value for MD003 in the .markdownlist.json file, it notifies the user that it should be a boolean value. Whether the value is marked as false or "setext_with_atx", having mixed headings still show as an error. Expected: * The .markdownlint.json file should prompt for the correct values for MD003 * The value of MD003 should be respected by the interpreter

kerem

2026-03-07 20:03:27 +03:00

closed this issue
added the
question
label

kerem commented

2026-03-07 20:03:28 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 7, 2019):

I am guessing you are doing this in the VS Code extension? If so, it sounds like the wrong syntax for specifying a perimeter value is being used. Here is an example of how to apply the setting you want:
github.com/DavidAnson/markdownlint@2710c375b3/test/headings_good_setext_with_atx.json

Please let me know if that doesn’t help - and include an example of the syntax you are using.

@DavidAnson commented on GitHub (Feb 7, 2019): I am guessing you are doing this in the VS Code extension? If so, it sounds like the wrong syntax for specifying a perimeter value is being used. Here is an example of how to apply the setting you want: https://github.com/DavidAnson/markdownlint/blob/2710c375b3c9b9b6531d546b667f50f7d0c956f2/test/headings_good_setext_with_atx.json Please let me know if that doesn’t help - and include an example of the syntax you are using.

kerem commented

2026-03-07 20:03:28 +03:00

Author

Owner

@chronoviking commented on GitHub (Feb 8, 2019):

Correct, I'm using the VSC extension. I followed the format from the link and it works. I was just setting the key directly as "setext_with_atx" instead of as an object.

Is there a reason why the tool tip says it needs to be a boolean value and not an object?

@chronoviking commented on GitHub (Feb 8, 2019): Correct, I'm using the VSC extension. I followed the format from the link and it works. I was just setting the key directly as "setext_with_atx" instead of as an object. Is there a reason why the tool tip says it needs to be a boolean value and not an object?

kerem commented

2026-03-07 20:03:29 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 8, 2019):

It’s because this syntax is valid to disable (or enable) the rule without modifying its parameters:
github.com/DavidAnson/markdownlint@2710c375b3/test/headings_with_spaces_at_the_beginning.json

@DavidAnson commented on GitHub (Feb 8, 2019): It’s because this syntax is valid to disable (or enable) the rule without modifying its parameters: https://github.com/DavidAnson/markdownlint/blob/2710c375b3c9b9b6531d546b667f50f7d0c956f2/test/headings_with_spaces_at_the_beginning.json

kerem commented

2026-03-07 20:03:29 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 8, 2019):

Once you create an object (instead of a Boolean), VS Code should prompt you with the valid parameters and values.

@DavidAnson commented on GitHub (Feb 8, 2019): Once you create an object (instead of a Boolean), VS Code should prompt you with the valid parameters and values.

kerem commented

2026-03-07 20:03:29 +03:00

Author

Owner

@chronoviking commented on GitHub (Feb 8, 2019):

Awesome.. Thank you for the clarification.

@chronoviking commented on GitHub (Feb 8, 2019): Awesome.. Thank you for the clarification.

kerem referenced this issue

2026-03-07 20:15:02 +03:00

[PR #1991] [MERGED] Bump terser-webpack-plugin from 5.3.16 to 5.3.17 #3700