chore: Expand MarkdownLint CI paths #7146

nschonni · 2021-07-22T02:35:02Z

No description provided.

github-actions · 2021-07-22T02:37:27Z

Preview URLs

Flaws

Note! 33 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness
Title: Equality comparisons and sameness
on GitHub
Flaw count: 3

broken_links:
- Is currently http:// but can become https://
- Is currently http:// but can become https://
- Is currently http:// but can become https://

URL: /en-US/docs/Web/JavaScript/Reference/Statements/const
Title: const
on GitHub
Flaw count: 3

broken_links:
- Anchor not lowercase
- Anchor not lowercase
- Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
Title: Destructuring assignment
on GitHub
Flaw count: 2

broken_links:
- Anchor not lowercase
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Operators/Assignment_Operators

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind
Title: Function.prototype.bind()
on GitHub
Flaw count: 1

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/prototype does not exist

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/any
Title: Promise.any()
on GitHub
Flaw count: 1

broken_links:
- Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Functions
Title: Functions
on GitHub
Flaw count: 3

broken_links:
- Can't resolve /en-US/docs/JavaScript/Reference/Functions_and_function_scope/arguments/caller
- Can't resolve /en-US/docs/Mozilla/Projects/SpiderMonkey
- Link points to the page it's already on

URL: /en-US/docs/Web/JavaScript/JavaScript_technologies_overview
Title: JavaScript technologies overview
on GitHub
Flaw count: 10

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/prototype does not exist
broken_links:
- Can't resolve /en-US/docs/Web/Reference/API
- Is currently http:// but can become https://
- Can't resolve /en-US/docs/Web/JavaScript/New_in_JavaScript/ECMAScript_5_support_in_Mozilla
- Can't resolve /en-US/docs/Web/JavaScript/New_in_JavaScript/ECMAScript_2015_support_in_Mozilla
- Is currently http:// but can become https://
- and 4 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet
Title: Regular expression syntax cheatsheet
on GitHub
Flaw count: 5

heading_links:
- h2 heading contains an <a> tag
- h2 heading contains an <a> tag
- h2 heading contains an <a> tag
- h2 heading contains an <a> tag
- h2 heading contains an <a> tag

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Assertions
Title: Assertions
on GitHub
Flaw count: 1

broken_links:
- Link points to the page it's already on

URL: /en-US/docs/Web/JavaScript/Closures
Title: Closures
on GitHub
Flaw count: 1

broken_links:
- Is currently http:// but can become https://

External URLs

URL: /en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness
Title: Equality comparisons and sameness
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Statements/var
Title: var
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Statements/let
Title: let
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Statements/const
Title: const
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Statements/Empty
Title: empty
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Errors/Not_a_function
Title: TypeError: "x" is not a function
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Errors/Reduce_of_empty_array_with_no_initial_value
Title: TypeError: Reduce of empty array with no initial value
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Errors/Invalid_for-of_initializer
Title: SyntaxError: a declaration in the head of a for-of loop can't have an initializer
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
Title: Destructuring assignment
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/instanceof
Title: instanceof
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Classes/static
Title: static
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON
Title: JSON
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/parseFloat
Title: Number.parseFloat()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values
Title: Array.prototype.values()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt
Title: BigInt
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect/Comparing_Reflect_and_Object_methods
Title: Comparing Reflect and Object methods
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect/construct
Title: Reflect.construct()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/resolvedOptions
Title: Intl.NumberFormat.prototype.resolvedOptions()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/Segments
Title: Intl.Segmenter.Segments
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/Segments/@@iterator
Title: Intl.Segmenter.Segments.containing.@@iterator
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/Segments/containing
Title: Intl.Segmenter.Segments.containing
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics
Title: Atomics
on GitHub

https://github.com/lars-t-hansen/parlib-simple (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind
Title: Function.prototype.bind()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
Title: SharedArrayBuffer
on GitHub

