Skip to content

feat(formatter): Support Vitest test functions #17340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Dec 25, 2025
Merged

feat(formatter): Support Vitest test functions #17340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 38 additions & 33 deletions crates/oxc_formatter/src/utils/call_expression.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,51 +151,51 @@ pub fn callee_name_iterator<'b>(expr: &'b Expression<'_>) -> Option<impl Iterato
None
}

/// This function checks if a call expressions has one of the following members:
/// - `it`
/// - `it.only`
/// - `it.skip`
/// - `describe`
/// - `describe.only`
/// - `describe.skip`
/// - `test`
/// - `test.only`
/// - `test.skip`
/// - `test.fixme`
/// - `test.step`
/// - `test.describe`
/// - `test.describe.only`
/// - `test.describe.skip`
/// - `test.describe.fixme`
/// - `test.describe.parallel`
/// - `test.describe.parallel.only`
/// - `test.describe.serial`
/// - `test.describe.serial.only`
/// - `skip`
/// - `xit`
/// - `xdescribe`
/// - `xtest`
/// - `fit`
/// - `fdescribe`
/// - `ftest`
/// - `Deno.test`
/// This function checks if a call expression matches a test framework pattern:
///
/// Based on this [article]
/// ```text
/// ├─ it[.only|skip|skipIf|runIf|concurrent|sequential|todo|fails]
/// ├─ describe[.only|skip|skipIf|runIf|concurrent|sequential|shuffle|todo]
/// ├─ test
/// │ ├─ [.only|skip|skipIf|runIf|concurrent|sequential|todo|fails|extend|step|fixme]
/// │ └─ .describe
/// │ ├─ [.only|skip|fixme]
/// │ ├─ .parallel[.only]
/// │ └─ .serial[.only]
/// ├─ bench[.only|skip|todo]
/// ├─ skip|xit|xdescribe|xtest|fit|fdescribe|ftest
/// └─ Deno.test
/// ```
///
/// [article]: https://craftinginterpreters.com/scanning-on-demand.html#tries-and-state-machines
/// Implementation (trie-tree) is inspired by the article:
/// <https://craftinginterpreters.com/scanning-on-demand.html#tries-and-state-machines>
pub fn contains_a_test_pattern(expr: &Expression<'_>) -> bool {
let Some(mut names) = callee_name_iterator(expr) else { return false };

match names.next() {
Some("it" | "describe") => match names.next() {
Some("it") => match names.next() {
None => true,
Some(
"only" | "skip" | "skipIf" | "runIf" | "concurrent" | "sequential" | "todo"
| "fails",
) => names.next().is_none(),
_ => false,
},
Some("describe") => match names.next() {
None => true,
Some("only" | "skip") => names.next().is_none(),
Some(
"only" | "skip" | "skipIf" | "runIf" | "concurrent" | "sequential" | "shuffle"
| "todo",
) => names.next().is_none(),
_ => false,
},
Some("Deno") => matches!(names.next(), Some("test")) && names.next().is_none(),
Some("test") => match names.next() {
None => true,
Some("only" | "skip" | "step" | "fixme") => names.next().is_none(),
Some(
"only" | "skip" | "skipIf" | "runIf" | "concurrent" | "sequential" | "todo"
| "fails" | "extend" | "step" | "fixme",
) => names.next().is_none(),
Some("describe") => match names.next() {
None => true,
Some("only" | "skip" | "fixme") => names.next().is_none(),
Expand All @@ -208,6 +208,11 @@ pub fn contains_a_test_pattern(expr: &Expression<'_>) -> bool {
},
_ => false,
},
Some("bench") => match names.next() {
None => true,
Some("only" | "skip" | "todo") => names.next().is_none(),
_ => false,
},
Some("skip" | "xit" | "xdescribe" | "xtest" | "fit" | "fdescribe" | "ftest") => true,
_ => false,
}
Expand Down
Loading