Skip to content

docs(linter): Add configuration option docs for jest/no-large-snapshots rule. #15079

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

docs(linter): Add configuration option docs for jest/no-large-snapshots rule. #15079

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
10 changes: 9 additions & 1 deletion crates/oxc_linter/src/rules/jest/no_large_snapshots.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::{CompactStr, GetSpan, Span};
use rustc_hash::FxHashMap;
use schemars::JsonSchema;
use serde::Deserialize;

use crate::{
context::LintContext,
Expand All @@ -35,10 +37,15 @@ fn too_long_snapshot(line_limit: usize, line_count: usize, span: Span) -> OxcDia
#[derive(Debug, Default, Clone)]
pub struct NoLargeSnapshots(Box<NoLargeSnapshotsConfig>);

#[derive(Debug, Clone)]
#[derive(Debug, Clone, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct NoLargeSnapshotsConfig {
/// Maximum number of lines allowed for external snapshot files.
pub max_size: usize,
/// Maximum number of lines allowed for inline snapshots.
pub inline_max_size: usize,
/// A map of snapshot file paths to arrays of snapshot names that are allowed to exceed the size limit.
/// Snapshot names can be specified as regular expressions.
pub allowed_snapshots: FxHashMap<CompactStr, Vec<CompactStr>>,
}

Expand Down Expand Up @@ -140,6 +147,7 @@ declare_oxc_lint!(
NoLargeSnapshots,
jest,
style,
config = NoLargeSnapshotsConfig,
);

impl Rule for NoLargeSnapshots {
Expand Down
Loading