|
| 1 | +/** |
| 2 | + * @author Wayne Zhang |
| 3 | + * See LICENSE file in root directory for full license. |
| 4 | + */ |
| 5 | +'use strict' |
| 6 | + |
| 7 | +const utils = require('../utils') |
| 8 | +const { findVariable } = require('@eslint-community/eslint-utils') |
| 9 | + |
| 10 | +const DeprecatedApis = ['set', 'delete'] |
| 11 | +const DeprecatedDollarApis = new Set(DeprecatedApis.map((item) => `$${item}`)) |
| 12 | + |
| 13 | +/** |
| 14 | + * @param {Expression|Super} node |
| 15 | + */ |
| 16 | +function isVue(node) { |
| 17 | + return node.type === 'Identifier' && node.name === 'Vue' |
| 18 | +} |
| 19 | + |
| 20 | +module.exports = { |
| 21 | + meta: { |
| 22 | + type: 'problem', |
| 23 | + docs: { |
| 24 | + description: |
| 25 | + 'disallow using deprecated `$delete` and `$set` (in Vue.js 3.0.0+)', |
| 26 | + categories: ['vue3-essential'], |
| 27 | + url: 'https://eslint.vuejs.org/rules/no-deprecated-delete-set.html' |
| 28 | + }, |
| 29 | + fixable: null, |
| 30 | + schema: [], |
| 31 | + messages: { |
| 32 | + deprecated: 'The `$delete`, `$set` is deprecated.' |
| 33 | + } |
| 34 | + }, |
| 35 | + /** @param {RuleContext} context */ |
| 36 | + create(context) { |
| 37 | + /** |
| 38 | + * @param {Identifier} identifier |
| 39 | + * @param {RuleContext} context |
| 40 | + * @returns {CallExpression|undefined} |
| 41 | + */ |
| 42 | + function getVueDeprecatedCallExpression(identifier, context) { |
| 43 | + // Instance API: this.$set() |
| 44 | + if ( |
| 45 | + DeprecatedDollarApis.has(identifier.name) && |
| 46 | + identifier.parent.type === 'MemberExpression' && |
| 47 | + utils.isThis(identifier.parent.object, context) && |
| 48 | + identifier.parent.parent.type === 'CallExpression' && |
| 49 | + identifier.parent.parent.callee === identifier.parent |
| 50 | + ) { |
| 51 | + return identifier.parent.parent |
| 52 | + } |
| 53 | + |
| 54 | + // Vue 2 Global API: Vue.set() |
| 55 | + if ( |
| 56 | + DeprecatedApis.includes(identifier.name) && |
| 57 | + identifier.parent.type === 'MemberExpression' && |
| 58 | + isVue(identifier.parent.object) && |
| 59 | + identifier.parent.parent.type === 'CallExpression' && |
| 60 | + identifier.parent.parent.callee === identifier.parent |
| 61 | + ) { |
| 62 | + return identifier.parent.parent |
| 63 | + } |
| 64 | + |
| 65 | + // Vue 3 Global API |
| 66 | + if ( |
| 67 | + identifier.parent.type === 'CallExpression' && |
| 68 | + identifier.parent.callee === identifier |
| 69 | + ) { |
| 70 | + const variable = findVariable( |
| 71 | + utils.getScope(context, identifier), |
| 72 | + identifier |
| 73 | + ) |
| 74 | + |
| 75 | + if (variable != null && variable.defs.length === 1) { |
| 76 | + const def = variable.defs[0] |
| 77 | + |
| 78 | + // import { set as st } from 'vue'; st() |
| 79 | + if ( |
| 80 | + def.type === 'ImportBinding' && |
| 81 | + def.node.type === 'ImportSpecifier' && |
| 82 | + def.node.imported.type === 'Identifier' && |
| 83 | + DeprecatedApis.includes(def.node.imported.name) && |
| 84 | + def.node.parent.type === 'ImportDeclaration' && |
| 85 | + def.node.parent.source.value === 'vue' |
| 86 | + ) { |
| 87 | + return identifier.parent |
| 88 | + } |
| 89 | + |
| 90 | + // const { set, delete } = require('vue'); set() |
| 91 | + if ( |
| 92 | + def.type === 'Variable' && |
| 93 | + def.node.type === 'VariableDeclarator' && |
| 94 | + def.node.id.type === 'ObjectPattern' && |
| 95 | + def.node.init?.type === 'CallExpression' && |
| 96 | + def.node.init.callee.type === 'Identifier' && |
| 97 | + def.node.init.callee.name === 'require' && |
| 98 | + def.node.init.arguments.length === 1 && |
| 99 | + def.node.init.arguments[0].type === 'Literal' && |
| 100 | + def.node.init.arguments[0].value === 'vue' |
| 101 | + ) { |
| 102 | + const properties = def.node.id.properties |
| 103 | + for (const prop of properties) { |
| 104 | + if ( |
| 105 | + prop.type === 'Property' && |
| 106 | + prop.key.type === 'Identifier' && |
| 107 | + DeprecatedApis.includes(prop.key.name) && |
| 108 | + prop.value.type === 'Identifier' && |
| 109 | + prop.value.name === identifier.name |
| 110 | + ) { |
| 111 | + return identifier.parent |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + } |
| 116 | + } |
| 117 | + |
| 118 | + return undefined |
| 119 | + } |
| 120 | + |
| 121 | + const nodeVisitor = { |
| 122 | + /** @param {Identifier} node */ |
| 123 | + Identifier(node) { |
| 124 | + const callExpression = getVueDeprecatedCallExpression(node, context) |
| 125 | + if (!callExpression) { |
| 126 | + return |
| 127 | + } |
| 128 | + |
| 129 | + context.report({ |
| 130 | + node, |
| 131 | + messageId: 'deprecated' |
| 132 | + }) |
| 133 | + } |
| 134 | + } |
| 135 | + |
| 136 | + return utils.compositingVisitors( |
| 137 | + utils.defineVueVisitor(context, nodeVisitor), |
| 138 | + utils.defineScriptSetupVisitor(context, nodeVisitor) |
| 139 | + ) |
| 140 | + } |
| 141 | +} |
0 commit comments