no-return-before.spec.js

const path = require('path')
const eslint = require('eslint')
const plugin = require('..')
const _ = require('lodash')
const { stripIndent } = require('common-tags')
const { expect } = require('chai')

const ruleName = 'no-return-before'
const pluginName = '__plugin__'
const ESLint = eslint.ESLint

async function execute (file, options = {}) {
  const defaultConfig = {
    fix: true,
    ignore: false,
    useEslintrc: false,
    baseConfig: {
      parserOptions: {
        ecmaVersion: 2018,
        sourceType: 'module',
      },
      rules: {
        [`${pluginName}/${ruleName}`]: ['error'],
      },
      plugins: [pluginName],
    },
    plugins: {
      [pluginName]: plugin,
    },
  }
  const opts = _.defaultsDeep(options, defaultConfig)

  const cli = new ESLint(opts)

  const results = await cli.lintFiles([path.join(__dirname, file)])

  return results[0]
}

describe(ruleName, () => {
  it('pass', async () => {
    const filename = './fixtures/no-return-before-pass.js'
    const result = await execute(filename)

    expect(result.errorCount).equal(0)
  })

  it('fail', async () => {
    const filename = './fixtures/no-return-before-fail.js'
    const result = await execute(filename, {
      fix: false,
    })

    expect(result.errorCount).equal(4)
    expect(result.messages[0].message).to.contain(`after 'describe'`)
  })

  it('fix fail', async () => {
    const filename = './fixtures/no-return-before-fail.js'
    const result = await execute(filename)

    expect(result.output).equal(`${stripIndent`
    describe('outer', ()=>{
      describe('some test', ()=>{
        context('some test', ()=>{
          it('some test', ()=>{
            expect('foo').to.eq('bar')
          })
          return someFn()
        })
      })
    })
    `}\n`)
  })

  describe('config', () => {
    it('config [tokens]', async () => {
      const filename = './fixtures/no-return-before-fail.js'
      const result = await execute(filename, {
        fix: false,
        baseConfig: {
          rules: {
            [`${pluginName}/${ruleName}`]: [
              'error', {
                tokens: ['someFn'],
              },
            ],
          },
        },
      })

      expect(result.errorCount).equal(1)

      expect(result.messages[0].message).to.contain('someFn')

      expect(result.output).not.not.exist
    })
  })
})