/
prop-name-casing.js
85 lines (78 loc) · 2.41 KB
/
prop-name-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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/**
* @fileoverview Requires specific casing for the Prop name in Vue components
* @author Yu Kimura
*/
'use strict'
const utils = require('../utils')
const casing = require('../utils/casing')
const allowedCaseOptions = ['camelCase', 'snake_case']
/**
* @typedef {import('../utils').ComponentArrayProp} ComponentArrayProp
* @typedef {import('../utils').ComponentObjectProp} ComponentObjectProp
* @typedef {import('../utils').ComponentTypeProp} ComponentTypeProp
*/
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
/** @param {RuleContext} context */
function create(context) {
const options = context.options[0]
const caseType =
allowedCaseOptions.indexOf(options) !== -1 ? options : 'camelCase'
const checker = casing.getChecker(caseType)
// ----------------------------------------------------------------------
// Public
// ----------------------------------------------------------------------
/**
* @param {(ComponentArrayProp | ComponentObjectProp | ComponentTypeProp)[]} props
*/
function processProps(props) {
for (const item of props) {
const propName = item.propName
if (propName == null) {
continue
}
if (!checker(propName)) {
context.report({
node: item.node,
message: 'Prop "{{name}}" is not in {{caseType}}.',
data: {
name: propName,
caseType
}
})
}
}
}
return utils.compositingVisitors(
utils.defineScriptSetupVisitor(context, {
onDefinePropsEnter(_node, props) {
processProps(props)
}
}),
utils.executeOnVue(context, (obj) => {
processProps(utils.getComponentProps(obj))
})
)
}
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
type: 'suggestion',
docs: {
description:
'enforce specific casing for the Prop name in Vue components',
categories: ['vue3-strongly-recommended', 'strongly-recommended'],
url: 'https://eslint.vuejs.org/rules/prop-name-casing.html'
},
fixable: null, // null or "code" or "whitespace"
schema: [
{
enum: allowedCaseOptions
}
]
},
create
}