Commit d121473

authored

fix(no-multiple-template-root): skip comments outside template (#2964)

1 parent 8f85dd4 commit d121473Copy full SHA for d121473

File tree

+22

-22

lines changed

+22

-22

lines changed

Lines changed: 7 additions & 19 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,21 +6,6 @@`
`6`	`6`
`7`	`7`	`const utils = require('../utils')`
`8`	`8`
`9`		`-/**`
`10`		`- * Get all comments that need to be reported`
`11`		`- * @param {(HTMLComment \| HTMLBogusComment \| Comment)[]} comments`
`12`		`- * @param {Range[]} elementRanges`
`13`		`- * @returns {(HTMLComment \| HTMLBogusComment \| Comment)[]}`
`14`		`- */`
`15`		`-function getReportComments(comments, elementRanges) {`
`16`		`- return comments.filter(`
`17`		`- (comment) =>`
`18`		`- !elementRanges.some(`
`19`		`- (range) => range[0] <= comment.range[0] && comment.range[1] <= range[1]`
`20`		`- )`
`21`		`- )`
`22`		`-}`
`23`		`-`
`24`	`9`	`module.exports = {`
`25`	`10`	`meta: {`
`26`	`11`	`type: 'problem',`
`@@ -65,10 +50,13 @@ module.exports = {`
`65`	`50`	`return`
`66`	`51`	`}`
`67`	`52`
`68`		`- const comments = element.comments`
`69`		`- const elementRanges = element.children.map((child) => child.range)`
`70`		`- if (disallowComments && comments.length > 0) {`
`71`		`- for (const comment of getReportComments(comments, elementRanges)) {`
	`53`	`+ const reportComments = element.comments.filter(`
	`54`	`+ (comment) =>`
	`55`	`+ utils.inRange(element, comment) &&`
	`56`	`+ !element.children.some((child) => utils.inRange(child, comment))`
	`57`	`+ )`
	`58`	`+ if (disallowComments) {`
	`59`	`+ for (const comment of reportComments) {`
`72`	`60`	`context.report({`
`73`	`61`	`node: comment,`
`74`	`62`	`loc: comment.loc,`

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1969,10 +1969,11 @@ module.exports = {`
`1969`	`1969`	`},`
`1970`	`1970`	`/**`
`1971`	`1971`	`* Checks whether the target node is within the given range.`
`1972`		`- * @param { [number, number] } range`
	`1972`	`+ * @param { [number, number] \| ASTNode \| Token } rangeOrNode`
`1973`	`1973`	`* @param {ASTNode \| Token} target`
`1974`	`1974`	`*/`
`1975`		`- inRange(range, target) {`
	`1975`	`+ inRange(rangeOrNode, target) {`
	`1976`	`+ const range = Array.isArray(rangeOrNode) ? rangeOrNode : rangeOrNode.range`
`1976`	`1977`	`return range[0] <= target.range[0] && target.range[1] <= range[1]`
`1977`	`1978`	`},`
`1978`	`1979`	`/**`

Lines changed: 12 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,17 @@ ruleTester.run('no-multiple-template-root', rule, {`
`122`	`122`	`</template>`
`123`	`123`	`,
`124`	`124`	`options: [{ disallowComments: true }]`
	`125`	`+ },`
	`126`	`+`
	`127`	`+ // https://github.com/vuejs/eslint-plugin-vue/issues/2948`
	`128`	`+ {`
	`129`	+ code: `
	`130`	`+ <!-- comment -->`
	`131`	`+ <template>`
	`132`	`+ <div>abc</div>`
	`133`	`+ </template>`
	`134`	+ `,
	`135`	`+ options: [{ disallowComments: true }]`
`125`	`136`	`}`
`126`	`137`	`],`
`127`	`138`	`invalid: [`
`@@ -371,7 +382,7 @@ ruleTester.run('no-multiple-template-root', rule, {`
`371`	`382`	`{`
`372`	`383`	code: `
`373`	`384`	`<template>`
`374`		`- <!-- When you have a comment in the root of your template in vue 3,`
	`385`	`+ <!-- When you have a comment in the root of your template in vue 3,`
`375`	`386`	`using $el will point to the first text comment instead of the actual DOM element. -->`
`376`	`387`	`<div>`
`377`	`388`	`12333`

Comments

(0)