eslint-plugin-jest/lib/rules/no-hooks.js

Eslint rules for Jest

'use strict';

const _require = require('./util'),
      getDocsUrl = _require.getDocsUrl;

module.exports = {
  meta: {
    docs: {
      url: getDocsUrl(__filename)
    },
    messages: {
      unexpectedHook: "Unexpected '{{ hookName }}' hook"
    }
  },
  schema: [{
    type: 'object',
    properties: {
      allow: {
        type: 'array',
        contains: ['beforeAll', 'beforeEach', 'afterAll', 'afterEach']
      }
    },
    additionalProperties: false
  }],

  create(context) {
    const testHookNames = Object.assign(Object.create(null), {
      beforeAll: true,
      beforeEach: true,
      afterAll: true,
      afterEach: true
    });
    const whitelistedHookNames = (context.options[0] || {
      allow: []
    }).allow.reduce((hashMap, value) => {
      hashMap[value] = true;
      return hashMap;
    }, Object.create(null));

    const isHook = node => testHookNames[node.callee.name];

    const isWhitelisted = node => whitelistedHookNames[node.callee.name];

    return {
      CallExpression(node) {
        if (isHook(node) && !isWhitelisted(node)) {
          context.report({
            node,
            messageId: 'unexpectedHook',
            data: {
              hookName: node.callee.name
            }
          });
        }
      }

    };
  }

};