New: directive comments (fixes #260) #320
Merged
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
michalsnik
suggested changes
Jan 2, 2018
|
|
||
| ```html | ||
| <template> | ||
| <!-- eslint-disable-next-line vue/max-attributes-per-line --> |
There was a problem hiding this comment.
I think we should also add this information in README
docs/rules/comment-directive.md
Outdated
| </template> | ||
| ``` | ||
|
|
||
| This rule doesn't make any warning. |
docs/rules/comment-directive.md
Outdated
| @@ -0,0 +1,24 @@ | |||
| # support comment-directives in `<template>` (comment-directive) | |||
|
|
|||
| This rule supports the following comment directives in `<template>`: | |||
There was a problem hiding this comment.
Sole purpose of this rule is to provide `eslint-disable` functionality in `<template>`.
It supports usage of the following comments:
...
Plus I think you should add quick information of how this works actually, because it might be a bit confusing for people to see a rule, that actually has nothing in common with any other rule :D
| it('disable all rules if <!-- eslint-disable -->', () => { | ||
| const code = ` | ||
| <template> | ||
| <!-- eslint-disable --> |
There was a problem hiding this comment.
Could you perhaps add few more examples with nested/multiline elements like e.g.:
<template>
<ul>
<li v-for="item in items" <!-- eslint-disable-line -->
:class="item.class"
:title="item.title"
<!-- eslint-disable-next-line -->
title="test"
/>
</ul>
</template>There was a problem hiding this comment.
It's just an invalid HTML code. Some no-parsing-error warnings will be shown.
|
Thank you for the review. I updated docs. |
mysticatea
force-pushed
the
comment-directives
branch
from
cf21e90 to
b68f9c0
Compare
mysticatea
force-pushed
the
comment-directives
branch
from
b68f9c0 to
3afe9ce
Compare
michalsnik
approved these changes
Jan 6, 2018
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.
Fixes #260.
This PR adds supports of directive comments in
<template>:<!-- eslint-disable --><!-- eslint-enable --><!-- eslint-disable-line --><!-- eslint-disable-next-line -->The mechanism is:
vue/directive-commentrule reports those comments.vue/directive-commenterrors and the reported errors in disabled areas.This PR adds
vue/directive-commentrule tobasecategory, but the rule doesn't report any errors (as more exact, allvue/directive-commenterrors are removed in post-process), so it doesn't break user's CI builds.