Added eslint-plugin-playwright linting to e2e package #25344

cmraible · 2025-11-04T17:29:22Z

no issue

This PR does two things in the e2e package:

Installs and enables eslint-plugin-playwright for our e2e test suite using the recommended configuration
Disables mocha rules from the main ghost eslint plugin in the e2e package, which just create noise currently

Note: If you run yarn lint in the e2e package in this PR, you'll see a bunch of warnings. I'd like to tackle some of these in follow up PRs, and potentially change a few rules from "warn" to "error" for the more impactful ones.

Note

Enables eslint-plugin-playwright with recommended config for e2e and disables Mocha-specific rules; adds the Playwright ESLint plugin dependency.

Linting/Config:
- Add playwright plugin and apply plugin:playwright/recommended in e2e/.eslintrc.js for tests/**, helpers/playwright/**, and helpers/pages/**.
- Disable all ghost/mocha/* rules in e2e/tests/.eslintrc.js to avoid Mocha-specific linting in Playwright tests.
Dependencies:
- Add eslint-plugin-playwright to e2e/package.json and update yarn.lock.

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

coderabbitai · 2025-11-04T17:29:38Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

The PR updates the e2e testing configuration to add Playwright ESLint support and related dev dependencies. e2e/.eslintrc.js adds the eslint-plugin-playwright and an overrides block applying plugin:playwright/recommended to test-related paths. e2e/package.json adds devDependencies (@tryghost/debug, @tryghost/logging, @types/dockerode, eslint-plugin-playwright). e2e/tests/.eslintrc.js replaces a single no-console disable with a block that disables many Mocha/Ghost-specific rules and adds a comment noting Playwright is used instead.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Verify the overrides paths in e2e/.eslintrc.js match actual test directories (tests/**, helpers/playwright/**, helpers/pages/**).
Confirm the long list of disabled Mocha/Ghost rules in e2e/tests/.eslintrc.js is intentional and doesn’t unintentionally silence needed checks.
Review added devDependencies in e2e/package.json for correct versions, duplicates, and necessity in the e2e environment.

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding eslint-plugin-playwright linting to the e2e package, which is the primary focus of the changeset.
Description check	✅ Passed	The description clearly explains the two main changes (installing eslint-plugin-playwright and disabling mocha rules) and provides context about follow-up plans, directly relating to the changeset.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch e2e-playwright-lint

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 203fd35 and ecc930a.

📒 Files selected for processing (1)

e2e/.eslintrc.js (2 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-09T17:25:12.439Z
Learning: Applies to e2e/** : End-to-end tests should live under the e2e/ directory (Playwright-based)

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: apps/comments-ui/.cursor/rules/playwright-e2e.mdc:0-0
Timestamp: 2025-07-19T21:18:10.726Z
Learning: Set PLAYWRIGHT_REPORTER=list environment variable before running Playwright e2e tests as an AI agent

Learnt from: niranjan-uma-shankar
Repo: TryGhost/Ghost PR: 24557
File: apps/admin-x-settings/src/components/settings/general/TimeZone.tsx:7-7
Timestamp: 2025-08-01T12:44:07.467Z
Learning: In Ghost development, PRs may depend on unpublished changes from SDK packages. When this occurs, TypeScript compilation errors for missing exports are expected and documented in the PR description until the dependency packages are published and updated. This is normal workflow for cross-repository feature development.

Learnt from: kevinansfield
Repo: TryGhost/Ghost PR: 24651
File: ghost/core/test/utils/urlUtils.js:53-57
Timestamp: 2025-08-11T19:39:00.428Z
Learning: In Ghost's test utilities, when fixing specific issues like async behavior, it's preferred to maintain existing error handling patterns (even if suboptimal) to keep PRs focused on their primary objective. Error handling improvements can be addressed in separate, dedicated PRs.

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: e2e/AGENTS.md:0-0
Timestamp: 2025-10-08T14:20:28.632Z
Learning: Applies to e2e/tests/**/*.ts : Test suite titles should follow: 'Ghost Admin - Feature' or 'Ghost Public - Feature'

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: e2e/AGENTS.md:0-0
Timestamp: 2025-10-08T14:20:28.632Z
Learning: Applies to e2e/tests/public/**/*.ts : Public site end-to-end tests should reside under tests/public/