https://github.com/lars-t-hansen/parlib-simple (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/any
Title: Promise.any()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/values
Title: TypedArray.prototype.values()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
Title: Symbol
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round
Title: Math.round()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd
Title: String.prototype.padEnd()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart
Title: String.prototype.padStart()
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Functions
Title: Functions
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Inheritance_and_the_prototype_chain
Title: Inheritance and the prototype chain
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/JavaScript_technologies_overview
Title: JavaScript technologies overview
on GitHub

https://www.whatwg.org/specs/web-workers/current-work/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties
Title: Enumerability and ownership of properties
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Indexed_collections
Title: Indexed collections
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Loops_and_iteration
Title: Loops and iteration
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Grammar_and_types
Title: Grammar and types
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Unicode_Property_Escapes
Title: Unicode property escapes
on GitHub

https://tc39.es/ecma262/ (4 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr18/ (4 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr44/ (4 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr51/ (1 time) (Note! This may be a new URL 👀)
https://www.unicode.org/Public/UCD/latest/ucd/PropList.txt (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet
Title: Regular expression syntax cheatsheet
on GitHub

https://tc39.es/ecma262/ (2 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr18/ (2 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr44/ (4 times) (Note! This may be a new URL 👀)
https://unicode.org/reports/tr51/ (1 time) (Note! This may be a new URL 👀)
https://www.unicode.org/Public/UCD/latest/ucd/PropList.txt (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Groups_and_Ranges
Title: Groups and ranges
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Assertions
Title: Assertions
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators
Title: Expressions and operators
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Closures
Title: Closures
on GitHub

No new external URLs

(this comment was updated 2021-07-22 02:46:24.597156)

nschonni

Missed whitespace fixups

files/en-us/web/javascript/closures/index.md

files/en-us/web/javascript/javascript_technologies_overview/index.md

files/en-us/web/javascript/reference/errors/invalid_for-of_initializer/index.md

files/en-us/web/javascript/reference/global_objects/atomics/index.md

files/en-us/web/javascript/reference/global_objects/sharedarraybuffer/index.md

files/en-us/web/javascript/reference/statements/empty/index.md

Rumyra · 2021-07-22T09:27:24Z

I assume this is linting the new markdown docs - @wbamberg would you be able to take a look, it all seems fine to me but it would be good to get another pair of eyes. This changes markdown-lint.yml and I guess that's why tests have failed and I'm probably going to have to force merge this. Thanks!

wbamberg · 2021-07-26T21:56:20Z

Thanks for this PR @nschonni ! Could you please add a description or a comment explaining what it's doing?

nschonni · 2021-07-26T22:02:28Z

Sorry, I guess I missed that when I opened it.
The original Markdownlint job was scoped to just the project admin files.
This expands it out to include all files as they are converted to Markdown. There are some rules that are currently failing and may never be fixed, so they've been disabled in .markdownlint.json. Many rules can now by auto-fixed with markdownlint . --fix after enabling the rule in the config.

nschonni · 2021-07-26T22:03:44Z

Could add a problem matcher to add inline comments to the PR here, or add it later

wbamberg · 2021-07-28T02:27:10Z

Thanks @nschonni ! I will take a look at this but it might take me a little time :).

Ryuno-Ki · 2021-07-28T19:19:06Z

@nschonni Do you know someone with Admin privileges to take care of the failing check in the meantime?

nschonni · 2021-07-28T20:07:19Z

@Ryuno-Ki think it needs to be someone in

content/.github/CODEOWNERS

Line 91 in 07e5b08

/.github/ @mdn/core-yari-dev

Ryuno-Ki · 2021-07-29T20:04:53Z

https://github.com/mdn/content/blob/main/REVIEWING.md#topic-review-owners says

Note that changes to any content areas not explicitly listed below will be handled by the @core-yari-content team, which currently consists of @Rumyra.

Ryuno-Ki · 2021-07-29T20:05:19Z

So @Rumyra might know, who that would be for dev (instead of content).

Rumyra · 2021-07-31T11:39:35Z

I'll wait for @wbamberg to have a closer look, then check this out 👍

nschonni · 2021-08-19T13:06:18Z

Ping @wbamberg

wbamberg

Thanks for this PR, and sorry to be so slow looking at it. I've been deep in some thickets of ancient HTML.

