-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
build(dev-deps): upgrade markdownlint-cli to latest v0.46.0
#5560
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(dev-deps): upgrade markdownlint-cli to latest v0.46.0
#5560
Conversation
Signed-off-by: hainenber <[email protected]>
Signed-off-by: hainenber <[email protected]>
markdownlint-cli to latest v0.46.0
mark-wiemer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting this started. We need to be very careful about changing links, esp ones posted on mochajs.org. Otherwise looks good, I'm OK with the increase in size of package-lock.json, most important is modern dependencies
| - fix: disabling timeouts with this.timeout(0) ([#1301](https://github.com/mochajs/mocha/issues/1301)) | ||
|
|
||
| # 1.22.1-3 / 2014-07-27 | ||
| # 1.21.3 / 2014-07-27 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's not change these headings, they might break links (very old links, but links nonetheless!)
If there is a rule making us change this, let's disable that rule, either globally or just for these two lines (line 624 and 628)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this isn't correct but can we merge duplicate sections of 1.22.1-3 heading? Functionality-wise, they refers to same section, tbh.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand that currently 1.22.1, 1.22.2, and 1.22.3 all are covered in this one section, yes, instead of each having their own section. Since this references something from 11 years ago, I'm considering it out of scope for this PR. If you have details about why markdownlint might be complaining about it I'm happy to review, but we want to make sure no potential links break. So if we do change this heading, we'd need to manually add a self-closing <a /> with the same name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay, I've ignored this Markdownlint issue in latest commit. This should be good to go.
docs/index.md
Outdated
| - [global variable leak detection](#-check-leaks) | ||
| - [optionally run tests that match a regexp](#-grep-regexp-g-regexp) | ||
| - [auto-exit to prevent "hanging" with an active loop](#-exit) | ||
| - [global variable leak detection](#--check-leaks) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this fixes the link in the Markdown file but breaks the link in the deployed HTML. The deployed HTML is much more important and we don't want to change the anchor as that would break other links to this section. Of course, we could add a redirect or a second anchor, but that's way out of scope I think.
For now, please revert changes to these links unless the fix HTML links. Again, let's disable any rule that's recommending we change these links: that rule isn't aware that this MD file is turning into an HTML one through a special process
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Applies throughout the file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done application for whole docs/index.md
| [//]: # "Cross reference section" | ||
| [bash-globbing]: https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html | ||
| [better-assert]: https://github.com/visionmedia/better-assert | ||
| [caniuse-notifications]: https://caniuse.com/#feat=notifications |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why remove these links?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these links are found to not to be referenced in the index.md, according to markdownlint. Hence the removal. In contrary to other items, I think these can be removed to light up a bit on the doc.
Co-authored-by: Mark Wiemer <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5560 +/- ##
=======================================
Coverage 93.52% 93.52%
=======================================
Files 57 57
Lines 4465 4465
Branches 918 918
=======================================
Hits 4176 4176
Misses 289 289 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: hainenber <[email protected]>
Signed-off-by: hainenber <[email protected]>
Signed-off-by: hainenber <[email protected]>
|
Tests are passing, failure is just a Codecov issue :) |
Co-authored-by: Josh Goldberg ✨ <[email protected]>
…-mod-not-found * 'ts-mod-not-found' of github.com:sam-super/mocha: feat: add mocha.mjs export (mochajs#5527) docs: bumped docs-next Astro to ^5.16.6 (mochajs#5574) build(dev-deps): upgrade `markdownlint-cli` to latest v0.46.0 (mochajs#5560)
PR Checklist
status: accepting prsOverview
This PR bumps
markdownlint-clito latest v0.46.0 and performed various refactors across Markdown files in the codebase to accompany changed lint rules brought bymarkdownlinttransitive depedency.There are huuuge amount of dev deps being pulled in for this version bump so the purpose is more of keeping dev deps up-to-date.