feat(linter/jest): implement padding-around-after-all-blocks#21034
feat(linter/jest): implement padding-around-after-all-blocks#21034camc314 merged 5 commits intooxc-project:mainfrom
Conversation
Merging this PR will not alter performance
Comparing Footnotes
|
There was a problem hiding this comment.
Pull request overview
Implements the eslint-plugin-jest rule jest/padding-around-after-all-blocks in oxc_linter, sharing padding-detection logic via a new Jest utility and updating rule registration/generated plumbing.
Changes:
- Added
PaddingAroundAfterAllBlocksrule with autofix and snapshot coverage. - Extracted common “missing padding before Jest block” logic into
utils/jest/padding_around_block.rsand reused it inpadding_around_test_blocks. - Registered the new rule in
rules.rsand updated generated rule enums/runners.
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/oxc_linter/src/utils/jest/padding_around_block.rs | New shared helper to diagnose/autofix missing blank lines before Jest blocks (with comment-aware heuristics). |
| crates/oxc_linter/src/utils/jest.rs | Re-exports the new helper and wires the module into the Jest utils namespace. |
| crates/oxc_linter/src/rules/jest/padding_around_test_blocks.rs | Refactors existing rule to use the shared padding helper. |
| crates/oxc_linter/src/rules/jest/padding_around_after_all_blocks.rs | New rule implementation + tests for afterAll padding enforcement. |
| crates/oxc_linter/src/snapshots/jest_padding_around_after_all_blocks.snap | Snapshot for the new rule’s diagnostics. |
| crates/oxc_linter/src/rules.rs | Adds the new Jest rule module to the rule tree. |
| crates/oxc_linter/src/generated/rules_enum.rs | Generated enum/registry updates to include the new rule. |
| crates/oxc_linter/src/generated/rule_runner_impls.rs | Generated runner impl for the new rule. |
| /// This rule enforces a line of padding before and after 1 or more | ||
| /// `afterAll` statements. | ||
| /// | ||
| /// ### Why is this bad? | ||
| /// | ||
| /// Inconsistent formatting of code can make the code more difficult to read | ||
| /// and follow. This rule helps ensure that `afterAll` blocks are visually | ||
| /// separated from the rest of the code, making them easier to identify while |
There was a problem hiding this comment.
The rule docs say it enforces padding “before and after” afterAll statements, but the implementation only checks for missing padding before the afterAll call. Either update the implementation to also enforce padding after the afterAll block, or adjust the documentation to match the current behavior.
| /// This rule enforces a line of padding before and after 1 or more | |
| /// `afterAll` statements. | |
| /// | |
| /// ### Why is this bad? | |
| /// | |
| /// Inconsistent formatting of code can make the code more difficult to read | |
| /// and follow. This rule helps ensure that `afterAll` blocks are visually | |
| /// separated from the rest of the code, making them easier to identify while | |
| /// This rule enforces a line of padding before 1 or more `afterAll` | |
| /// statements. | |
| /// | |
| /// ### Why is this bad? | |
| /// | |
| /// Inconsistent formatting of code can make the code more difficult to read | |
| /// and follow. This rule helps ensure that `afterAll` blocks are visually | |
| /// separated from preceding code, making them easier to identify while |
| let mut comments_range = ctx.comments_range(prev_statement_span.end..node.span().start); | ||
| let mut span_between_start = prev_statement_span.end; | ||
| let mut span_between_end = node.span().start; | ||
| if let Some(last_comment_span) = comments_range.next_back().map(|comment| comment.span) { | ||
| let space_after_last_comment = | ||
| ctx.source_range(Span::new(last_comment_span.end, node.span().start)); | ||
| let space_before_last_comment = | ||
| ctx.source_range(Span::new(prev_statement_span.end, last_comment_span.start)); | ||
| if space_after_last_comment.matches('\n').count() > 1 | ||
| || space_before_last_comment.matches('\n').count() == 0 | ||
| { | ||
| span_between_start = last_comment_span.end; | ||
| } else { | ||
| span_between_end = last_comment_span.start; |
There was a problem hiding this comment.
report_missing_padding_before_jest_block only looks at the last comment between the previous statement and the Jest block when deciding where to measure/insert padding. With multiple leading comments (e.g. const x=1;\n// c1\n// c2\nafterAll(...)), this can incorrectly treat the extra comment newlines as “padding” and skip reporting/fixing the missing blank line before the comment group. Consider treating a contiguous group of comments as attached to the Jest block (walk backwards across adjacent comments with no blank line between them) and then enforce padding before the first comment in that group.
| let mut comments_range = ctx.comments_range(prev_statement_span.end..node.span().start); | |
| let mut span_between_start = prev_statement_span.end; | |
| let mut span_between_end = node.span().start; | |
| if let Some(last_comment_span) = comments_range.next_back().map(|comment| comment.span) { | |
| let space_after_last_comment = | |
| ctx.source_range(Span::new(last_comment_span.end, node.span().start)); | |
| let space_before_last_comment = | |
| ctx.source_range(Span::new(prev_statement_span.end, last_comment_span.start)); | |
| if space_after_last_comment.matches('\n').count() > 1 | |
| || space_before_last_comment.matches('\n').count() == 0 | |
| { | |
| span_between_start = last_comment_span.end; | |
| } else { | |
| span_between_end = last_comment_span.start; | |
| let comment_spans: Vec<Span> = | |
| ctx.comments_range(prev_statement_span.end..node.span().start).map(|comment| comment.span).collect(); | |
| let mut span_between_start = prev_statement_span.end; | |
| let mut span_between_end = node.span().start; | |
| if let Some(&last_comment_span) = comment_spans.last() { | |
| let mut first_comment_in_group = last_comment_span; | |
| for &comment_span in comment_spans.iter().rev().skip(1) { | |
| let space_between_comments = | |
| ctx.source_range(Span::new(comment_span.end, first_comment_in_group.start)); | |
| if space_between_comments.matches('\n').count() == 1 { | |
| first_comment_in_group = comment_span; | |
| } else { | |
| break; | |
| } | |
| } | |
| let space_after_comment_group = | |
| ctx.source_range(Span::new(last_comment_span.end, node.span().start)); | |
| let space_before_comment_group = | |
| ctx.source_range(Span::new(prev_statement_span.end, first_comment_in_group.start)); | |
| if space_after_comment_group.matches('\n').count() > 1 | |
| || space_before_comment_group.matches('\n').count() == 0 | |
| { | |
| span_between_start = last_comment_span.end; | |
| } else { | |
| span_between_end = first_comment_in_group.start; |
|
|
||
| fn padding_around_jest_block_diagnostic(span: Span, name: &str) -> OxcDiagnostic { | ||
| OxcDiagnostic::warn(format!("Missing padding before {name} block")) | ||
| .with_help(format!("Make sure there is an empty new line before the {name} block")) |
There was a problem hiding this comment.
Diagnostic help text says “empty new line”, which is unidiomatic and a bit unclear for users. Consider changing it to “blank line” or “empty line”.
| .with_help(format!("Make sure there is an empty new line before the {name} block")) | |
| .with_help(format!("Make sure there is a blank line before the {name} block")) |
# Oxlint ### 💥 BREAKING CHANGES - 22ce6af oxlint/lsp: [**BREAKING**] Show/fix safe suggestions by default (#19816) (Sysix) ### 🚀 Features - 7a7b7b8 oxlint/lsp: Add source.fixAllDangerous.oxc code action kind (#20526) (bab) - 9cfe57e linter/unicorn: Implement prefer-import-meta-properties rule (#20662) (Irfan - ئىرفان) - 1edb391 linter/eslint: Implement `no-restricted-exports` rule (#20592) (Nicolas Le Cam) - 0f12bcd linter/react: Implement `hook-use-state` rule (#20986) (Khaled Labeb) - 1513a9f oxlint/lsp: Show note field for lsp diagnostic (#20983) (Sysix) - 7fdf722 linter/unicorn: Implement `no-useless-iterator-to-array` rule (#20945) (Mikhail Baev) - 39c8f2c linter/jest: Implement padding-around-after-all-blocks (#21034) (Sapphire) - ac39e51 linter/eslint-vitest-plugin: Prefer importing vitest globals (#20960) (Said Atrahouch) - 0b84de1 oxlint: Support allow option for prefer-promise-reject-errors (#20934) (camc314) - 23db851 linter/consistent-return: Move rule from nursery to suspicious (#20920) (camc314) - 9a27e32 linter/no-unnecessary-type-conversion: Move rule from nursery to suspicious (#20919) (camc314) - 1ca7b58 linter/dot-notation: Move rule from nursery to style (#20918) (camc314) - 73ba81a linter/consistent-type-exports: Move rule from nursery to style (#20917) (camc314) - b9199b1 linter/unicorn: Implement switch-case-break-position (#20872) (Mikhail Baev) - 3435ff8 linter: Implements `prefer-snapshot-hint` rule in Jest and Vitest (#20870) (Said Atrahouch) - 98510d2 linter: Implement react/prefer-function-component (#19652) (Connor Shea) - 871f9d9 linter: Implement no-useless-assignment (#15466) (Zhaoting Zhou) - 0f01fbd linter: Implement eslint/object-shorthand (#17688) (yue) ### 🐛 Bug Fixes - dd2df87 npm: Export package.json for oxlint and oxfmt (#20784) (kazuya kawaguchi) - 9bc77dd linter/no-unused-private-class-members: False positive with await expr (#21067) (camc314) - 60a57cd linter/const-comparisons: Detect equality contradictions (#21065) (camc314) - 2bb2be2 linter/no-array-index-key: False positive when index is passed as function argument (#21012) (bab) - 6492953 linter/no-this-in-sfc: Only flag `this` used as member expression object (#20961) (bab) - 9446dcc oxlint/lsp: Skip `node_modules` in oxlint config walker (#21004) (copilot-swe-agent) - af89923 linter/no-namespace: Support glob pattern matching against basename (#21031) (bab) - 64a1a7e oxlint: Don't search for nested config outside base config (#21051) (Sysix) - 3b953bc linter/button-has-type: Ignore `document.createElement` calls (#21008) (Said Atrahouch) - 8c36070 linter/unicorn: Add support for `Array.from()` for `prefer-set-size` rule (#21016) (Mikhail Baev) - c1a48f0 linter: Detect vitest import from vite-plus/test (#20976) (Said Atrahouch) - 5c32fd1 lsp: Prevent corrupted autofix output from overlapping text edits (#19793) (Peter Wagenet) - ca79960 linter/no-array-index-key: Move span to `key` property (#20947) (camc314) - 2098274 linter: Add suggestion for `jest/prefer-equality-matcher` (#20925) (eryue0220) - 6eb77ec linter: Allow default-import barrels in import/named (#20757) (Bazyli Brzóska) - 9c218ef linter/eslint-vitest-plugin: Remove pending fix status for require-local-test-context-for-concurrent-snapshot (#20890) (Said Atrahouch) ### ⚡ Performance - fb52383 napi/parser, linter/plugins: Clear buffers and source texts earlier (#21025) (overlookmotel) - 3b7dec4 napi/parser, linter/plugins: Use `utf8Slice` for decoding UTF-8 strings (#21022) (overlookmotel) - 012c924 napi/parser, linter/plugins: Speed up decoding strings in raw transfer (#21021) (overlookmotel) - 55e1e9b napi/parser, linter/plugins: Initialize vars as 0 (#21020) (overlookmotel) - c25ef02 napi/parser, linter/plugins: Simplify branch condition in `deserializeStr` (#21019) (overlookmotel) - 9f494c3 napi/parser, linter/plugins: Raw transfer use `String.fromCharCode` in string decoding (#21018) (overlookmotel) - 0503a78 napi/parser, linter/plugins: Faster deserialization of `raw` fields (#20923) (overlookmotel) - a24f75e napi/parser: Optimize string deserialization for non-ASCII sources (#20834) (Joshua Tuddenham) ### 📚 Documentation - af72b80 oxlint: Fix typo for --tsconfig (#20889) (leaysgur) - 70c53b1 linter: Highlight that tsconfig is not respected in type aware linting (#20884) (camc314) # Oxfmt ### 🚀 Features - 35cf6e8 oxfmt: Add node version hint for ts config import failures (#21046) (camc314) ### 🐛 Bug Fixes - dd2df87 npm: Export package.json for oxlint and oxfmt (#20784) (kazuya kawaguchi) - 9d45511 oxfmt: Propagate file write errors instead of panicking (#20997) (leaysgur) - 139ddd9 formatter: Handle leading comment after array elision (#20987) (leaysgur) - 4216380 oxfmt: Support `.editorconfig` `tab_width` fallback (#20988) (leaysgur) - d10df39 formatter: Resolve pending space in fits measurer before expanded-mode early exit (#20954) (Dunqing) - f9ef1bd formatter: Avoid breaking after `=>` when arrow body has JSDoc type cast (#20857) (bab) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Summary
jest/padding-around-after-all-blocksruleafterAllblocks in test filesPart of #492.