Update severity and folder pattern, add formatting rules for Playwright

Author: Tlacenka

README.md

@@ -90,7 +90,7 @@ All peer dependencies used by `@code-pushup/eslint-config` are listed below, alo
 |       ![jest](./docs/icons/material/jest.png)       | [eslint-plugin-jest](https://www.npmjs.com/package/eslint-plugin-jest)                               | `^28.8.0`  |          |
 |        ![test](./docs/icons/icons8/test.png)        | [eslint-plugin-jest-formatting](https://www.npmjs.com/package/eslint-plugin-jest-formatting)         |  `^3.0.0`  |          |
 |     ![nodejs](./docs/icons/material/nodejs.png)     | [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n)                                     | `>=17.0.0` |          |
-| ![playwright](./docs/icons/material/playwright.png) | [eslint-plugin-playwright](https://www.npmjs.com/package/eslint-plugin-playwright)                   | `>=2.1.0`  |          |
+| ![playwright](./docs/icons/material/playwright.png) | [eslint-plugin-playwright](https://www.npmjs.com/package/eslint-plugin-playwright)                   |  `^2.1.0`  |          |
 |        ![rxjs](./docs/icons/other/rxjs.png)         | [eslint-plugin-rxjs-x](https://www.npmjs.com/package/eslint-plugin-rxjs-x)                           | `>=0.6.0`  |          |
 |  ![storybook](./docs/icons/material/storybook.png)  | [eslint-plugin-storybook](https://www.npmjs.com/package/eslint-plugin-storybook)                     | `>=0.10.0` |          |
 |     ![vitest](./docs/icons/material/vitest.png)     | [eslint-plugin-vitest](https://www.npmjs.com/package/eslint-plugin-vitest)                           | `>=0.5.0`  |          |

docs/playwright.md

@@ -8,7 +8,7 @@ Config for projects using **Playwright** for testing.
 2. Since this plugin requires additional peer dependencies, you have to install them as well:
 
    ```sh
-   npm install -D eslint-plugin-playwright
+   npm install -D eslint-plugin-{jest-formatting,playwright}
    ```
 
 3. Add to your `eslint.config.js` file:
@@ -20,29 +20,29 @@ Config for projects using **Playwright** for testing.
    export default tseslint.config(...playwright);
    ```
 
-## 📏 Rules (38)
+## 📏 Rules (40)
 
 > 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).<br>💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-### 🚨 Errors (10)
+### 🚨 Errors (8)
 
 |                                                          Plugin                                                           | Rule                                                                                                                                                                                                                             | Options | Autofix | Overrides |
 | :-----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :-----: | :-------: |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [missing-playwright-await](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/missing-playwright-await.md)<br />Identify false positives when async Playwright APIs are not properly awaited. |         |   🔧    |           |
-| [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-focused-test](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-focused-test.md)<br />Prevent usage of `.only()` focus test annotation                                                |         |   💡    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-networkidle](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-networkidle.md)<br />Prevent usage of the networkidle option                                                           |         |         |           |
-| [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-standalone-expect](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-standalone-expect.md)<br />Disallow using `expect` outside of `test` blocks                                      |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-unsafe-references](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-unsafe-references.md)<br />Prevent unsafe variable references in page.evaluate()                                 |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [prefer-web-first-assertions](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/prefer-web-first-assertions.md)<br />Prefer web first assertions                                             |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [valid-describe-callback](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-describe-callback.md)<br />Enforce valid `describe()` callback                                             |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [valid-expect](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-expect.md)<br />Enforce valid `expect()` usage                                                                        |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [valid-expect-in-promise](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-expect-in-promise.md)<br />Require promises that have expectations in their chain to be valid              |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [valid-title](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/valid-title.md)<br />Enforce valid titles                                                                                    |         |   🔧    |           |
 
-### ⚠️ Warnings (28)
+### ⚠️ Warnings (32)
 
 |                                                          Plugin                                                           | Rule                                                                                                                                                                                                                                | Options | Autofix | Overrides |
 | :-----------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :-----: | :-------: |
+|   [![jest-formatting](./icons/icons8/test.png)](https://github.com/dangreenisrael/eslint-plugin-jest-formatting#readme)   | padding-around-describe-blocks<br />                                                                                                                                                                                                |         |   🔧    |           |
+|   [![jest-formatting](./icons/icons8/test.png)](https://github.com/dangreenisrael/eslint-plugin-jest-formatting#readme)   | padding-around-test-blocks<br />                                                                                                                                                                                                    |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [expect-expect](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/expect-expect.md)<br />Enforce assertion to be made in a test body                                                            |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [max-nested-describe](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/max-nested-describe.md)<br />Enforces a maximum depth to nested describe calls                                          |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-commented-out-tests](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-commented-out-tests.md)<br />Disallow commented out tests                                                         |         |         |           |
@@ -51,10 +51,12 @@ Config for projects using **Playwright** for testing.
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-duplicate-hooks](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-duplicate-hooks.md)<br />Disallow duplicate setup and teardown hooks                                                  |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-element-handle](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-element-handle.md)<br />The use of ElementHandle is discouraged, use Locator instead                                   |         |   💡    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-eval](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-eval.md)<br />The use of `page.$eval` and `page.$$eval` are discouraged, use `locator.evaluate` or `locator.evaluateAll` instead |         |         |           |
+| [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-focused-test](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-focused-test.md)<br />Prevent usage of `.only()` focus test annotation                                                   |         |   💡    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-force-option](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-force-option.md)<br />Prevent usage of `{ force: true }` option.                                                         |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-nested-step](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-nested-step.md)<br />Disallow nested `test.step()` methods                                                                |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-page-pause](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-page-pause.md)<br />Prevent usage of page.pause()                                                                          |         |         |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-skipped-test](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-skipped-test.md)<br />Prevent usage of the `.skip()` skip test annotation.                                               |         |   💡    |           |
+| [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-standalone-expect](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-standalone-expect.md)<br />Disallow using `expect` outside of `test` blocks                                         |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-useless-await](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-await.md)<br />Disallow unnecessary awaits for Playwright methods                                               |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-useless-not](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-useless-not.md)<br />Disallow usage of 'not' matchers when a more specific matcher exists                                 |         |   🔧    |           |
 | [![playwright](./icons/material/playwright.png)](https://github.com/playwright-community/eslint-plugin-playwright#readme) | [no-wait-for-selector](https://github.com/playwright-community/eslint-plugin-playwright/tree/main/docs/rules/no-wait-for-selector.md)<br />Prevent usage of page.waitForSelector()                                                  |         |   💡    |           |

package.json

@@ -50,7 +50,7 @@
     "eslint-plugin-jest": "^28.8.0",
     "eslint-plugin-jest-formatting": "^3.0.0",
     "eslint-plugin-n": ">=17.0.0",
-    "eslint-plugin-playwright": ">=2.1.0",
+    "eslint-plugin-playwright": "^2.1.0",
     "eslint-plugin-promise": ">=6.4.0",
     "eslint-plugin-rxjs-x": ">=0.6.0",
     "eslint-plugin-sonarjs": "^1.0.4",

src/configs/playwright.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+import * as jestFormatting from 'eslint-plugin-jest-formatting';
 import playwright from 'eslint-plugin-playwright';
 import tseslint from 'typescript-eslint';
 import { PLAYWRIGHT_FILE_PATTERNS } from '../lib/patterns.js';
@@ -8,19 +9,30 @@ export default tseslint.config({
   files: PLAYWRIGHT_FILE_PATTERNS,
   extends: [
     playwright.configs['flat/recommended'],
+    {
+      name: 'code-pushup/playwright/jest-formatting',
+      plugins: {
+        'jest-formatting': jestFormatting,
+      },
+      rules: {
+        'jest-formatting/padding-around-describe-blocks': 'warn',
+        'jest-formatting/padding-around-test-blocks': 'warn',
+      },
+    },
     {
       name: 'code-pushup/playwright/customized',
       rules: {
         'playwright/no-conditional-expect': 'warn',
         'playwright/no-conditional-in-test': 'warn',
+        'playwright/no-focused-test': 'warn',
+        'playwright/no-standalone-expect': 'warn',
       },
     },
     {
       name: 'code-pushup/playwright/additional',
       rules: {
         'playwright/no-commented-out-tests': 'warn',
         'playwright/no-duplicate-hooks': 'warn',
-        'playwright/no-focused-test': 'warn',
         'playwright/no-nested-step': 'warn',
         'playwright/prefer-comparison-matcher': 'warn',
         'playwright/prefer-equality-matcher': 'warn',

src/lib/patterns.js

@@ -69,13 +69,13 @@ export const HTML_FILE_PATTERNS = ['**/*.html'];
 
 export const CYPRESS_FILE_PATTERNS = [
   '**/*.cy.[jt]s?(x)',
-  '**/e2e/**/*.[jt]s?(x)',
+  '**/?(*-)e2e/**/*.[jt]s?(x)',
 ];
 
 export const PLAYWRIGHT_FILE_PATTERNS = [
   '**/*.+(test|spec).[jt]s?(x)',
   '**/*.po.[jt]s?(x)',
-  '**/e2e/**/*.[jt]s?(x)',
+  '**/?(*-)e2e/**/*.[jt]s?(x)',
 ];
 
 export const NODE_FILE_PATTERNS = ['**/*.ts', '**/*.js'];

tests/configs/cypress.spec.js

@@ -1,30 +1,36 @@
 // @ts-check
 
-import { afterAll, beforeAll, describe, expect, test } from 'vitest';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 import { createLintUtils } from '../helpers/lint-utils';
 
 describe('cypress config', () => {
   const { setup, teardown, loadConfig } = createLintUtils('cypress', '*.cy.js');
 
   beforeAll(setup);
+
   afterAll(teardown);
 
-  test('should not include Cypress rules for non-Cypress file', async () => {
+  it('should not include Cypress rules for non-Cypress file', async () => {
     const config = await loadConfig('auth.spec.js');
     expect(Object.keys(config.rules ?? {}).join(',')).not.toContain('cypress/');
   });
 
-  test('should include cypress rules for Cypress file', async () => {
-    const config = await loadConfig('e2e/login.cy.js');
+  it('should include cypress rules for Cypress file', async () => {
+    const config = await loadConfig('app/submit-form.cy.js');
+    expect(Object.keys(config.rules ?? {}).join(',')).toContain('cypress/');
+  });
+
+  it('should include cypress rules for Cypress folder', async () => {
+    const config = await loadConfig('app-e2e/login.js');
     expect(Object.keys(config.rules ?? {}).join(',')).toContain('cypress/');
   });
 
-  test('should have rule from extended recommended cypress config', async () => {
+  it('should have rule from extended recommended cypress config', async () => {
     const config = await loadConfig();
     expect(config.rules).toHaveProperty('cypress/no-unnecessary-waiting');
   });
 
-  test('should have explicitly added rule', async () => {
+  it('should have explicitly added rule', async () => {
     const config = await loadConfig();
     expect(config.rules).toHaveProperty('cypress/no-force');
   });

tests/configs/playwright.spec.js

@@ -25,8 +25,13 @@ describe('playwright config', () => {
     expect(Object.keys(config.rules ?? {}).join(',')).toContain('playwright/');
   });
 
+  it('should include playwright rules for page object file', async () => {
+    const config = await loadConfig('components/login.po.ts');
+    expect(Object.keys(config.rules ?? {}).join(',')).toContain('playwright/');
+  });
+
   it('should include playwright rules for test folder', async () => {
-    const config = await loadConfig('e2e/dashboard/subscription.ts');
+    const config = await loadConfig('website-e2e/dashboard/subscription.ts');
     expect(Object.keys(config.rules ?? {}).join(',')).toContain('playwright/');
   });
 
@@ -40,6 +45,13 @@ describe('playwright config', () => {
     expect(config.rules).toHaveProperty('playwright/prefer-native-locators');
   });
 
+  it('should include jest formatting rule', async () => {
+    const config = await loadConfig();
+    expect(Object.keys(config.rules ?? {}).join(',')).toContain(
+      'jest-formatting/',
+    );
+  });
+
   it('should have customized severity level for rule from extended config', async () => {
     const config = await loadConfig();
     expect(config.rules?.['playwright/no-conditional-expect']).toEqual([1]);