You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 

182 lines
4.4 KiB

/**
* @author Yosuke Ota
* See LICENSE file in root directory for full license.
*/
'use strict'
const utils = require('../utils')
const regexp = require('../utils/regexp')
/**
* @typedef {object} ParsedOption
* @property { (key: VDirectiveKey) => boolean } test
* @property {string[]} modifiers
* @property {boolean} [useElement]
* @property {string} [message]
*/
const DEFAULT_OPTIONS = [
{
argument: '/^v-/',
message:
'Using `:v-xxx` is not allowed. Instead, remove `:` and use it as directive.'
}
]
/**
* @param {string} str
* @returns {(str: string) => boolean}
*/
function buildMatcher(str) {
if (regexp.isRegExp(str)) {
const re = regexp.toRegExp(str)
return (s) => {
re.lastIndex = 0
return re.test(s)
}
}
return (s) => s === str
}
/**
* @param {any} option
* @returns {ParsedOption}
*/
function parseOption(option) {
if (typeof option === 'string') {
const matcher = buildMatcher(option)
return {
test(key) {
return Boolean(
key.argument &&
key.argument.type === 'VIdentifier' &&
matcher(key.argument.rawName)
)
},
modifiers: []
}
}
if (option === null) {
return {
test(key) {
return key.argument === null
},
modifiers: []
}
}
const parsed = parseOption(option.argument)
if (option.modifiers) {
const argTest = parsed.test
parsed.test = (key) => {
if (!argTest(key)) {
return false
}
return /** @type {string[]} */ (option.modifiers).every((modName) =>
key.modifiers.some((mid) => mid.name === modName)
)
}
parsed.modifiers = option.modifiers
}
if (option.element) {
const argTest = parsed.test
const tagMatcher = buildMatcher(option.element)
parsed.test = (key) => {
if (!argTest(key)) {
return false
}
const element = key.parent.parent.parent
return tagMatcher(element.rawName)
}
parsed.useElement = true
}
parsed.message = option.message
return parsed
}
/**
* @param {VDirectiveKey} key
* @param {ParsedOption} option
*/
function defaultMessage(key, option) {
const vbind = key.name.rawName === ':' ? '' : 'v-bind'
const arg =
key.argument != null && key.argument.type === 'VIdentifier'
? `:${key.argument.rawName}`
: ''
const mod =
option.modifiers.length > 0 ? `.${option.modifiers.join('.')}` : ''
let on = ''
if (option.useElement) {
on = ` on \`<${key.parent.parent.parent.rawName}>\``
}
return `Using \`${vbind + arg + mod}\`${on} is not allowed.`
}
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'disallow specific argument in `v-bind`',
categories: undefined,
url: 'https://eslint.vuejs.org/rules/no-restricted-v-bind.html'
},
fixable: null,
schema: {
type: 'array',
items: {
oneOf: [
{ type: ['string', 'null'] },
{
type: 'object',
properties: {
argument: { type: ['string', 'null'] },
modifiers: {
type: 'array',
items: {
type: 'string',
enum: ['prop', 'camel', 'sync', 'attr']
},
uniqueItems: true
},
element: { type: 'string' },
message: { type: 'string', minLength: 1 }
},
required: ['argument'],
additionalProperties: false
}
]
},
uniqueItems: true,
minItems: 0
},
messages: {
// eslint-disable-next-line eslint-plugin/report-message-format
restrictedVBind: '{{message}}'
}
},
/** @param {RuleContext} context */
create(context) {
/** @type {ParsedOption[]} */
const options = (
context.options.length === 0 ? DEFAULT_OPTIONS : context.options
).map(parseOption)
return utils.defineTemplateBodyVisitor(context, {
/**
* @param {VDirectiveKey} node
*/
"VAttribute[directive=true][key.name.name='bind'] > VDirectiveKey"(node) {
for (const option of options) {
if (option.test(node)) {
const message = option.message || defaultMessage(node, option)
context.report({
node,
messageId: 'restrictedVBind',
data: { message }
})
return
}
}
}
})
}
}