Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feat(no-multiple-template-root): support disallowComments property #2685

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

Merged
ota-meshi merged 6 commits into vuejs:master from chouchouji:feat-disallow-comments
Apr 29, 2025
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion docs/rules/no-multiple-template-root.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,32 @@ This rule checks whether template contains single root element valid for Vue 2.

## :wrench: Options

Nothing.
```json
{
"vue/no-multiple-template-root": ["error", {
"disallowComments": false
}]
}
```

- "disallowComments" (`boolean`) Enables there should not be any comments in the template root. Default is `false`.

### "disallowComments": true

<eslint-code-block :rules="{'vue/no-multiple-template-root': ['error', {disallowComments: true}]}">

```vue
/* ✗ BAD */
<template>
<!-- root comment -->
<div>
vue eslint plugin
</div>
<!-- root comment -->
</template>
```

</eslint-code-block>

## :rocket: Version

Expand Down
42 changes: 41 additions & 1 deletion lib/rules/no-multiple-template-root.js
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@

const utils = require('../utils')

/**
* Get all comments that need to be reported
* @param {(HTMLComment | HTMLBogusComment | Comment)[]} comments
* @param {Range[]} elementRanges
* @returns {(HTMLComment | HTMLBogusComment | Comment)[]}
*/
function getReportComments(comments, elementRanges) {
return comments.filter(
(comment) =>
!elementRanges.some(
(range) => range[0] <= comment.range[0] && comment.range[1] <= range[1]
)
)
}

module.exports = {
meta: {
type: 'problem',
Expand All @@ -15,8 +30,19 @@ module.exports = {
url: 'https://eslint.vuejs.org/rules/no-multiple-template-root.html'
},
fixable: null,
schema: [],
schema: [
{
type: 'object',
properties: {
disallowComments: {
type: 'boolean'
}
},
additionalProperties: false
}
],
messages: {
commentRoot: 'The template root disallows comments.',
multipleRoot: 'The template root requires exactly one element.',
textRoot: 'The template root requires an element rather than texts.',
disallowedElement: "The template root disallows '<{{name}}>' elements.",
Expand All @@ -28,6 +54,8 @@ module.exports = {
* @returns {RuleListener} AST event handlers.
*/
create(context) {
const options = context.options[0] || {}
const disallowComments = options.disallowComments
const sourceCode = context.getSourceCode()

return {
Expand All @@ -37,6 +65,18 @@ module.exports = {
return
}

const comments = element.comments
const elementRanges = element.children.map((child) => child.range)
if (disallowComments && comments.length > 0) {
for (const comment of getReportComments(comments, elementRanges)) {
context.report({
node: comment,
loc: comment.loc,
messageId: 'commentRoot'
})
}
}

const rootElements = []
let extraText = null
let extraElement = null
Expand Down
186 changes: 186 additions & 0 deletions tests/lib/rules/no-multiple-template-root.js
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,66 @@ ruleTester.run('no-multiple-template-root', rule, {
</Link>
</template>
`
},
{
filename: 'test.vue',
code: `
<template>
<!-- comments -->
<div>12333</div>
<!-- comments -->
</template>
`,
options: [{ disallowComments: false }]
},
{
filename: 'test.vue',
code: `
<template>
<!-- comments -->
<div>
<!-- comments -->
12333
</div>
</template>
`,
options: [{ disallowComments: false }]
},
{
filename: 'test.vue',
code: `
<template>
<div>
<!-- comments -->
12333
<span>
<!-- comments -->
12333
</span>
</div>
</template>
`,
options: [{ disallowComments: true }]
},
{
filename: 'test.vue',
code: `
<template>
<div v-if="for">
<!-- comments -->
12333
<span>
<!-- comments -->
12333
</span>
</div>
<div v-else>
<!-- comments -->
12333
</div>
</template>
`,
options: [{ disallowComments: true }]
}
],
invalid: [
Expand Down Expand Up @@ -104,6 +164,132 @@ ruleTester.run('no-multiple-template-root', rule, {
filename: 'test.vue',
code: '<template><template></template></template>',
errors: ["The template root disallows '<template>' elements."]
},
{
code: `
<template>
<!-- comments -->
<div>12333</div>
<!-- comments -->
</template>
`,
options: [{ disallowComments: true }],
errors: [
{
message: 'The template root disallows comments.',
line: 3
},
{
message: 'The template root disallows comments.',
line: 5
}
]
},
{
code: `
<template>
<!-- comments -->
<div>
12333
<!-- comments -->
</div>
</template>
`,
options: [{ disallowComments: true }],
errors: [
{
message: 'The template root disallows comments.',
line: 3
}
]
},
{
code: `
<template>
<!-- comments -->
<div v-if="for">
<!-- comments -->
12333
<span>
<!-- comments -->
12333
</span>
</div>
<!-- comments -->
<div v-else>
<!-- comments -->
12333
</div>
<!-- comments -->
</template>
`,
options: [{ disallowComments: true }],
errors: [
{
message: 'The template root disallows comments.',
line: 3
},
{
message: 'The template root disallows comments.',
line: 12
},
{
message: 'The template root disallows comments.',
line: 17
}
]
},
{
code: `
<template>
<div>
12333
<!-- comments -->
</div>
<!-- comments -->
</template>
`,
options: [{ disallowComments: true }],
errors: [
{
message: 'The template root disallows comments.',
line: 7
}
]
},
{
code: `
<template>
<div />
<!-- comments -->
<div />
</template>
`,
options: [{ disallowComments: true }],
errors: [
{
message: 'The template root disallows comments.',
line: 4
},
{
message: 'The template root requires exactly one element.',
line: 5
}
]
},
{
code: `
<template>
<!-- When you have a comment in the root of your template in vue 3,
using $el will point to the first text comment instead of the actual DOM element. -->
<div>
12333
<!-- comments -->
</div>
</template>
`,
options: [{ disallowComments: true }],
errors: ['The template root disallows comments.']
}
]
})
Loading

AltStyle によって変換されたページ (->オリジナル) /