/
name-property-casing.js
71 lines (64 loc) · 2.1 KB
/
name-property-casing.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
* @fileoverview Requires specific casing for the name property in Vue components
* @author Armano
*/
'use strict'
const utils = require('../utils')
const casing = require('../utils/casing')
const allowedCaseOptions = ['PascalCase', 'kebab-case']
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
type: 'suggestion',
docs: {
description:
'enforce specific casing for the name property in Vue components',
categories: ['vue3-strongly-recommended', 'strongly-recommended'],
url: 'https://eslint.vuejs.org/rules/name-property-casing.html',
replacedBy: ['component-definition-name-casing']
},
deprecated: true,
fixable: 'code', // or "code" or "whitespace"
schema: [
{
enum: allowedCaseOptions
}
]
},
/** @param {RuleContext} context */
create(context) {
const options = context.options[0]
const caseType =
allowedCaseOptions.indexOf(options) !== -1 ? options : 'PascalCase'
// ----------------------------------------------------------------------
// Public
// ----------------------------------------------------------------------
return utils.executeOnVue(context, (obj) => {
const node = utils.findProperty(obj, 'name')
if (!node) return
const valueNode = node.value
if (valueNode.type !== 'Literal') return
if (!casing.getChecker(caseType)(`${valueNode.value}`)) {
const value = casing.getExactConverter(caseType)(`${valueNode.value}`)
context.report({
node: valueNode,
message: 'Property name "{{value}}" is not {{caseType}}.',
data: {
value: `${valueNode.value}`,
caseType
},
fix: (fixer) =>
fixer.replaceText(
valueNode,
context
.getSourceCode()
.getText(valueNode)
.replace(`${valueNode.value}`, value)
)
})
}
})
}
}