markdown linting #47
Comments
|
ty Pete! |
|
No problem Kai. I quite like the idea of enforcing clean output :) I'm curious why you only got one type of linting error from that vscode package. The default lint config meant I had to ignore more than one rule: Whereas their standard config seems to only ignore the |
|
mhm maybe I haven't noticed it prior, but their checks are complaining about first headline not being top level heading h1. https://github.com/DavidAnson/markdownlint/blob/v0.10.0/doc/Rules.md#md002 Maybe you can review that too? :) |
|
Yeah I've added |
|
Ok, ty for your response. As we keep our other markdown files aligned their checks we can't set this to auto-ignore. we will keep our eyes then closed for the changelog ;-) |
|
Aha sorry Kai :) Maybe you could ignore the changelog file in the markdownlint options? It would make 5086228 a bit redundant but I suppose it was nice to clean up the output. |
|
ah thanks for pointing on this, will have an eye on that too. |
b6pzeusbc54tvhw5jgpyw8pwz2x6gs
pushed a commit
to b6pzeusbc54tvhw5jgpyw8pwz2x6gs/auto-changelog
that referenced
this issue
Sep 19, 2018
Feels cleaner to use http://shields.io for everything Remove todo list from readme Should ideally be issues on github Add option for specifying output file Fixes cookpete#1 and cleans stuff up a bit Add newline at end of generated logs Add support for --package Uses the version from package.json as the latest version, which lets you do cool stuff like generating a changelog as part of a version bump commit, see README.md for more Generate changelog on version 0.1.0 Fix --package bug Prefixing inside generateLog caused the param to always be truthy, which messed up parseReleases Explicitly render links for PRs and issues GitHub doesn't automatically parse them in markdown files like it does for PRs, issues and comments 0.1.1 Add FAQ to readme Rearrange usage docs Add support for specifying templates Also add a simple compact template Start using compact changelog It just seems.. nicer Lint and test before versioning 0.2.0 Replace toLocaleString usage with months array Not supported in node 0.10 0.2.1 Update templating logic Cleans up how logs are rendered Keeps things DRY between the two templates More sensible formatDate There was no point making it an external function in Compact when it's already a class method in Default Add a commit-only release to test data Beefs up the rendering tests a bit, covering more bases 0.2.2 Add support for minimumChangeCount in templates Backfill release notes with commits up to the given threshold Prevents releases that list only a single merge or fix, even if larger changes may have been commited as well Add semicolons after class properties To support babel 6.4.x Remove unique issue filter Broken since storing several issues per commit, so now causes more problems than it solves Case insensitive issue URL parsing 0.3.0 Bump packages Lint fixes Correct find polyfill usage More robust log separators Improve cmd util Improve origin URL parsing Fixes cookpete#2 and fixes cookpete#5 Improve error handling Add extra commits test Use template literal for success string Bump packages Remove semicolons No longer required with latest version of standard 0.3.1 Prevent duplicate commits being listed Fixes cookpete#3 0.3.2 Lint fix Bump packages And add yarn lockfile Fixes cookpete#7 Use babel-preset-env 0.3.3 Update travis to use later versions of node Add code coverage Remove parseInt radix No longer required by standard Fix travis node versions Tweak default template date format Disable codecov comments and build status Add yarn cache to travis config Generate coverage reports when testing locally Remove need for array.find polyfill Use async/await instead of promises Tweak version script 0.3.4 Add babel-polyfill Fixes cookpete#8 Requires babel-polyfill to be imported before the main file due to aggressing async function hoisting babel/babel#6206 0.3.5 Use origin hostname instead of host `host` includes the port number, which can break links Hopefully fixes cookpete#9 Correct bitbucket compare URLs 0.3.6 Improved issue matching Now supports any generic issue URL that contains `/issues/{number}` Update dependencies to enable Greenkeeper 🌴 (cookpete#10) * chore(package): update dependencies * docs(readme): add Greenkeeper badge Tweak readme badges Remove dependency status badges With greenkeeper enabled, they will pretty much always been up to date, right? Refactor codebase Add greenkeeper-lockfile support 1.0.0 Update readme Filter out commits with the same message as an existing merge 1.0.1 Tweak package read logic Fall back to https origin protocol 1.0.2 Tweak version script Fix pull request URL Bump packages Limit origin protocol to http or https Fix version script babel-node was erroring when using -p 1.0.3 Tidy options logic Keep coverage files inside test directory Tweak origin properties Add origin tests Add script to generate test data Update clean script Refactor run logic Add run tests Move test origins to separate file Exclude index.js from test coverage Remove unused options param from cmd util Tweak removeIndentation util Add util tests Fix multiple issue URL parsing Support modifying commit limit with --commit-limit (cookpete#12) * Support modifying commit limit with --commit-limit * Tidy up commit limit logic 1.1.0 Update readme Parse squash merge commits with no commit message Update formatting of shameless plug in templates Add npm script for generating test data Parse squash commits with broken messages Slightly larger heading for major releases Add major release to test data Add issue-url option to override issue URLs Fixes cookpete#13 Add basic requirements to readme 1.2.0 Use commander instance Increase test coverage Add commit with matching PR message to test data To ensure the commit is filtered out of changelogs Add commit to test data to trigger sorting Add tests Remove support for broken message squash merge Filter out merge commits Closes cookpete#14 Parse commits that close pull requests 1.2.1 Fix error when using --unreleased flag Fixes cookpete#16 1.2.2 Update fs-extra to the latest version 🚀 (cookpete#19) * fix(package): update fs-extra to version 5.0.0 * chore(package): update lockfile https://npm.im/greenkeeper-lockfile Add --latest-version option Closes cookpete#17 Update tests Add --issue-pattern option Closes cookpete#18 Override package options with command line options Add --starting-commit option Closes cookpete#21 1.3.0 Add merge commit to test data Add package version test Add --tag-prefix option Closes cookpete#22 Add --ignore-commit-pattern option Update niceDate tests to avoid timezone issues Fixes cookpete#24 Closes cookpete#25 The formatting is the main thing we want to test, not the exact date being correct (we can assume the JS engine will not fail us). Add support for generating logs without a git remote Fixes cookpete#23 Change use of "origin" to "remote" "origin" doesn't really make sense, as it is just the name of the default remote for most repos "remote" is more correct in the context of the code Fix tag prefix logic Update mocha to the latest version 🚀 (cookpete#26) * chore(package): update mocha to version 5.0.0 * chore(package): update lockfile https://npm.im/greenkeeper-lockfile 1.4.0 Support commits with no message Fixes cookpete#27 1.4.1 Update standard to the latest version 🚀 (cookpete#29) * chore(package): update standard to version 11.0.0 * chore(package): update lockfile https://npm.im/greenkeeper-lockfile * Lint fix Support for gitlab subgroups and self-hosted instances (cookpete#28) 1.4.2 Add tag prefix to compare URLs Fixes cookpete#30 1.4.3 Do not show date for unreleased section Fixes cookpete#31 Fix unreleased compare URL 1.4.4 Correctly prefix package version Fixes cookpete#33 1.4.5 Added support for old git versions (cookpete#35) 1.4.6 Use UTC dates by default Fixes cookpete#37 Add commit-list template helper Fixes cookpete#36 and fixes cookpete#39 Remove unused imports from template tests Feat: match template helper (cookpete#40) Move helper tests to separate files 1.5.0 Add --include-branch option Fixes cookpete#38 Fix duplicate test data commit hashes Add --breaking-pattern option Fixes cookpete#41 1.6.0 Add replaceText package option 1.7.0 Fix releases sorting when unreleased enabled (cookpete#45) Update git log format to support earlier git versions Fixes cookpete#43 Use async fs utils instead of fs-extra Closes cookpete#42 Also, tidies up imports 1.7.1 Remove node 4 and 5 from travis builds Enable partial line coverage with codecov Also move coverage into root Use %B for supported git versions The fallback was causing problems for commit messages with single newlines Add engines to package.json Add markdown linting Fixes cookpete#47 Fix changelog spacing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hey @cookpete :)
I just want to point you to Visual Studio Code Editor and the plugin https://github.com/DavidAnson/vscode-markdownlint. It brings some styling issues up when having the generated changelog open. For sure this is a question if you want to go into the direction to follow a standard markdown format. Basically the changelog looks fine and does what it should do. But maybe this is still of interest for you. :)
The fix should also be easy to implement as that plugin does only claim about vialoting the following rule:
https://github.com/DavidAnson/markdownlint/blob/v0.10.0/doc/Rules.md#md022
That's all :)
Cheers
Kai
The text was updated successfully, but these errors were encountered: