|
- 'use strict'
-
- const utils = require('../utils')
- const casing = require('../utils/casing')
-
- module.exports = {
- meta: {
- docs: {
- description:
- 'enforce v-on event naming style on custom components in template',
- categories: ['vue3-strongly-recommended'],
- url: 'https://eslint.vuejs.org/rules/v-on-event-hyphenation.html'
- },
- fixable: 'code',
- schema: [
- {
- enum: ['always', 'never']
- },
- {
- type: 'object',
- properties: {
- autofix: { type: 'boolean' },
- ignore: {
- type: 'array',
- items: {
- allOf: [
- { type: 'string' },
- { not: { type: 'string', pattern: ':exit$' } },
- { not: { type: 'string', pattern: '^\\s*$' } }
- ]
- },
- uniqueItems: true,
- additionalItems: false
- }
- },
- additionalProperties: false
- }
- ],
- type: 'suggestion'
- },
-
- /** @param {RuleContext} context */
- create(context) {
- const sourceCode = context.getSourceCode()
- const option = context.options[0]
- const optionsPayload = context.options[1]
- const useHyphenated = option !== 'never'
- /** @type {string[]} */
- const ignoredAttributes = (optionsPayload && optionsPayload.ignore) || []
- const autofix = Boolean(optionsPayload && optionsPayload.autofix)
-
- const caseConverter = casing.getConverter(
- useHyphenated ? 'kebab-case' : 'camelCase'
- )
-
- /**
- * @param {VDirective} node
- * @param {VIdentifier} argument
- * @param {string} name
- */
- function reportIssue(node, argument, name) {
- const text = sourceCode.getText(node.key)
-
- context.report({
- node: node.key,
- loc: node.loc,
- message: useHyphenated
- ? "v-on event '{{text}}' must be hyphenated."
- : "v-on event '{{text}}' can't be hyphenated.",
- data: {
- text
- },
- fix:
- autofix &&
- // It cannot be converted in snake_case.
- !name.includes('_')
- ? (fixer) => fixer.replaceText(argument, caseConverter(name))
- : null
- })
- }
-
- /**
- * @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[directive=true][key.name.name='on']"(node) {
- if (!utils.isCustomComponent(node.parent.parent)) return
- if (!node.key.argument || node.key.argument.type !== 'VIdentifier') {
- return
- }
- const name = node.key.argument.rawName
- if (!name || isIgnoredAttribute(name)) return
-
- reportIssue(node, node.key.argument, name)
- }
- })
- }
- }
|