-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generated markdown does not pass lint test #5
Comments
This extension provides snippets that respect the ruleset of Keep a Changelog and does not take any linter into account. If you scroll down to their QnA and read the The only thing I could do is to add an extension option to add newlines around headers but that won't be enabled by default. |
If they didn't create it with a special format in mind, that means there should be no issue with you altering the whitespace in the template, right? A setting would be great if that's all you're willing to do. At the end of the day, my changelog is a markdown file like any other. The keep a changelog guidelines are not violated when manipulating whitespace, IMHO. The rationale listed for this markdown rule also makes this somewhat a functional issue as well:
Thanks for the quick response! |
Looking at the code, would it be reasonable to just have the snippets themselves in settings so folks can edit them however they want? |
Edit: implemented as default behavior |
There are some minor formatting issues with the generated markdown. Mainly has to do with insufficient newlines.
Tests were performed with the markdownlint extension installed in VS Code. I also edit my
CHANGELOG.md
file in VS Code.Steps to reproduce
MARKDOWN.md
file in VS Code.[Unreleased]
header, as shown in FIGURE1 (at the bottom of this issue).c
, then CTRL+SPACE (to auto-complete) and selectcl-added
. Press ENTER.The generated markdown (FIGURE2 below) has several markdown lint violations of type MD022/blanks-around-headings/blanks-around-headers:
Expected Output
The markdown (based on FIGURE2) that is expected is below:
Specifically:
## [Unreleased]
and### Added
### Added
and-
(the first bullet point item in the list of added items)-
and the next section header, which is### Changed
in my case.Supporting Attachments
FIGURE1:
FIGURE2:
The text was updated successfully, but these errors were encountered: