eslint-plugin-ember/lib/rules/no-noop-setup-on-error-in-before.js at a3e1cb4ce01fa317bfcd3a8ffa1c85a6d5e61f29 · aklkv/eslint-plugin-ember · GitHub

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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
'use strict';

const { getImportIdentifier } = require('../utils/import');
const types = require('../utils/types');

//------------------------------------------------------------------------------
// General rule - Disallows no-op `setupOnError` in `before` or `beforeEach`.
//------------------------------------------------------------------------------

/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description: 'disallows using no-op setupOnerror in `before` or `beforeEach`',
      category: 'Testing',
      recommended: true,
      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-noop-setup-on-error-in-before.md',
    },
    fixable: 'code',
    schema: [],
    messages: {
      main: 'Using no-op setupOnerror in `before` or `beforeEach` is not allowed',
    },
  },

  create(context) {
    let importedSetupOnerrorName, importedModuleName;
    let isInModule = false;
    let isInBeforeEachHook = false;
    let isInBeforeHook = false;
    let hooksName;
    const sourceCode = context.sourceCode ?? context.getSourceCode();

    function reportErrorForNodeIfInBefore(node) {
      const isInBeforeOrBeforeEach =
        (isInBeforeEachHook || isInBeforeHook) &&
        types.isIdentifier(node.callee) &&
        node.callee.name === importedSetupOnerrorName;

      const callback = node.arguments[0];
      const isFunction =
        types.isArrowFunctionExpression(callback) ||
        types.isFunctionDeclaration(callback) ||
        types.isFunctionExpression(callback);

      const isNoop =
        callback &&
        isFunction &&
        callback.body &&
        callback.body.type === 'BlockStatement' &&
        callback.body.body.length === 0;

      if (isInBeforeOrBeforeEach && isNoop) {
        context.report({
          node,
          messageId: 'main',
          *fix(fixer) {
            yield fixer.remove(node);
            const semicolon = sourceCode.getTokenAfter(node);
            if (semicolon && semicolon.value === ';') {
              yield fixer.remove(semicolon);
            }
          },
        });
      }
    }

    return {
      ImportDeclaration(node) {
        if (node.source.value === '@ember/test-helpers') {
          importedSetupOnerrorName =
            importedSetupOnerrorName ||
            getImportIdentifier(node, '@ember/test-helpers', 'setupOnerror');
        }
        if (node.source.value === 'qunit') {
          importedModuleName = importedModuleName || getImportIdentifier(node, 'qunit', 'module');
        }
      },

      CallExpression(node) {
        if (types.isIdentifier(node.callee) && node.callee.name === importedModuleName) {
          isInModule = true;
          if (node.arguments.length > 1 && node.arguments[1]) {
            const moduleCallback = node.arguments[1];
            hooksName =
              moduleCallback.params &&
              moduleCallback.params.length > 0 &&
              types.isIdentifier(moduleCallback.params[0]) &&
              moduleCallback.params[0].name;
          }
        }
        if (types.isIdentifier(node.callee) && node.callee.name === importedSetupOnerrorName) {
          reportErrorForNodeIfInBefore(node);
        }
      },

      'CallExpression:exit'(node) {
        if (types.isIdentifier(node.callee) && node.callee.name === importedModuleName) {
          isInModule = false;
          hooksName = undefined;
        }
      },

      // potentially entering a `beforeEach` hook
      'CallExpression[callee.property.name="beforeEach"]'(node) {
        if (
          isInModule &&
          hooksName &&
          types.isIdentifier(node.callee.object) &&
          node.callee.object.name === hooksName
        ) {
          isInBeforeEachHook = true;
        }
      },

      // potentially exiting a `beforeEach` hook
      'CallExpression[callee.property.name="beforeEach"]:exit'() {
        if (isInBeforeEachHook) {
          isInBeforeEachHook = false;
          hooksName = undefined;
        }
      },

      // potentially entering a `before` hook
      'CallExpression[callee.property.name="before"]'(node) {
        if (
          isInModule &&
          hooksName &&
          types.isIdentifier(node.callee.object) &&
          node.callee.object.name === hooksName
        ) {
          isInBeforeHook = true;
        }
      },

      // potentially exiting a `before` hook
      'CallExpression[callee.property.name="before"]:exit'() {
        if (isInBeforeHook) {
          isInBeforeHook = false;
          hooksName = undefined;
        }
      },
    };
  },
};