Add eslint-plugin-markdown for JavaScript code samples in documentation #134
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmish
force-pushed
the
eslint-plugin-markdown
branch
2 times, most recently
from
1d67970 to
cddad8c
Compare
aladdin-add
requested changes
Jun 17, 2021
docs/rules/consistent-output.md
Outdated
| @@ -13,51 +13,45 @@ This rule aims to ensure that if any invalid test cases have output assertions, | |||
| Examples of **incorrect** code for this rule: | |||
|
|
|||
| ```js | |||
| /* eslint eslint-plugin/consistent-output: error */ | |||
|
|
|||
There was a problem hiding this comment.
why removing the inline config?
There was a problem hiding this comment.
I just added the inline configs back. I thought it seemed redundant and not all of the rule doc examples use it. But we can leave as-is for now.
.eslintrc.js
Outdated
| plugins: ['markdown'], | ||
| parserOptions: { | ||
| sourceType: 'module', | ||
| }, |
There was a problem hiding this comment.
sourceType should be "scripts".
There was a problem hiding this comment.
Update: I removed this config so it would default to script.
bmish
force-pushed
the
eslint-plugin-markdown
branch
from
cddad8c to
161026d
Compare
…entation This applies our JavaScript linting to the JavaScript code samples in the markdown documentation files. * Autofixes styling/formatting/whitespace * Fixes and prevents syntax errors
bmish
force-pushed
the
eslint-plugin-markdown
branch
from
161026d to
6dcb7b5
Compare
aladdin-add
approved these changes
Jun 18, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This applies our JavaScript linting to the JavaScript code samples in the markdown documentation files. Goal is to generally improve the quality, reliability, and consistency of our documentation.