feat: Add `consistent-spacing-between-blocks` rule (#349) #388

davidenke · 2025-08-25T21:11:35Z

An ESLint rule that ensures consistent spacing between test blocks (e.g. test, test.step, test.beforeEach, etc.). This rule helps improve the readability and maintainability of test code by ensuring that test blocks are clearly separated from each other.

Note

Adds a new rule to enforce a blank line between Playwright test blocks, with docs, tests, utils, and plugin export.

Rules:
- New consistent-spacing-between-blocks: enforces a blank line before test, test.step, hooks; auto-fixable; recommended; error message missingWhitespace.
- Implementation in src/rules/consistent-spacing-between-blocks.ts; tests in src/rules/consistent-spacing-between-blocks.test.ts.
Utils:
- Add src/utils/test-expression.ts to unwrap and detect test-related expressions.
Plugin wiring:
- Export rule in src/index.ts under rules.
Docs:
- Add docs/rules/consistent-spacing-between-blocks.md with examples.
- Update README.md rules table to include consistent-spacing-between-blocks (✅, 🔧).

^{Written by Cursor Bugbot for commit 9374973. This will update automatically on new commits. Configure here.}

src/rules/consistent-spacing-between-blocks.test.ts

src/utils/test-expression.ts

src/index.ts

cursor

This PR is being reviewed by Cursor Bugbot

Details

You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

Bug: Recommended Rule Not Enabled

The consistent-spacing-between-blocks rule is marked as recommended in the README and its metadata, but it's not included in sharedConfig.rules. This means the rule won't be enabled in the recommended configuration, contradicting its documented status.

src/index.ts#L57-L58

eslint-plugin-playwright/src/index.ts

Lines 57 to 58 in 9374973

    
           rules: { 
        
             'consistent-spacing-between-blocks': consistentSpacingBetweenBlocks,

src/index.ts#L97-L134

eslint-plugin-playwright/src/index.ts

Lines 97 to 134 in 9374973

    
               'prefer-to-contain': preferToContain, 
        
               'prefer-to-have-count': preferToHaveCount, 
        
               'prefer-to-have-length': preferToHaveLength, 
        
               'prefer-web-first-assertions': preferWebFirstAssertions, 
        
               'require-hook': requireHook, 
        
               'require-soft-assertions': requireSoftAssertions, 
        
               'require-to-throw-message': requireToThrowMessage, 
        
               'require-top-level-describe': requireTopLevelDescribe, 
        
               'valid-describe-callback': validDescribeCallback, 
        
               'valid-expect': validExpect, 
        
               'valid-expect-in-promise': validExpectInPromise, 
        
               'valid-test-tags': validTestTags, 
        
               'valid-title': validTitle, 
        
             }, 
        
           } 
        
           const sharedConfig = { 
        
             rules: { 
        
               'no-empty-pattern': 'off', 
        
               'playwright/expect-expect': 'warn', 
        
               'playwright/max-nested-describe': 'warn', 
        
               'playwright/missing-playwright-await': 'error', 
        
               'playwright/no-conditional-expect': 'warn', 
        
               'playwright/no-conditional-in-test': 'warn', 
        
               'playwright/no-element-handle': 'warn', 
        
               'playwright/no-eval': 'warn', 
        
               'playwright/no-focused-test': 'error', 
        
               'playwright/no-force-option': 'warn', 
        
               'playwright/no-nested-step': 'warn', 
        
               'playwright/no-networkidle': 'error', 
        
               'playwright/no-page-pause': 'warn', 
        
               'playwright/no-skipped-test': 'warn', 
        
               'playwright/no-standalone-expect': 'error', 
        
               'playwright/no-unsafe-references': 'error', 
        
               'playwright/no-useless-await': 'warn', 
        
               'playwright/no-useless-not': 'warn', 
        
               'playwright/no-wait-for-navigation': 'error', 
        
               'playwright/no-wait-for-selector': 'warn',

README.md#L120-L121

eslint-plugin-playwright/README.md

Lines 120 to 121 in 9374973

    
           | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | :-: | :-: | :-: | 
        
           | [consistent-spacing-between-blocks](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/consistent-spacing-between-blocks.md) | Enforce consistent spacing between test blocks               | ✅  | 🔧  |     |

src/utils/test-expression.ts

src/rules/consistent-spacing-between-blocks.ts

mskelton · 2025-10-04T17:08:16Z

src/rules/consistent-spacing-between-blocks.ts

+      const nodeToCheck = getRealNodeToCheck(node)
+
+      if (isFirstNode(nodeToCheck)) return
+      if (hasNewlineBefore(nodeToCheck)) return
+
+      const leadingComments = sourceCode.getCommentsBefore(nodeToCheck)
+      const firstComment = leadingComments[0]
+      const reportLoc = firstComment?.loc ?? nodeToCheck.loc
+
+      context.report({
+        data: {
+          source: sourceCode.getText(nodeToCheck).split('\n')[0],
+        },
+        fix(fixer) {
+          const tokenBefore = sourceCode.getTokenBefore(nodeToCheck)
+          if (!tokenBefore) return null
+
+          const newlines =
+            nodeToCheck.loc?.start.line === tokenBefore.loc.end.line
+              ? '\n\n'
+              : '\n'
+          const targetNode = firstComment ?? nodeToCheck
+          const nodeStart = targetNode.range?.[0] ?? 0
+          const textBeforeNode = sourceCode.text.substring(0, nodeStart)
+          const lastNewlineIndex = textBeforeNode.lastIndexOf('\n')
+          const insertPosition = lastNewlineIndex + 1
+
+          return fixer.insertTextBeforeRange(
+            [insertPosition, nodeStart],
+            newlines,


This feels oddly complex. Why not just this:

Get the line number

Using context.sourceCode, get the previous line (or bail if the test is on the first line of the file)

If the previously line is all whitespace, it's good, otherwise it's not.

You're right, I boiled it down.

mskelton · 2025-10-04T17:08:58Z

src/rules/consistent-spacing-between-blocks.ts

+      if (parentType === 'IfStatement') {
+        return isPrecededByTokens(node, ['else', ')'])
+      }
+
+      if (parentType === 'DoWhileStatement') {
+        return isPrecededByTokens(node, ['do'])
+      }
+
+      if (parentType === 'SwitchCase') {
+        return isPrecededByTokens(node, [':'])
+      }


Just check if it's in a BlockStatement, doesn't matter what type of block

Now we're checking only for BlockStatements or Programs.

as requested in review

but turn it off by default to be opt-in

and adopt logic from existing official rules, like [`newline-before-return`](https://github.com/eslint/eslint/blob/main/lib/rules/newline-before-return.js)

davidenke mentioned this pull request Aug 25, 2025

ESLint rule to enforce a blank line before test() or test.step() #349

Open

davidenke force-pushed the rule/consistent-spacing-between-blocks branch from e0e16ec to 3b6154f Compare August 25, 2025 21:18

mskelton force-pushed the rule/consistent-spacing-between-blocks branch from 3b6154f to 9374973 Compare September 30, 2025 00:56

mskelton reviewed Sep 30, 2025

View reviewed changes

src/rules/consistent-spacing-between-blocks.test.ts Outdated Show resolved Hide resolved

mskelton reviewed Sep 30, 2025

View reviewed changes

src/utils/test-expression.ts Outdated Show resolved Hide resolved

mskelton reviewed Sep 30, 2025

View reviewed changes

src/index.ts Show resolved Hide resolved

cursor bot reviewed Sep 30, 2025

View reviewed changes

src/utils/test-expression.ts Outdated Show resolved Hide resolved

mskelton reviewed Sep 30, 2025

View reviewed changes

src/rules/consistent-spacing-between-blocks.ts Outdated Show resolved Hide resolved

davidenke requested a review from mskelton October 1, 2025 13:39

davidenke force-pushed the rule/consistent-spacing-between-blocks branch from 24a0d16 to b3373f0 Compare October 1, 2025 15:26

mskelton reviewed Nov 29, 2025

View reviewed changes

davidenke and others added 10 commits December 4, 2025 11:33

feat: Add consistent-spacing-between-blocks rule

f98e5fc

chore: remove comments

34bb0b9

as requested in review

test: expect errors for line numbers

0e7fc93

chore: add rule to recommended config

0c865a0

but turn it off by default to be opt-in

test: adopt wording of other tests

9a4aed5

refactor: use existing utils directly

9110244

and adopt logic from existing official rules, like [`newline-before-return`](https://github.com/eslint/eslint/blob/main/lib/rules/newline-before-return.js)

docs: format readme

e967642

chore: add as recommended with warn

235c39e

chore: remove unnecessary type casts

93c5a12

refactor: boil down complexity

1ab9e64

davidenke force-pushed the rule/consistent-spacing-between-blocks branch from 5f4cbd0 to 1ab9e64 Compare December 4, 2025 10:34

test: replace javascript with dedent tagging function

9c6a144

davidenke requested a review from mskelton December 4, 2025 10:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add `consistent-spacing-between-blocks` rule (#349) #388

feat: Add `consistent-spacing-between-blocks` rule (#349) #388

davidenke commented Aug 25, 2025 •

edited by cursor bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

Uh oh!

mskelton Oct 4, 2025

Uh oh!

davidenke Dec 4, 2025

Uh oh!

mskelton Oct 4, 2025

Uh oh!

davidenke Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	rules: {
	'consistent-spacing-between-blocks': consistentSpacingBetweenBlocks,

	'prefer-to-contain': preferToContain,
	'prefer-to-have-count': preferToHaveCount,
	'prefer-to-have-length': preferToHaveLength,
	'prefer-web-first-assertions': preferWebFirstAssertions,
	'require-hook': requireHook,
	'require-soft-assertions': requireSoftAssertions,
	'require-to-throw-message': requireToThrowMessage,
	'require-top-level-describe': requireTopLevelDescribe,
	'valid-describe-callback': validDescribeCallback,
	'valid-expect': validExpect,
	'valid-expect-in-promise': validExpectInPromise,
	'valid-test-tags': validTestTags,
	'valid-title': validTitle,
	},
	}

	const sharedConfig = {
	rules: {
	'no-empty-pattern': 'off',
	'playwright/expect-expect': 'warn',
	'playwright/max-nested-describe': 'warn',
	'playwright/missing-playwright-await': 'error',
	'playwright/no-conditional-expect': 'warn',
	'playwright/no-conditional-in-test': 'warn',
	'playwright/no-element-handle': 'warn',
	'playwright/no-eval': 'warn',
	'playwright/no-focused-test': 'error',
	'playwright/no-force-option': 'warn',
	'playwright/no-nested-step': 'warn',
	'playwright/no-networkidle': 'error',
	'playwright/no-page-pause': 'warn',
	'playwright/no-skipped-test': 'warn',
	'playwright/no-standalone-expect': 'error',
	'playwright/no-unsafe-references': 'error',
	'playwright/no-useless-await': 'warn',
	'playwright/no-useless-not': 'warn',
	'playwright/no-wait-for-navigation': 'error',
	'playwright/no-wait-for-selector': 'warn',

	\| --------------------------------------------------------------------------------------------------------------------------------------------------- \| ------------------------------------------------------------------ \| :-: \| :-: \| :-: \|
	\| [consistent-spacing-between-blocks](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/consistent-spacing-between-blocks.md) \| Enforce consistent spacing between test blocks \| ✅ \| 🔧 \| \|

feat: Add consistent-spacing-between-blocks rule (#349) #388

Are you sure you want to change the base?

feat: Add consistent-spacing-between-blocks rule (#349) #388

Conversation

davidenke commented Aug 25, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

This PR is being reviewed by Cursor Bugbot

Bug: Recommended Rule Not Enabled

Uh oh!

Uh oh!

Uh oh!

mskelton Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

davidenke Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

mskelton Oct 4, 2025

Choose a reason for hiding this comment

Uh oh!

davidenke Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: Add `consistent-spacing-between-blocks` rule (#349) #388

feat: Add `consistent-spacing-between-blocks` rule (#349) #388

davidenke commented Aug 25, 2025 •

edited by cursor bot

Loading