-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
[DOCS] Add* and run eslint-plugin-markdown
#13156
Conversation
to not confuse eslint-plugin-markdown with invalid code
to allow comments
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.
awesome
// acquit:ignore:end | ||
await event.save(); | ||
await event.save(); |
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.
Is there any way we can avoid this one indentation change? The indentation is slightly off here because the await assert.rejects()
is stripped from the output because of // acquit:ignore:start
, so we want the docs to appear as if await event.save()
isn't indented at all.
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.
we could disable indentation rule for that line, but would not recommend to to it globally
or the acquit (plugin?) could handle indentation changes between comments
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.
for now i could add a quick-fix of ignoring the eslint rule (but editors may still automatically apply indentation)
or we could wait for vkarpov15/acquit-ignore#6
Summary
This PR basically adds* and runs
eslint-plugin-markdown
, including all changes required for this to work, in more detail:docs
from being ignored in eslint completelytest/docs
browser
fordocs/js/**/*.js
docs/**/*.js
(except*.min.js
files)acquit
, to not confuse eslint with invalid tokensjson
tojs
to allow comments*.md
files*Note:
eslint-plugin-markdown
has been disabled with commit 6f2dec1, because of some out-standing issues: eslint/markdown#214This PR (or the mentioned PRs if this is merged first) may require fixes:
Update some scripts to be more consistently in place #13045re #12691