Skip to content

docs(linter): Add autogen doc support for max_nested_describe in jest plugin. #14797

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
merged 2 commits into from
Oct 21, 2025
Merged

docs(linter): Add autogen doc support for max_nested_describe in jest plugin. #14797

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3268de
Add autogen doc support for max_nested_describe in jest plugin.
connorshea Oct 20, 2025
1f31816
Add `#[schemars(default)]` to MaxNestedDescribe struct.
connorshea Oct 21, 2025
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
10 changes: 7 additions & 3 deletions crates/oxc_linter/src/rules/jest/max_nested_describe.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_semantic::ScopeId;
use oxc_span::Span;
use schemars::JsonSchema;

use crate::{
context::LintContext,
Expand All @@ -19,8 +20,11 @@ fn exceeded_max_depth(current: usize, max: usize, span: Span) -> OxcDiagnostic {
.with_label(span)
}

#[derive(Debug, Clone)]
#[derive(Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
#[schemars(default)]
pub struct MaxNestedDescribe {
/// Maximum allowed depth of nested describe calls.
pub max: usize,
}

Expand All @@ -39,13 +43,12 @@ declare_oxc_lint!(
///
/// Nesting `describe()` blocks too deeply can make the test suite hard to read and understand.
///
///
/// ### Example
///
/// The following patterns are considered warnings (with the default option of
/// `{ "max": 5 } `):
///
/// /// /// Examples of **incorrect** code for this rule:
/// Examples of **incorrect** code for this rule:
/// ```javascript
/// describe('foo', () => {
/// describe('bar', () => {
Expand Down Expand Up @@ -118,6 +121,7 @@ declare_oxc_lint!(
MaxNestedDescribe,
jest,
style,
config = MaxNestedDescribe
);

impl Rule for MaxNestedDescribe {
Expand Down
Loading