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

chore: upgrade markdownlint to 0.31.1 #17754

Merged
merged 3 commits into from Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile.js
Expand Up @@ -16,7 +16,6 @@ const checker = require("npm-license"),
glob = require("glob"),
marked = require("marked"),
matter = require("gray-matter"),
markdownlint = require("markdownlint"),
os = require("os"),
path = require("path"),
semver = require("semver"),
Expand Down Expand Up @@ -431,6 +430,7 @@ function getFirstVersionOfDeletion(filePath) {
* @private
*/
function lintMarkdown(files) {
const markdownlint = require("markdownlint");
const config = yaml.load(fs.readFileSync(path.join(__dirname, "./.markdownlint.yml"), "utf8")),
result = markdownlint.sync({
files,
Expand Down
3 changes: 2 additions & 1 deletion docs/src/library/link-card.md
Expand Up @@ -10,6 +10,7 @@ Links can be rendered as cards by using the `link` shortcode. The only required

## Examples

<!-- markdownlint-disable-next-line MD034 -->
{% link "https://blog.izs.me/2010/12/an-open-letter-to-javascript-leaders-regarding/" %}

<!-- markdownlint-disable-next-line MD034 -->
{% link "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get" %}
2 changes: 1 addition & 1 deletion docs/src/rules/prefer-destructuring.md
Expand Up @@ -7,7 +7,7 @@ further_reading:
---



<!-- markdownlint-disable-next-line MD051 -->
With JavaScript ES6, a new syntax was added for creating variables from an array index or object property, called [destructuring](#further-reading). This rule enforces usage of destructuring instead of accessing a property through a member expression.
Comment on lines +10 to 11
Copy link
Contributor Author

@snitin315 snitin315 Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generate #further-reading during the build.


## Rule Details
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/template-tag-spacing.md
Expand Up @@ -7,7 +7,7 @@ further_reading:
---

This rule was **deprecated** in ESLint v8.53.0. Please use the corresponding rule in [`@stylistic/eslint-plugin-js`](https://eslint.style/packages/js).

<!-- markdownlint-disable-next-line MD051 -->
With ES6, it's possible to create functions called [tagged template literals](#further-reading) where the function parameters consist of a template literal's strings and expressions.

When using tagged template literals, it's possible to insert whitespace between the tag function and the template literal. Since this whitespace is optional, the following lines are equivalent:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -132,7 +132,7 @@
"gray-matter": "^4.0.3",
"lint-staged": "^11.0.0",
"load-perf": "^0.2.0",
"markdownlint": "^0.25.1",
"markdownlint": "^0.31.1",
"markdownlint-cli": "^0.37.0",
"marked": "^4.0.8",
"memfs": "^3.0.1",
Expand Down