You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# Require test cases and hooks to be inside a `describe` block (`require-top-level-describe`)
Jest allows you to organise your test files the way you want it. However, the more your codebase grows, the more it becomes hard to navigate in your test files. This rule makes sure you provide at least a top-level `describe` block in your test file.
## Rule Details
This rule triggers a warning if a test case (`test` and `it`) or a hook (`beforeAll`, `beforeEach`, `afterEach`, `afterAll`) is not located in a top-level `describe` block.
The following patterns are considered warnings:
```js // Above a describe block test('my test', () => {}); describe('test suite', () => { it('test', () => {}); });
// Below a describe block describe('test suite', () => {}); test('my test', () => {});
// Same for hooks beforeAll('my beforeAll', () => {}); describe('test suite', () => {}); afterEach('my afterEach', () => {}); ```
The following patterns are **not** considered warnings:
```js // In a describe block describe('test suite', () => { test('my test', () => {}); });
// In a nested describe block describe('test suite', () => { test('my test', () => {}); describe('another test suite', () => { test('my other test', () => {}); }); }); ```
## When Not To Use It
Don't use this rule on non-jest test files.
|