eslint-plugin-ban/tests/lib/rules/ban.js

Allows you to bannish some methods or functions.

/**
 * @fileoverview Ban methods
 * @author Rémi THOMAS
 */
'use strict';

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

var rule = require('../../../lib/rules/ban'),
  RuleTester = require('eslint').RuleTester;

//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------

var ruleTester = new RuleTester();
ruleTester.run('ban with default options', rule, {
  valid: [
    {
      code: '// comment',
    },
    {
      code: 'for(item in list) {}',
    },
    {
      code: 'var functionName = "hello";',
    },
  ],

  invalid: [],
});

ruleTester.run(
  'ban with configuration for function (example ban function `functionName`)',
  rule,
  {
    valid: [
      'foo()',
      {
        code: '// comment functionName()',
        options: [
          { name: 'functionName', message: 'Prefer use functionName2' },
        ],
      },
      {
        code: 'for(item in list) {}',
        options: [
          { name: 'functionName', message: 'Prefer use functionName2' },
        ],
      },
      {
        code: 'var functionName = "hello";',
        options: [
          { name: 'functionName', message: 'Prefer use functionName2' },
        ],
      },
    ],

    invalid: [
      // Ban function
      {
        code: 'functionName("fn");',
        errors: [
          {
            message: 'Prefer use functionName2',
          },
        ],
        options: [
          { name: 'functionName', message: 'Prefer use functionName2' },
        ],
      },
      {
        code: `
                var result = functionName('myString');
            `,
        errors: [
          {
            message: 'Prefer use functionName2',
          },
        ],
        options: [
          { name: 'functionName', message: 'Prefer use functionName2' },
        ],
      },
    ],
  }
);

ruleTester.run(
  'ban with configuration for method (example ban method `push`)',
  rule,
  {
    valid: [
      'value.bar()',
      {
        code: '// comment something.push("here")',
        options: [{ name: ['*', 'push'], message: 'Prefer use es6 spread' }],
      },
      {
        code: 'for(item in list) {}',
        options: [{ name: ['*', 'push'], message: 'Prefer use es6 spread' }],
      },
      {
        code: 'var functionName = "functionName";',
        options: [{ name: ['*', 'push'], message: 'Prefer use es6 spread' }],
      },
      {
        code: 'animals.push("cows")',
        options: [
          { name: ['humans', 'push'], message: 'Prefer use es6 spread' },
        ],
      },
      {
        code: 'var myVar = push("cows")',
        options: [{ name: ['*', 'push'], message: 'Prefer use es6 spread' }],
      },
    ],

    invalid: [
      // Ban method
      {
        code: 'animals.push("dogs")',
        errors: [
          {
            message: 'Prefer use es6 spread',
          },
        ],
        options: [{ name: ['*', 'push'], message: 'Prefer use es6 spread' }],
      },
      {
        code: 'animals.push("cows")',
        errors: [
          {
            message: 'Prefer use es6 spread',
          },
        ],
        options: [
          { name: ['animals', 'push'], message: 'Prefer use es6 spread' },
        ],
      },
      {
        code: 'this.target.removeEventListener()',
        errors: [
          {
            message: 'Use xx instead',
          },
        ],
        options: [
          { name: ['*', 'removeEventListener'], message: 'Use xx instead' },
        ],
      },
    ],
  }
);

const multipleRuleOptions = [
  { name: ['animals', 'push'], message: "don't push on animals" },
  { name: ['birds', 'push'], message: "don't push on birds" },
  { name: 'functionName', message: 'Prefer use functionName2' },
];

ruleTester.run('ban with multiple rules', rule, {
  valid: [
    {
      code: 'cars.push("dogs");',
      options: multipleRuleOptions,
    },
  ],
  invalid: [
    {
      code: 'animals.push("dogs");',
      errors: [
        {
          message: "don't push on animals",
        },
      ],
      options: multipleRuleOptions,
    },
    {
      code: 'birds.push("dogs");',
      errors: [
        {
          message: "don't push on birds",
        },
      ],
      options: multipleRuleOptions,
    },
    {
      code: 'functionName("dogs");',
      errors: [
        {
          message: 'Prefer use functionName2',
        },
      ],
      options: multipleRuleOptions,
    },
  ],
});

const singleLine = [{ name: ['it', 'only'], message: "Don't use `it.only`" }];

ruleTester.run('should ban single line', rule, {
  valid: [
    {
      code: 'hello.it("dogs");',
      options: singleLine,
    },
  ],
  invalid: [
    // Ban method
    {
      code: [
        '// test',
        'it.only("does abc", function(){',
        'my.only();',
        '})',
      ].join('\n'),
      errors: [
        {
          message: "Don't use `it.only`",
          line: 2,
          endLine: 2,
          column: 1,
          endColumn: 8,
        },
      ],
      options: singleLine,
    },
  ],
});

// wildcard
const wildcard = [
  { name: ['console', '*'], message: 'Unexpected console statement' },
];

ruleTester.run('should ban using wildcard (end)', rule, {
  valid: [
    {
      code: 'hello.it("dogs");',
      options: wildcard,
    },
    {
      code: 'log.console("dogs");',
      options: wildcard,
    },
    {
      code: 'console("dogs");',
      options: wildcard,
    },
  ],
  invalid: [
    // Ban method
    {
      code: [
        'console.log("bad usage");',
        'console.warn("wrong usage")',
        'console.error("oh no")',
      ].join('\n'),
      errors: [
        {
          message: 'Unexpected console statement',
          line: 1,
          endLine: 1,
          column: 1,
          endColumn: 12,
        },
        {
          message: 'Unexpected console statement',
          line: 2,
          endLine: 2,
          column: 1,
          endColumn: 13,
        },
        {
          message: 'Unexpected console statement',
          line: 3,
          endLine: 3,
          column: 1,
          endColumn: 14,
        },
      ],
      options: wildcard,
    },
  ],
});