eslint-plugin-jest/lib/rules/prefer-todo.js

Eslint rules for Jest

'use strict';

const _require = require('./util'),
      getDocsUrl = _require.getDocsUrl,
      isFunction = _require.isFunction,
      composeFixers = _require.composeFixers,
      getNodeName = _require.getNodeName,
      isString = _require.isString;

function isOnlyTestTitle(node) {
  return node.arguments.length === 1;
}

function isFunctionBodyEmpty(node) {
  return node.body.body && !node.body.body.length;
}

function isTestBodyEmpty(node) {
  const fn = node.arguments[1]; // eslint-disable-line prefer-destructuring

  return fn && isFunction(fn) && isFunctionBodyEmpty(fn);
}

function addTodo(node, fixer) {
  const testName = getNodeName(node.callee).split('.').shift();
  return fixer.replaceText(node.callee, `${testName}.todo`);
}

function removeSecondArg({
  arguments: [first, second]
}, fixer) {
  return fixer.removeRange([first.range[1], second.range[1]]);
}

function isFirstArgString({
  arguments: [firstArg]
}) {
  return firstArg && isString(firstArg);
}

const isTestCase = node => node && node.type === 'CallExpression' && ['it', 'test', 'it.skip', 'test.skip'].includes(getNodeName(node.callee));

module.exports = {
  meta: {
    docs: {
      url: getDocsUrl(__filename)
    },
    messages: {
      todoOverEmpty: 'Prefer todo test case over empty test case',
      todoOverUnimplemented: 'Prefer todo test case over unimplemented test case'
    },
    fixable: 'code'
  },

  create(context) {
    return {
      CallExpression(node) {
        if (isTestCase(node) && isFirstArgString(node)) {
          const combineFixers = composeFixers(node);

          if (isTestBodyEmpty(node)) {
            context.report({
              messageId: 'todoOverEmpty',
              node,
              fix: combineFixers(removeSecondArg, addTodo)
            });
          }

          if (isOnlyTestTitle(node)) {
            context.report({
              messageId: 'todoOverUnimplemented',
              node,
              fix: combineFixers(addTodo)
            });
          }
        }
      }

    };
  }

};