📚 Learning: 2025-10-09T17:25:12.439Z

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-09T17:25:12.439Z
Learning: Applies to e2e/** : End-to-end tests should live under the e2e/ directory (Playwright-based)

Applied to files:

e2e/.eslintrc.js

📚 Learning: 2025-07-19T21:18:10.726Z

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: apps/comments-ui/.cursor/rules/playwright-e2e.mdc:0-0
Timestamp: 2025-07-19T21:18:10.726Z
Learning: Set PLAYWRIGHT_REPORTER=list environment variable before running Playwright e2e tests as an AI agent

Applied to files:

e2e/.eslintrc.js

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)

GitHub Check: Acceptance tests (Node 22.13.1, sqlite3)
GitHub Check: Signup-form tests
GitHub Check: Admin-X Settings tests
GitHub Check: Legacy tests (Node 22.13.1, sqlite3)
GitHub Check: Acceptance tests (Node 22.13.1, mysql8)
GitHub Check: Legacy tests (Node 22.13.1, mysql8)
GitHub Check: Unit tests (Node 22.13.1)
GitHub Check: Ghost-CLI tests
GitHub Check: Admin tests - Chrome
GitHub Check: ActivityPub tests
GitHub Check: Comments-UI tests
GitHub Check: Lint
GitHub Check: Cursor Bugbot
GitHub Check: Build & Push

🔇 Additional comments (2)

e2e/.eslintrc.js (2)

3-6: LGTM! Plugin registration is correct.

The plugin is correctly registered using the short name 'playwright', which is the proper ESLint convention and matches the usage in the overrides block (plugin:playwright/recommended).

Note: The past review comment about plugin name mismatch appears to have been resolved.

17-22: LGTM! Overrides configuration is well-structured.

The overrides block correctly applies Playwright's recommended rules to the appropriate test-related paths. The targeted paths (tests/**, helpers/playwright/**, helpers/pages/**) align well with a Playwright test suite structure.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-11-04T17:40:19Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.10%. Comparing base (40d390a) to head (ecc930a).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #25344      +/-   ##
==========================================
+ Coverage   72.08%   72.10%   +0.01%     
==========================================
  Files        1515     1515              
  Lines      115137   115104      -33     
  Branches    13791    13781      -10     
==========================================
- Hits        83002    82995       -7     
+ Misses      31119    31114       -5     
+ Partials     1016      995      -21

Flag	Coverage Δ
admin-tests	`51.53% <ø> (+0.06%)`	⬆️
e2e-tests	`72.10% <ø> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

e2e/.eslintrc.js (1)
3-6: Consider using the conventional short form for the plugin name.

While 'eslint-plugin-playwright' works, ESLint convention is to use the short form 'playwright' when the plugin package is named eslint-plugin-playwright.

Apply this diff for consistency with ESLint conventions:
     plugins: [
         'ghost',
-        'eslint-plugin-playwright'
+        'playwright'
     ],

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ebb0ba2 and 203fd35.

⛔ Files ignored due to path filters (1)

yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (3)

e2e/.eslintrc.js (1 hunks)
e2e/package.json (1 hunks)
e2e/tests/.eslintrc.js (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

e2e/**

📄 CodeRabbit inference engine (AGENTS.md)

End-to-end tests should live under the e2e/ directory (Playwright-based)

Files:

e2e/package.json

🧠 Learnings (13)

📓 Common learnings

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-09T17:25:12.439Z
Learning: Applies to e2e/** : End-to-end tests should live under the e2e/ directory (Playwright-based)

Learnt from: kevinansfield
Repo: TryGhost/Ghost PR: 24651
File: ghost/core/test/utils/urlUtils.js:53-57
Timestamp: 2025-08-11T19:39:00.428Z
Learning: In Ghost's test utilities, when fixing specific issues like async behavior, it's preferred to maintain existing error handling patterns (even if suboptimal) to keep PRs focused on their primary objective. Error handling improvements can be addressed in separate, dedicated PRs.

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: apps/shade/AGENTS.md:0-0
Timestamp: 2025-10-15T07:53:49.814Z
Learning: Run yarn lint, yarn test, and validate in Storybook before opening a PR; always run yarn lint to fix ESLint issues before committing

📚 Learning: 2025-10-09T17:25:12.439Z

Learnt from: CR
Repo: TryGhost/Ghost PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-09T17:25:12.439Z
Learning: Applies to e2e/** : End-to-end tests should live under the e2e/ directory (Playwright-based)

Applied to files:

e2e/tests/.eslintrc.js
e2e/.eslintrc.js

📚 Learning: 2025-08-11T19:39:00.428Z

Learnt from: kevinansfield
Repo: TryGhost/Ghost PR: 24651
File: ghost/core/test/utils/urlUtils.js:53-57
Timestamp: 2025-08-11T19:39:00.428Z
Learning: In Ghost's test utilities, when fixing specific issues like async behavior, it's preferred to maintain existing error handling patterns (even if suboptimal) to keep PRs focused on their primary objective. Error handling improvements can be addressed in separate, dedicated PRs.

Applied to files:

e2e/tests/.eslintrc.js