Support flat config (#169)

* feat: Support flat config

* chore: Update examples to flat config

* chore: Update docs

* chore: Fix docs

Author: mskelton

README.md

@@ -33,6 +33,26 @@ This plugin bundles two configurations to work with both `@playwright/test` or
 
 ### With [Playwright test runner](https://playwright.dev/docs/writing-tests)
 
+[Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
+(**eslint.config.js**)
+
+```javascript
+import playwright from 'eslint-plugin-playwright';
+
+export default [
+  playwright.configs['flat/recommended'],
+  {
+    rules: {
+      // Customize Playwright rules
+      // ...
+    },
+  },
+];
+```
+
+[Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)
+(**.eslintrc**)
+
 ```json
 {
   "extends": ["plugin:playwright/recommended"]
@@ -41,6 +61,30 @@ This plugin bundles two configurations to work with both `@playwright/test` or
 
 ### With [Jest Playwright](https://github.com/playwright-community/jest-playwright)
 
+[Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
+(**eslint.config.js**)
+
+```javascript
+import playwright from 'eslint-plugin-playwright';
+import jest from 'eslint-plugin-jest';
+
+export default [
+  playwright.configs['flat/jest-playwright'],
+  {
+    plugins: {
+      jest,
+    },
+    rules: {
+      // Customize Playwright rules
+      // ...
+    },
+  },
+];
+```
+
+[Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)
+(**.eslintrc**)
+
 ```json
 {
   "extends": ["plugin:playwright/jest-playwright"]
@@ -63,6 +107,24 @@ under the `playwright` key. It supports the following settings:
 
 You can configure these settings like so:
 
+[Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
+(**eslint.config.js**)
+
+```javascript
+export default [
+  {
+    settings: {
+      playwright: {
+        additionalAssertFunctionNames: ['assertCustomCondition'],
+      },
+    },
+  },
+];
+```
+
+[Legacy config](https://eslint.org/docs/latest/use/configure/configuration-files)
+(**.eslintrc**)
+
 ```json
 {
   "settings": {

examples/.eslintrc

@@ -0,0 +1,25 @@
+import playwright from 'eslint-plugin-playwright';
+
+export default [
+  playwright.configs['flat/recommended'],
+  {
+    languageOptions: {
+      sourceType: 'module',
+      ecmaVersion: 2022,
+    },
+    rules: {
+      'playwright/prefer-lowercase-title': 'warn',
+      'playwright/prefer-to-be': 'warn',
+      'playwright/prefer-to-have-length': 'warn',
+      'playwright/prefer-strict-equal': 'warn',
+      'playwright/max-nested-describe': ['warn', { max: 1 }],
+      'playwright/no-restricted-matchers': [
+        'error',
+        {
+          toBeFalsy: 'Use `toBe(false)` instead.',
+          not: null,
+        },
+      ],
+    },
+  },
+];

examples/eslint.config.js

@@ -6,7 +6,7 @@
   },
   "dependencies": {
     "@playwright/test": "^1.38.1",
-    "eslint": "^8.50.0",
-    "eslint-plugin-playwright": "workspace:*"
+    "eslint": "^8.51.0",
+    "eslint-plugin-playwright": "file:../"
   }
 }

examples/package.json

@@ -45,5 +45,8 @@
     "eslint-plugin-jest": {
       "optional": true
     }
+  },
+  "dependencies": {
+    "globals": "^13.23.0"
   }
 }