suggestion: prefer `test` or `it`

Suggest using test or it (always-test-or-it)

For consistency in code, always use test or always use it.

Rule details

When test is preferred, this rule triggers a warning for any instances of it. When it is preferred, this rule triggers a warning for any instances of test.

This rule is not set by default.

Default configuration

The following pattern is considered warning:

it('example 1', () => {
   expect(files).toHaveLength(1);
});

test('example 2', () => {
   expect(files).toHaveLength(1);
});

The following pattern is not warning when test is set:

test('example 1', () => {
   expect(files).toHaveLength(1);
});

test('example 2', () => {
   expect(files).toHaveLength(1);
});

The following pattern is not warning when it is set:

it('example 1', () => {
   expect(files).toHaveLength(1);
});

it('example 2', () => {
   expect(files).toHaveLength(1);
});

[SimenB]

I think 3 options makes sense. Can be an object instead of a single string as well. { fn: 'test', withinDescribe: 'it'} or something

[macklinu]

Should we allow config to differentiate between an it within a describe and by itself at the top level?

I think that could be nice.

When using describe(), I prefer using only it().

describe('myFunction()', () => {
  it('does this thing')
  it('does that thing')
  // etc.
})

When not using describe(), I prefer using only test().

test('does this thing')
test('does that thing')

I’ve worked in codebases that have done one or the other, so being able to configure this could help ensure consistency in those codebases.