Closed
Description
Rule details
This rule will warn when spaces are missing after the hash characters in an atx style heading:
What type of rule is this?
Warns about a potential problem
Example code
Incorrect Code
#Heading 1
##Heading 2
Correct Code
# Heading 1
## Heading 2
Participation
- I am willing to submit a pull request to implement this rule.
Additional comments
Prior At: Rule
Metadata
Metadata
Assignees
Type
Projects
Status
Complete
Activity
Pixel998 commentedon May 10, 2025
@lumirlumir I think this is the rule you wanted to work on?
lumirlumir commentedon May 10, 2025
Thanks for mentioning me, @Pixel998. I mentioned this rule in another comment, but I didn’t raise an issue about it—so I’m fine with whoever decides to take it on.
It’s a good rule to implement, especially since it’s already covered in markdownlint.
That said, please keep in mind that this rule could be tricky to implement due to potential edge cases, since
##heading
is recognized as a normaltext
node (Maybe it could be another node too).I’m in favor of creating this rule, but I’d like to hear what the rest of the team thinks before moving forward. @eslint/eslint-team
Also, the name of this rule should be shortened, it's a bit too long to be practical as a rule name.
I recommend to use
no-missing-space-atx
or similar. This name was used inmarkdownlint
.SwetaTanwar commentedon May 10, 2025
I will pick this up and submit a PR
snitin315 commentedon May 11, 2025
👍🏻 for
no-missing-space-atx
, I think we should also have this as a recommendation.