no-deprecated-events-api.js

/**
 * @fileoverview disallow using deprecated events api
 * @author yoyo930021
 */
'use strict'

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

const utils = require('../utils')

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description: 'disallow using deprecated events api',
      categories: ['vue3-essential'],
      url: 'https://eslint.vuejs.org/rules/no-deprecated-events-api.html'
    },
    fixable: null,
    schema: [],
    messages: {
      noDeprecatedEventsApi: 'The Events api `$on`, `$off` `$once` is deprecated. Using external library instead, for example mitt.'
    }
  },

  create (context) {
    const forbiddenNodes = []

    return Object.assign(
      {
        'CallExpression > MemberExpression > ThisExpression' (node) {
          if (!['$on', '$off', '$once'].includes(node.parent.property.name)) return
          forbiddenNodes.push(node.parent.parent)
        }
      },
      utils.executeOnVue(context, (obj) => {
        forbiddenNodes.forEach(node => {
          if (
            node.loc.start.line >= obj.loc.start.line &&
            node.loc.end.line <= obj.loc.end.line
          ) {
            context.report({
              node,
              messageId: 'noDeprecatedEventsApi'
            })
          }
        })
      })
    )
  }
}