mirror of
https://github.com/danbulant/oxc
synced 2026-05-19 12:19:15 +00:00
feat(linter): eslint-plugin-jest/prefer-hooks-on-top (#3437)
part of https://github.com/oxc-project/oxc/issues/492 Rule Detail: [link](https://github.com/jest-community/eslint-plugin-jest/blob/main/src/rules/prefer-hooks-on-top.ts)
This commit is contained in:
cinchen
GitHub
parent
c2c425d4dc
commit
edaa555620
3 changed files with 469 additions and 0 deletions
|
|
@ -172,6 +172,7 @@ mod jest {
|
|||
pub mod prefer_comparison_matcher;
|
||||
pub mod prefer_equality_matcher;
|
||||
pub mod prefer_expect_resolves;
|
||||
pub mod prefer_hooks_on_top;
|
||||
pub mod prefer_lowercase_title;
|
||||
pub mod prefer_mock_promise_shorthand;
|
||||
pub mod prefer_spy_on;
|
||||
|
|
@ -540,6 +541,7 @@ oxc_macros::declare_all_lint_rules! {
|
|||
jest::prefer_comparison_matcher,
|
||||
jest::prefer_equality_matcher,
|
||||
jest::prefer_expect_resolves,
|
||||
jest::prefer_hooks_on_top,
|
||||
jest::prefer_lowercase_title,
|
||||
jest::prefer_mock_promise_shorthand,
|
||||
jest::prefer_spy_on,
|
||||
|
|
|
|||
382
crates/oxc_linter/src/rules/jest/prefer_hooks_on_top.rs
Normal file
382
crates/oxc_linter/src/rules/jest/prefer_hooks_on_top.rs
Normal file
|
|
@ -0,0 +1,382 @@
|
|||
use std::collections::HashMap;
|
||||
|
||||
use oxc_ast::AstKind;
|
||||
use oxc_diagnostics::OxcDiagnostic;
|
||||
use oxc_macros::declare_oxc_lint;
|
||||
use oxc_semantic::ScopeId;
|
||||
use oxc_span::Span;
|
||||
|
||||
use crate::{
|
||||
context::LintContext,
|
||||
rule::Rule,
|
||||
utils::{
|
||||
collect_possible_jest_call_node, is_type_of_jest_fn_call, JestFnKind, JestGeneralFnKind,
|
||||
PossibleJestNode,
|
||||
},
|
||||
};
|
||||
|
||||
fn no_hook_on_top(span0: Span) -> OxcDiagnostic {
|
||||
OxcDiagnostic::warn(
|
||||
"eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.",
|
||||
)
|
||||
.with_help("Hooks should come before test cases")
|
||||
.with_labels([span0.into()])
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Clone)]
|
||||
pub struct PreferHooksOnTop;
|
||||
|
||||
declare_oxc_lint!(
|
||||
/// ### What it does
|
||||
///
|
||||
/// While hooks can be setup anywhere in a test file, they are always called in a
|
||||
/// specific order, which means it can be confusing if they're intermixed with test
|
||||
/// cases.
|
||||
///
|
||||
/// ### Example
|
||||
///
|
||||
/// ```javascript
|
||||
/// // invalid
|
||||
/// describe('foo', () => {
|
||||
/// beforeEach(() => {
|
||||
/// seedMyDatabase();
|
||||
/// });
|
||||
///
|
||||
/// it('accepts this input', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// beforeAll(() => {
|
||||
/// createMyDatabase();
|
||||
/// });
|
||||
///
|
||||
/// it('returns that value', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// describe('when the database has specific values', () => {
|
||||
/// const specificValue = '...';
|
||||
/// beforeEach(() => {
|
||||
/// seedMyDatabase(specificValue);
|
||||
/// });
|
||||
///
|
||||
/// it('accepts that input', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// it('throws an error', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// afterEach(() => {
|
||||
/// clearLogger();
|
||||
/// });
|
||||
///
|
||||
/// beforeEach(() => {
|
||||
/// mockLogger();
|
||||
/// });
|
||||
///
|
||||
/// it('logs a message', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
/// });
|
||||
///
|
||||
/// afterAll(() => {
|
||||
/// removeMyDatabase();
|
||||
/// });
|
||||
/// });
|
||||
///
|
||||
/// // valid
|
||||
/// describe('foo', () => {
|
||||
/// beforeAll(() => {
|
||||
/// createMyDatabase();
|
||||
/// });
|
||||
///
|
||||
/// beforeEach(() => {
|
||||
/// seedMyDatabase();
|
||||
/// });
|
||||
///
|
||||
/// afterAll(() => {
|
||||
/// clearMyDatabase();
|
||||
/// });
|
||||
///
|
||||
/// it('accepts this input', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// it('returns that value', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// describe('when the database has specific values', () => {
|
||||
/// const specificValue = '...';
|
||||
///
|
||||
/// beforeEach(() => {
|
||||
/// seedMyDatabase(specificValue);
|
||||
/// });
|
||||
///
|
||||
/// beforeEach(() => {
|
||||
/// mockLogger();
|
||||
/// });
|
||||
///
|
||||
/// afterEach(() => {
|
||||
/// clearLogger();
|
||||
/// });
|
||||
///
|
||||
/// it('accepts that input', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// it('throws an error', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
///
|
||||
/// it('logs a message', () => {
|
||||
/// // ...
|
||||
/// });
|
||||
/// });
|
||||
/// });
|
||||
/// ```
|
||||
PreferHooksOnTop,
|
||||
style,
|
||||
);
|
||||
|
||||
impl Rule for PreferHooksOnTop {
|
||||
fn run_once(&self, ctx: &LintContext) {
|
||||
let mut hooks_contexts: HashMap<ScopeId, bool> = HashMap::default();
|
||||
let mut possibles_jest_nodes = collect_possible_jest_call_node(ctx);
|
||||
possibles_jest_nodes.sort_by_key(|n| n.node.id());
|
||||
|
||||
for possible_jest_node in &possibles_jest_nodes {
|
||||
Self::run(possible_jest_node, &mut hooks_contexts, ctx);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl PreferHooksOnTop {
|
||||
fn run<'a>(
|
||||
possible_jest_node: &PossibleJestNode<'a, '_>,
|
||||
hooks_context: &mut HashMap<ScopeId, bool>,
|
||||
ctx: &LintContext<'a>,
|
||||
) {
|
||||
let node = possible_jest_node.node;
|
||||
let AstKind::CallExpression(call_expr) = node.kind() else {
|
||||
return;
|
||||
};
|
||||
|
||||
if is_type_of_jest_fn_call(
|
||||
call_expr,
|
||||
possible_jest_node,
|
||||
ctx,
|
||||
&[JestFnKind::General(JestGeneralFnKind::Test)],
|
||||
) {
|
||||
hooks_context.insert(node.scope_id(), true);
|
||||
}
|
||||
|
||||
let Some((_, has_hook)) = hooks_context.get_key_value(&node.scope_id()) else {
|
||||
return;
|
||||
};
|
||||
|
||||
if *has_hook
|
||||
&& is_type_of_jest_fn_call(
|
||||
call_expr,
|
||||
possible_jest_node,
|
||||
ctx,
|
||||
&[JestFnKind::General(JestGeneralFnKind::Hook)],
|
||||
)
|
||||
{
|
||||
ctx.diagnostic(no_hook_on_top(call_expr.span));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test() {
|
||||
use crate::tester::Tester;
|
||||
|
||||
let pass = vec![
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
someSetupFn();
|
||||
afterEach(() => {});
|
||||
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
someSetupFn();
|
||||
beforeEach(() => {});
|
||||
afterEach(() => {});
|
||||
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe.skip('foo', () => {
|
||||
beforeEach(() => {});
|
||||
beforeAll(() => {});
|
||||
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
describe('inner_foo', () => {
|
||||
beforeEach(() => {});
|
||||
test('inner bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
];
|
||||
|
||||
let fail = vec![
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeAll(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
test.each``('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeAll(() => {});
|
||||
test.only('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
test.only.each``('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeAll(() => {});
|
||||
test.only('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe.skip('foo', () => {
|
||||
beforeEach(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeAll(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
describe('foo', () => {
|
||||
beforeEach(() => {});
|
||||
beforeEach(() => {});
|
||||
beforeAll(() => {});
|
||||
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
|
||||
describe('foo', () => {
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeEach(() => {});
|
||||
beforeEach(() => {});
|
||||
beforeAll(() => {});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
(
|
||||
"
|
||||
describe('foo', () => {
|
||||
beforeAll(() => {});
|
||||
test('bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
describe('inner_foo', () => {
|
||||
beforeEach(() => {});
|
||||
test('inner bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
test('inner bar', () => {
|
||||
someFn();
|
||||
});
|
||||
|
||||
beforeAll(() => {});
|
||||
afterAll(() => {});
|
||||
test('inner bar', () => {
|
||||
someFn();
|
||||
});
|
||||
});
|
||||
});
|
||||
",
|
||||
None,
|
||||
),
|
||||
];
|
||||
|
||||
Tester::new(PreferHooksOnTop::NAME, pass, fail).with_jest_plugin(true).test_and_snapshot();
|
||||
}
|
||||
85
crates/oxc_linter/src/snapshots/prefer_hooks_on_top.snap
Normal file
85
crates/oxc_linter/src/snapshots/prefer_hooks_on_top.snap
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
---
|
||||
source: crates/oxc_linter/src/tester.rs
|
||||
assertion_line: 161
|
||||
expression: prefer_hooks_on_top
|
||||
---
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:8:21]
|
||||
7 │
|
||||
8 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
9 │ test('bar', () => {
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:8:21]
|
||||
7 │
|
||||
8 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
9 │ test.only('bar', () => {
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:8:21]
|
||||
7 │
|
||||
8 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
9 │ test.only('bar', () => {
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:8:21]
|
||||
7 │
|
||||
8 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
9 │ test('bar', () => {
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:28:21]
|
||||
27 │
|
||||
28 │ beforeEach(() => {});
|
||||
· ────────────────────
|
||||
29 │ beforeEach(() => {});
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:29:21]
|
||||
28 │ beforeEach(() => {});
|
||||
29 │ beforeEach(() => {});
|
||||
· ────────────────────
|
||||
30 │ beforeAll(() => {});
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:30:21]
|
||||
29 │ beforeEach(() => {});
|
||||
30 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
31 │ });
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:18:25]
|
||||
17 │
|
||||
18 │ beforeAll(() => {});
|
||||
· ───────────────────
|
||||
19 │ afterAll(() => {});
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
|
||||
⚠ eslint-plugin-jest(prefer-hooks-on-top): Suggest having hooks before any test cases.
|
||||
╭─[prefer_hooks_on_top.tsx:19:25]
|
||||
18 │ beforeAll(() => {});
|
||||
19 │ afterAll(() => {});
|
||||
· ──────────────────
|
||||
20 │ test('inner bar', () => {
|
||||
╰────
|
||||
help: Hooks should come before test cases
|
||||
Loading…
Reference in a new issue