You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
2.8 KiB
102 lines
2.8 KiB
3 years ago
|
/**
|
||
|
|
* @fileoverview Emit definitions should be detailed
|
||
|
|
* @author Pig Fang
|
||
|
|
*/
|
||
|
|
'use strict'
|
||
|
|
|
||
|
|
const utils = require('../utils')
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef {import('../utils').ComponentEmit} ComponentEmit
|
||
|
|
*/
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
// Rule Definition
|
||
|
|
// ------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
meta: {
|
||
|
|
hasSuggestions: true,
|
||
|
|
type: 'suggestion',
|
||
|
|
docs: {
|
||
|
|
description: 'require type definitions in emits',
|
||
|
|
categories: undefined,
|
||
|
|
url: 'https://eslint.vuejs.org/rules/require-emit-validator.html'
|
||
|
|
},
|
||
|
|
fixable: null,
|
||
|
|
messages: {
|
||
|
|
missing: 'Emit "{{name}}" should define at least its validator function.',
|
||
|
|
skipped:
|
||
|
|
'Emit "{{name}}" should not skip validation, or you may define a validator function with no parameters.',
|
||
|
|
emptyValidation: 'Replace with a validator function with no parameters.'
|
||
|
|
},
|
||
|
|
schema: []
|
||
|
|
},
|
||
|
|
/** @param {RuleContext} context */
|
||
|
|
create(context) {
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
// Helpers
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param {ComponentEmit} emit
|
||
|
|
*/
|
||
|
|
function checker(emit) {
|
||
|
|
if (emit.type !== 'object' && emit.type !== 'array') {
|
||
|
|
return
|
||
|
|
}
|
||
|
|
const { value, node, emitName } = emit
|
||
|
|
const hasType =
|
||
|
|
!!value &&
|
||
|
|
(value.type === 'ArrowFunctionExpression' ||
|
||
|
|
value.type === 'FunctionExpression' ||
|
||
|
|
// validator may from outer scope
|
||
|
|
value.type === 'Identifier')
|
||
|
|
|
||
|
|
if (!hasType) {
|
||
|
|
const name =
|
||
|
|
emitName ||
|
||
|
|
(node.type === 'Identifier' && node.name) ||
|
||
|
|
'Unknown emit'
|
||
|
|
|
||
|
|
if (value && value.type === 'Literal' && value.value === null) {
|
||
|
|
context.report({
|
||
|
|
node,
|
||
|
|
messageId: 'skipped',
|
||
|
|
data: { name },
|
||
|
|
suggest: [
|
||
|
|
{
|
||
|
|
messageId: 'emptyValidation',
|
||
|
|
fix: (fixer) => fixer.replaceText(value, '() => true')
|
||
|
|
}
|
||
|
|
]
|
||
|
|
})
|
||
|
|
|
||
|
|
return
|
||
|
|
}
|
||
|
|
|
||
|
|
context.report({
|
||
|
|
node,
|
||
|
|
messageId: 'missing',
|
||
|
|
data: { name }
|
||
|
|
})
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
// Public
|
||
|
|
// ----------------------------------------------------------------------
|
||
|
|
|
||
|
|
return utils.compositingVisitors(
|
||
|
|
utils.executeOnVue(context, (obj) => {
|
||
|
|
utils.getComponentEmitsFromOptions(obj).forEach(checker)
|
||
|
|
}),
|
||
|
|
utils.defineScriptSetupVisitor(context, {
|
||
|
|
onDefineEmitsEnter(_node, emits) {
|
||
|
|
emits.forEach(checker)
|
||
|
|
}
|
||
|
|
})
|
||
|
|
)
|
||
|
|
}
|
||
|
|
}
|