103 lines
2.9 KiB
JavaScript
103 lines
2.9 KiB
JavaScript
|
/**
|
||
|
|
* @fileoverview Define a style for the props casing in templates.
|
||
|
|
* @author Armano
|
||
|
|
*/
|
||
|
|
'use strict'
|
||
|
|
|
||
|
|
const utils = require('../utils')
|
||
|
|
const casing = require('../utils/casing')
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Rule Definition
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
type: 'suggestion',
|
||
|
|
docs: {
|
||
|
|
description: 'enforce attribute naming style on custom components in template',
|
||
|
|
category: '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
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
|
||
|
|
create (context) {
|
||
|
|
const sourceCode = context.getSourceCode()
|
||
|
|
const option = context.options[0]
|
||
|
|
const optionsPayload = context.options[1]
|
||
|
|
const useHyphenated = option !== 'never'
|
||
|
|
let ignoredAttributes = ['data-', 'aria-', 'slot-scope']
|
||
|
|
|
||
|
|
if (optionsPayload && optionsPayload.ignore) {
|
||
|
|
ignoredAttributes = ignoredAttributes.concat(optionsPayload.ignore)
|
||
|
|
}
|
||
|
|
|
||
|
|
const caseConverter = casing.getConverter(useHyphenated ? 'kebab-case' : 'camelCase')
|
||
|
|
|
||
|
|
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 => fixer.replaceText(node.key, text.replace(name, caseConverter(name)))
|
||
|
|
})
|
||
|
|
}
|
||
|
|
|
||
|
|
function isIgnoredAttribute (value) {
|
||
|
|
const isIgnored = ignoredAttributes.some(function (attr) {
|
||
|
|
return value.indexOf(attr) !== -1
|
||
|
|
})
|
||
|
|
|
||
|
|
if (isIgnored) {
|
||
|
|
return true
|
||
|
|
}
|
||
|
|
|
||
|
|
return useHyphenated ? value.toLowerCase() === value : !/-/.test(value)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
// Public
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
|
||
|
|
return utils.defineTemplateBodyVisitor(context, {
|
||
|
|
VAttribute (node) {
|
||
|
|
if (!utils.isCustomComponent(node.parent.parent)) return
|
||
|
|
|
||
|
|
const name = !node.directive ? node.key.rawName : node.key.name === 'bind' ? node.key.raw.argument : false
|
||
|
|
if (!name || isIgnoredAttribute(name)) return
|
||
|
|
|
||
|
|
reportIssue(node, name)
|
||
|
|
}
|
||
|
|
})
|
||
|
|
}
|
||
|
|
}
|