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.
138 lines
3.3 KiB
138 lines
3.3 KiB
/**
|
|
* @fileoverview Define a style for the props casing in templates.
|
|
* @author Armano
|
|
*/
|
|
'use strict'
|
|
|
|
const utils = require('../utils')
|
|
const casing = require('../utils/casing')
|
|
const svgAttributes = require('../utils/svg-attributes-weird-case.json')
|
|
|
|
/**
|
|
* @param {VDirective | VAttribute} node
|
|
* @returns {string | null}
|
|
*/
|
|
function getAttributeName(node) {
|
|
if (!node.directive) {
|
|
return node.key.rawName
|
|
}
|
|
|
|
if (
|
|
node.key.name.name === 'bind' &&
|
|
node.key.argument &&
|
|
node.key.argument.type === 'VIdentifier'
|
|
) {
|
|
return node.key.argument.rawName
|
|
}
|
|
|
|
return null
|
|
}
|
|
|
|
module.exports = {
|
|
meta: {
|
|
type: 'suggestion',
|
|
docs: {
|
|
description:
|
|
'enforce attribute naming style on custom components in template',
|
|
categories: ['vue3-strongly-recommended', 'strongly-recommended'],
|
|
url: 'https://eslint.vuejs.org/rules/attribute-hyphenation.html'
|
|
},
|
|
fixable: 'code',
|
|
schema: [
|
|
{
|
|
enum: ['always', 'never']
|
|
},
|
|
{
|
|
type: 'object',
|
|
properties: {
|
|
ignore: {
|
|
type: 'array',
|
|
items: {
|
|
allOf: [
|
|
{ type: 'string' },
|
|
{ not: { type: 'string', pattern: ':exit$' } },
|
|
{ not: { type: 'string', pattern: '^\\s*$' } }
|
|
]
|
|
},
|
|
uniqueItems: true,
|
|
additionalItems: false
|
|
}
|
|
},
|
|
additionalProperties: false
|
|
}
|
|
]
|
|
},
|
|
/** @param {RuleContext} context */
|
|
create(context) {
|
|
const sourceCode = context.getSourceCode()
|
|
const option = context.options[0]
|
|
const optionsPayload = context.options[1]
|
|
const useHyphenated = option !== 'never'
|
|
const ignoredAttributes = ['data-', 'aria-', 'slot-scope', ...svgAttributes]
|
|
|
|
if (optionsPayload && optionsPayload.ignore) {
|
|
ignoredAttributes.push(...optionsPayload.ignore)
|
|
}
|
|
|
|
const caseConverter = casing.getExactConverter(
|
|
useHyphenated ? 'kebab-case' : 'camelCase'
|
|
)
|
|
|
|
/**
|
|
* @param {VDirective | VAttribute} node
|
|
* @param {string} name
|
|
*/
|
|
function reportIssue(node, name) {
|
|
const text = sourceCode.getText(node.key)
|
|
|
|
context.report({
|
|
node: node.key,
|
|
loc: node.loc,
|
|
message: useHyphenated
|
|
? "Attribute '{{text}}' must be hyphenated."
|
|
: "Attribute '{{text}}' can't be hyphenated.",
|
|
data: {
|
|
text
|
|
},
|
|
fix: (fixer) => {
|
|
if (text.includes('_')) {
|
|
return null
|
|
}
|
|
|
|
return fixer.replaceText(
|
|
node.key,
|
|
text.replace(name, caseConverter(name))
|
|
)
|
|
}
|
|
})
|
|
}
|
|
|
|
/**
|
|
* @param {string} value
|
|
*/
|
|
function isIgnoredAttribute(value) {
|
|
const isIgnored = ignoredAttributes.some((attr) => value.includes(attr))
|
|
|
|
if (isIgnored) {
|
|
return true
|
|
}
|
|
|
|
return useHyphenated ? value.toLowerCase() === value : !/-/.test(value)
|
|
}
|
|
|
|
return utils.defineTemplateBodyVisitor(context, {
|
|
VAttribute(node) {
|
|
if (
|
|
!utils.isCustomComponent(node.parent.parent) &&
|
|
node.parent.parent.name !== 'slot'
|
|
)
|
|
return
|
|
|
|
const name = getAttributeName(node)
|
|
if (name === null || isIgnoredAttribute(name)) return
|
|
|
|
reportIssue(node, name)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|