as far as I can tell this works just fine to enable markdownlint for mdn/content
I think enabling markdownlint for mdn/content is a good idea
the rules seem sensible and compatible with the converted Markdown we have (which is post-Prettier). I couldn't find any enabled rules which I disagreed with
I had a few questions, which are all about rules I'd love us to be able to enable. But I understand we might not want to fix up the content yet. Maybe we should file some issues like "Enable markdownlint MD001"?

I think this will need some documentation in the project README so contributors don't get frustrated by build failures.

I'd also like to hear wider feedback from people not just about the specific rules to enforce but about our general policy for which CI tools we should be running for mdn/content.

wbamberg · 2021-08-24T01:15:36Z

.markdownlint.json

@@ -0,0 +1,22 @@
+{
+  "default": true,
+  "MD001": false,


Would be great to enable this one. How many failures do we get with it enabled?

This rule is triggered when you skip heading levels in a markdown document

(https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md001---heading-levels-should-only-increment-by-one-level-at-a-time)

files/en-us/web/javascript/guide/details_of_the_object_model/index.md:136 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4] files/en-us/web/javascript/guide/using_promises/index.md:306 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4] files/en-us/web/javascript/memory_management/index.md:192 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4] files/en-us/web/javascript/reference/functions/rest_parameters/index.md:52 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4] files/en-us/web/javascript/reference/global_objects/object/create/index.md:159 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

wbamberg · 2021-08-24T01:19:32Z

.markdownlint.json

+  "MD010": false,
+  "MD013": false,
+  "MD024": false,
+  "MD026": false,


Would be nice to enable this one IMO:

This rule is triggered on any heading that has one of the specified normal or full-width punctuation characters as the last character in the line

(https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md026---trailing-punctuation-in-heading)

I wonder how many failures it would give us :).

files/en-us/web/javascript/data_structures/index.md:129:43 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '!'] files/en-us/web/javascript/reference/functions/rest_parameters/index.md:200:65 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.'] files/en-us/web/javascript/reference/global_objects/eval/index.md:95:20 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '!']

wbamberg · 2021-08-24T01:23:31Z

.markdownlint.json

+  "MD036": false,
+  "MD037": false,
+  "MD040": false,
+  "MD042": false,


Would also be great to enable this one:

This rule is triggered when an empty link is encountered:

[an empty link]()

(https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md042---no-empty-links)

Mostly just needs some escaping of the square backets

