eslint-plugin-vue
Version:
Official ESLint plugin for Vue.js
89 lines (82 loc) • 2.21 kB
JavaScript
/**
* @author Doug Wade <douglas.b.wade@gmail.com>
*/
const utils = require('../utils')
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'disallow specific elements',
categories: undefined,
url: 'https://eslint.vuejs.org/rules/no-restricted-html-elements.html'
},
fixable: null,
schema: {
type: 'array',
items: {
oneOf: [
{ type: 'string' },
{
type: 'object',
properties: {
element: {
oneOf: [
{ type: 'string' },
{ type: 'array', items: { type: 'string' } }
]
},
message: { type: 'string', minLength: 1 }
},
required: ['element'],
additionalProperties: false
}
]
},
uniqueItems: true,
minItems: 0
},
messages: {
forbiddenElement: 'Unexpected use of forbidden element {{name}}.',
// eslint-disable-next-line eslint-plugin/report-message-format
customMessage: '{{message}}'
}
},
/**
* @param {RuleContext} context - The rule context.
* @returns {RuleListener} AST event handlers.
*/
create(context) {
return utils.defineTemplateBodyVisitor(context, {
/**
* @param {VElement} node
*/
VElement(node) {
if (
!utils.isHtmlElementNode(node) &&
!utils.isSvgElementNode(node) &&
!utils.isMathElementNode(node)
) {
return
}
for (const option of context.options) {
const restrictedItem = option.element || option
const elementsToRestrict = Array.isArray(restrictedItem)
? restrictedItem
: [restrictedItem]
if (elementsToRestrict.includes(node.rawName)) {
context.report({
messageId: option.message ? 'customMessage' : 'forbiddenElement',
data: {
name: node.rawName,
message: option.message
},
node: node.startTag
})
return
}
}
}
})
}
}