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.
107 lines
2.8 KiB
107 lines
2.8 KiB
1 month ago
|
/**
|
||
|
* @author Amorites
|
||
|
* See LICENSE file in root directory for full license.
|
||
|
*/
|
||
|
'use strict'
|
||
|
|
||
|
const utils = require('../utils')
|
||
|
|
||
|
/**
|
||
|
* @typedef {import('@typescript-eslint/types').TSESTree.TypeNode} TypeNode
|
||
|
*
|
||
|
*/
|
||
|
|
||
|
module.exports = {
|
||
|
meta: {
|
||
|
type: 'suggestion',
|
||
|
docs: {
|
||
|
description: 'enforce declaration style of `defineEmits`',
|
||
|
categories: undefined,
|
||
|
url: 'https://eslint.vuejs.org/rules/define-emits-declaration.html'
|
||
|
},
|
||
|
fixable: null,
|
||
|
schema: [
|
||
|
{
|
||
|
enum: ['type-based', 'type-literal', 'runtime']
|
||
|
}
|
||
|
],
|
||
|
messages: {
|
||
|
hasArg: 'Use type based declaration instead of runtime declaration.',
|
||
|
hasTypeArg: 'Use runtime declaration instead of type based declaration.',
|
||
|
hasTypeCallArg:
|
||
|
'Use new type literal declaration instead of the old call signature declaration.'
|
||
|
}
|
||
|
},
|
||
|
/** @param {RuleContext} context */
|
||
|
create(context) {
|
||
|
const scriptSetup = utils.getScriptSetupElement(context)
|
||
|
if (!scriptSetup || !utils.hasAttribute(scriptSetup, 'lang', 'ts')) {
|
||
|
return {}
|
||
|
}
|
||
|
|
||
|
const defineType = context.options[0] || 'type-based'
|
||
|
return utils.defineScriptSetupVisitor(context, {
|
||
|
onDefineEmitsEnter(node) {
|
||
|
switch (defineType) {
|
||
|
case 'type-based': {
|
||
|
if (node.arguments.length > 0) {
|
||
|
context.report({
|
||
|
node,
|
||
|
messageId: 'hasArg'
|
||
|
})
|
||
|
}
|
||
|
break
|
||
|
}
|
||
|
|
||
|
case 'type-literal': {
|
||
|
verifyTypeLiteral(node)
|
||
|
break
|
||
|
}
|
||
|
|
||
|
case 'runtime': {
|
||
|
const typeArguments =
|
||
|
'typeArguments' in node ? node.typeArguments : node.typeParameters
|
||
|
if (typeArguments && typeArguments.params.length > 0) {
|
||
|
context.report({
|
||
|
node,
|
||
|
messageId: 'hasTypeArg'
|
||
|
})
|
||
|
}
|
||
|
break
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
})
|
||
|
|
||
|
/** @param {CallExpression} node */
|
||
|
function verifyTypeLiteral(node) {
|
||
|
if (node.arguments.length > 0) {
|
||
|
context.report({
|
||
|
node,
|
||
|
messageId: 'hasArg'
|
||
|
})
|
||
|
return
|
||
|
}
|
||
|
|
||
|
const typeArguments = node.typeArguments || node.typeParameters
|
||
|
const param = /** @type {TypeNode|undefined} */ (typeArguments?.params[0])
|
||
|
if (!param) return
|
||
|
if (param.type === 'TSTypeLiteral') {
|
||
|
for (const memberNode of param.members) {
|
||
|
if (memberNode.type !== 'TSPropertySignature') {
|
||
|
context.report({
|
||
|
node: memberNode,
|
||
|
messageId: 'hasTypeCallArg'
|
||
|
})
|
||
|
}
|
||
|
}
|
||
|
} else if (param.type === 'TSFunctionType') {
|
||
|
context.report({
|
||
|
node: param,
|
||
|
messageId: 'hasTypeCallArg'
|
||
|
})
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|