/
require-emit-types.js
69 lines (60 loc) · 1.85 KB
/
require-emit-types.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
/**
* @fileoverview Emit definitions should be detailed
* @author Pig Fang
*/
'use strict'
const utils = require('../utils')
/**
* @typedef {import('../utils').ComponentArrayEmit} ComponentArrayEmit
* @typedef {import('../utils').ComponentObjectEmit} ComponentObjectEmit
*/
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'require type definitions in emits',
categories: ['vue3-strongly-recommended'],
url: 'https://eslint.vuejs.org/rules/require-emit-types.html'
},
fixable: null,
messages: {
missing: 'Emit "{{name}}" should define at least its type.'
},
schema: []
},
/** @param {RuleContext} context */
create(context) {
// ----------------------------------------------------------------------
// Helpers
// ----------------------------------------------------------------------
/**
* @param {ComponentArrayEmit|ComponentObjectEmit} emit
*/
function checker({ value, node, emitName }) {
const hasType =
!!value &&
(value.type === 'ArrowFunctionExpression' ||
value.type === 'FunctionExpression')
if (!hasType) {
const name =
emitName ||
(node.type === 'Identifier' && node.name) ||
'Unknown emit'
context.report({
node,
messageId: 'missing',
data: { name }
})
}
}
// ----------------------------------------------------------------------
// Public
// ----------------------------------------------------------------------
return utils.executeOnVue(context, (obj) => {
utils.getComponentEmits(obj).forEach(checker)
})
}
}