Skip to content

docs(linter): Add configuration option docs for jest/require-top-level-describe rule. #14973

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 1 commit into from
Oct 27, 2025
Merged

docs(linter): Add configuration option docs for jest/require-top-level-describe rule. #14973

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
22 changes: 5 additions & 17 deletions crates/oxc_linter/src/rules/jest/require_top_level_describe.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use oxc_macros::declare_oxc_lint;
use oxc_semantic::ScopeId;
use oxc_span::Span;
use rustc_hash::FxHashMap;
use schemars::JsonSchema;

use crate::{
context::LintContext,
Expand Down Expand Up @@ -34,8 +35,10 @@ fn unexpected_hook(span: Span) -> OxcDiagnostic {
.with_label(span)
}

#[derive(Debug, Clone)]
#[derive(Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct RequireTopLevelDescribe {
/// The maximum number of top-level `describe` blocks allowed in a test file.
pub max_number_of_top_level_describes: usize,
}

Expand Down Expand Up @@ -96,25 +99,10 @@ declare_oxc_lint!(
/// });
/// });
/// ```
///
/// ### Options
///
/// You can also enforce a limit on the number of describes allowed at the top-level
/// using the `maxNumberOfTopLevelDescribes` option:
///
/// ```json
/// {
/// "jest/require-top-level-describe": [
/// "error",
/// {
/// "maxNumberOfTopLevelDescribes": 2
/// }
/// ]
/// }
/// ```
RequireTopLevelDescribe,
jest,
style,
config = RequireTopLevelDescribe
);

impl Rule for RequireTopLevelDescribe {
Expand Down
Loading