files/en-us/web/javascript/reference/global_objects/array/index.md:359:60 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/bigint64array/index.md:100:61 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/biguint64array/index.md:100:62 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/float32array/index.md:98:60 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/float64array/index.md:98:60 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/int16array/index.md:98:60 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/int8array/index.md:99:57 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/map/index.md:305:44 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@match/index.md:105:61 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@match/index.md:106:60 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@match/index.md:107:59 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@replace/index.md:120:59 MD042/no-empty-links No empty links [Context: "[@@match]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@replace/index.md:121:60 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@replace/index.md:122:59 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@search/index.md:101:59 MD042/no-empty-links No empty links [Context: "[@@match]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@search/index.md:102:61 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@search/index.md:103:59 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@split/index.md:104:59 MD042/no-empty-links No empty links [Context: "[@@match]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@split/index.md:105:61 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/regexp/@@split/index.md:106:60 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/regexp/index.md:99:59 MD042/no-empty-links No empty links [Context: "[@@match]()"] files/en-us/web/javascript/reference/global_objects/regexp/index.md:101:62 MD042/no-empty-links No empty links [Context: "[@@matchAll]()"] files/en-us/web/javascript/reference/global_objects/regexp/index.md:103:61 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/regexp/index.md:105:60 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/regexp/index.md:107:59 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/set/index.md:61:56 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:24:48 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:25:58 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:26:50 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:27:44 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:28:44 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:94:48 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:95:58 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:96:50 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:97:44 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/iterator/index.md:98:44 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/symbol/match/index.md:60:47 MD042/no-empty-links No empty links [Context: "[@@match]()"] files/en-us/web/javascript/reference/global_objects/symbol/matchall/index.md:20:134 MD042/no-empty-links No empty links [Context: "[@@matchAll]()"] files/en-us/web/javascript/reference/global_objects/symbol/matchall/index.md:51:98 MD042/no-empty-links No empty links [Context: "[@@matchAll]()"] files/en-us/web/javascript/reference/global_objects/symbol/matchall/index.md:65:50 MD042/no-empty-links No empty links [Context: "[@@matchAll]()"] files/en-us/web/javascript/reference/global_objects/symbol/replace/index.md:16:73 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/symbol/replace/index.md:52:49 MD042/no-empty-links No empty links [Context: "[@@replace]()"] files/en-us/web/javascript/reference/global_objects/symbol/search/index.md:16:72 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/symbol/search/index.md:52:48 MD042/no-empty-links No empty links [Context: "[@@search]()"] files/en-us/web/javascript/reference/global_objects/symbol/split/index.md:16:71 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/symbol/split/index.md:50:47 MD042/no-empty-links No empty links [Context: "[@@split]()"] files/en-us/web/javascript/reference/global_objects/typedarray/entries/index.md:75:26 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/typedarray/index.md:231:26 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/typedarray/keys/index.md:75:26 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/uint16array/index.md:99:59 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/uint32array/index.md:98:59 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/uint8array/index.md:99:58 MD042/no-empty-links No empty links [Context: "[@@iterator]()"] files/en-us/web/javascript/reference/global_objects/uint8clampedarray/index.md:98:65 MD042/no-empty-links No empty links [Context: "[@@iterator]()"]

wbamberg · 2021-08-24T01:25:03Z

.markdownlint.json

+  "MD037": false,
+  "MD040": false,
+  "MD042": false,
+  "MD045": false,


Would also be great to enable this one:

This rule is triggered when an image is missing alternate text (alt text) information.

(https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md045---images-should-have-alternate-text-alt-text)

files/en-us/web/javascript/guide/details_of_the_object_model/index.md:116 MD045/no-alt-text Images should have alternate text (alt text) files/en-us/web/javascript/guide/details_of_the_object_model/index.md:244 MD045/no-alt-text Images should have alternate text (alt text) files/en-us/web/javascript/guide/introduction/index.md:94 MD045/no-alt-text Images should have alternate text (alt text) files/en-us/web/javascript/reference/global_objects/math/index.md:151 MD045/no-alt-text Images should have alternate text (alt text) files/en-us/web/javascript/reference/global_objects/promise/index.md:36 MD045/no-alt-text Images should have alternate text (alt text)

wbamberg

Thanks for adding the lists of files which need updates for us to enable those rules! I will file issues to enable them, but think we should wait until all the content is Markdownified before we try to enable them. Otherwise it's just another barrier to getting into Markdown.

I do think before we can merge this we should have an easy way for people to run the linter locally, and document that in the contribution docs. We do something similar for BCD (https://github.com/mdn/browser-compat-data/blob/main/docs/testing.md#validate-the-data) and interactive examples (https://github.com/mdn/interactive-examples/blob/master/JS-Example-Style-Guide.md#javascript-coding-style). What do you think?

nschonni · 2021-08-24T16:30:04Z

I will file issues to enable them, but think we should wait until all the content is Markdownified before we try to enable them.

Yes, those are a little more difficult to automate/fix, but I think the other rules are good to have during the convesion, as they can pick up potential rendering issues as the files are converted

nschonni · 2021-08-24T16:33:18Z

I do think before we can merge this we should have an easy way for people to run the linter locally, and document that in the contribution docs.

I kept this isolated to the CI, but there is no reason it couldn't be added to the actual package.json as an extra target. I'm not sure the best place for the documentation though. It seems like most of it is in the README.md currently

Elchi3 · 2021-11-26T11:39:46Z

@ddbeck and I talked about this stalled PR. I opened #10787 to discuss next steps and I'm closing here. Thanks for your input!

nschonni added 12 commits July 21, 2021 21:03

fix: MD046/code-block-style

eb035c9

fix: MD039/no-space-in-links

73a7953

fix: MD038 space in code span

2977adf

fix: MD009 trailing space

0be6b24

fix: MD012 multiple blanks

86d9995

fix: MD032

dd1216e

fix: MD007/ul-indent

5fa4d52

fix: MD004 unordered list dashed style

e69e3db

chore: Enable MD022

84140d8

chore: Enable MD025

95784cc

fix: MD034 bare links

da6ec55

chore: Expand MarkdownLint CI paths

3d472bf

nschonni requested a review from a team as a code owner July 22, 2021 02:35

nschonni requested a review from a team July 22, 2021 02:35

nschonni requested a review from a team as a code owner July 22, 2021 02:35

nschonni requested review from Rumyra and Gregoor and removed request for a team July 22, 2021 02:35

nschonni commented Jul 22, 2021

View reviewed changes

fix: Link whitespaces

f842f6e

wbamberg reviewed Aug 24, 2021

View reviewed changes

wbamberg requested changes Aug 24, 2021

View reviewed changes

Elchi3 mentioned this pull request Nov 26, 2021

Add a Markdown linter for all .md files #10787

Closed

7 tasks

Elchi3 closed this Nov 26, 2021

nschonni deleted the markdownlint branch September 10, 2022 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Expand MarkdownLint CI paths #7146

chore: Expand MarkdownLint CI paths #7146

nschonni commented Jul 22, 2021

github-actions bot commented Jul 22, 2021 •

edited

Loading

nschonni left a comment

Rumyra commented Jul 22, 2021

wbamberg commented Jul 26, 2021

nschonni commented Jul 26, 2021

nschonni commented Jul 26, 2021

wbamberg commented Jul 28, 2021

Ryuno-Ki commented Jul 28, 2021

nschonni commented Jul 28, 2021

Ryuno-Ki commented Jul 29, 2021

Ryuno-Ki commented Jul 29, 2021

Rumyra commented Jul 31, 2021

nschonni commented Aug 19, 2021

wbamberg left a comment

wbamberg Aug 24, 2021

nschonni Aug 24, 2021

wbamberg Aug 24, 2021

nschonni Aug 24, 2021

wbamberg Aug 24, 2021

nschonni Aug 24, 2021 •

edited

Loading

wbamberg Aug 24, 2021

nschonni Aug 24, 2021

wbamberg left a comment

nschonni commented Aug 24, 2021

nschonni commented Aug 24, 2021

Elchi3 commented Nov 26, 2021 •

edited

Loading

chore: Expand MarkdownLint CI paths #7146

chore: Expand MarkdownLint CI paths #7146

Conversation

nschonni commented Jul 22, 2021

github-actions bot commented Jul 22, 2021 • edited Loading

Preview URLs

Flaws

External URLs

nschonni left a comment

Choose a reason for hiding this comment

Rumyra commented Jul 22, 2021

wbamberg commented Jul 26, 2021

nschonni commented Jul 26, 2021

nschonni commented Jul 26, 2021

wbamberg commented Jul 28, 2021

Ryuno-Ki commented Jul 28, 2021

nschonni commented Jul 28, 2021

Ryuno-Ki commented Jul 29, 2021

Ryuno-Ki commented Jul 29, 2021

Rumyra commented Jul 31, 2021

nschonni commented Aug 19, 2021

wbamberg left a comment

Choose a reason for hiding this comment

wbamberg Aug 24, 2021

Choose a reason for hiding this comment

nschonni Aug 24, 2021

Choose a reason for hiding this comment

wbamberg Aug 24, 2021

Choose a reason for hiding this comment

nschonni Aug 24, 2021

Choose a reason for hiding this comment

wbamberg Aug 24, 2021

Choose a reason for hiding this comment

nschonni Aug 24, 2021 • edited Loading

Choose a reason for hiding this comment

wbamberg Aug 24, 2021

Choose a reason for hiding this comment

nschonni Aug 24, 2021

Choose a reason for hiding this comment

wbamberg left a comment

Choose a reason for hiding this comment

nschonni commented Aug 24, 2021

nschonni commented Aug 24, 2021

Elchi3 commented Nov 26, 2021 • edited Loading

github-actions bot commented Jul 22, 2021 •

edited

Loading

nschonni Aug 24, 2021 •

edited

Loading

Elchi3 commented Nov 26, 2021 •

edited

Loading