Skip to content
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

Build: Update markdownlint dependency to 0.2.0 #6781

Closed
DavidAnson opened this issue Jul 28, 2016 · 3 comments
Closed

Build: Update markdownlint dependency to 0.2.0 #6781

DavidAnson opened this issue Jul 28, 2016 · 3 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion build This change relates to ESLint's build process enhancement This change enhances an existing feature of ESLint

Comments

@DavidAnson
Copy link
Contributor

Changes:

  • 0.2.0 - Add MD042/MD043, enhance MD002/MD003/MD004/MD007/MD011/MD025/MD041, dependencies.

PR to follow

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Jul 28, 2016
@nzakas
Copy link
Member

nzakas commented Jul 28, 2016

@DavidAnson can you explain why this upgrade is useful for us?

@nzakas nzakas added enhancement This change enhances an existing feature of ESLint build This change relates to ESLint's build process evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jul 28, 2016
@DavidAnson
Copy link
Contributor Author

@nzakas Sure!

There are two new rules:

  • MD042 no-empty-links - No empty links
  • MD043 required-headers - Required header structure

The first is automatically applied and makes sure no links are empty or just "#", both of which are common placeholder/editing mistakes. The second is not in effect, but could be used to ensure that all rule documentation had a common header structure like "Introduction, Details, Examples". It supports optional headers as well, so an "Exceptions" header might only appear on some pages (but always in the same place).

There are also a couple of bug fixes and improvements to other rules to make them more flexible. None of this breaks on current ESLint files, but the changes may help improve the life of a future developer one day.

Finally, the updated dependency (the package has only one) is for markdown-it, the underlying Markdown parser, and includes better support for the CommonMark specification. Again, nothing breaks today, but future issues should be less likely.

Hope this helps!

@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jul 29, 2016
@nzakas
Copy link
Member

nzakas commented Jul 29, 2016

That helps, thanks! We just like to have rationale for upgrading other than "it's nice to upgrade." :)

@nzakas nzakas closed this as completed in 2438ee2 Jul 29, 2016
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion build This change relates to ESLint's build process enhancement This change enhances an existing feature of ESLint
Projects
None yet
Development

No branches or pull requests

3 participants