Added eslint-plugin-playwright to ensue tag convention (carbon-desi…

…gn-system#15692)

* feat: added playwright checker

* fix: fixed ci

* fix: fixed RegExp

* fix: fixed name for the error in describe

* fix: yarn dedupe --strategy highest

* fix: fixed describe title

config/eslint-config-carbon/internal.js

@@ -14,5 +14,6 @@ module.exports = {
     require.resolve('./plugins/react'),
     require.resolve('./plugins/storybook'),
     require.resolve('./plugins/testing-library'),
+    require.resolve('./plugins/eslint-plugin-playwright'),
   ],
 };

config/eslint-config-carbon/plugins/eslint-plugin-playwright.js

@@ -0,0 +1,34 @@
+const prefixes = [
+  '@avt-default-state',
+  '@avt-advanced-states',
+  '@avt-keyboard-nav',
+];
+const prefixesList = prefixes.join('  | \n');
+
+module.exports = {
+  plugins: ['eslint-plugin-playwright'],
+  overrides: [
+    {
+      extends: ['plugin:playwright/recommended'],
+      files: ['*-test.avt.e2e.js'],
+      rules: {
+        'playwright/valid-title': [
+          'error',
+          {
+            mustMatch: {
+              describe: [
+                /^(\s*@avt(\s+\S+)*\s*)$/.source,
+                `Describe titles should start with "@avt" prefix`,
+              ],
+              test: [
+                /^(\s*(@avt-default-state||@avt-advanced-states||@avt-keyboard-nav)(\s+\S+)*\s*)$/
+                  .source,
+                `Test titles should start with one of the following prefixes: ${prefixesList}`,
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+};

e2e/components/Accordion/Accordion-test.avt.e2e.js

@@ -10,7 +10,7 @@
 import { expect, test } from '@playwright/test';
 import { visitStory } from '../../test-utils/storybook';
 
-test.describe('Accordion @avt', () => {
+test.describe('@avt Accordion', () => {
   test('@avt-default-state', async ({ page }) => {
     await visitStory(page, {
       component: 'Accordion',

package.json

@@ -62,6 +62,7 @@
     "cross-spawn": "^7.0.0",
     "doctoc": "^2.0.0",
     "eslint": "^8.40.0",
+    "eslint-plugin-playwright": "^0.22.1",
     "fs-extra": "^11.0.0",
     "glob": "^10.0.0",
     "husky": "^8.0.0",

yarn.lock

@@ -9937,6 +9937,7 @@ __metadata:
     cross-spawn: "npm:^7.0.0"
     doctoc: "npm:^2.0.0"
     eslint: "npm:^8.40.0"
+    eslint-plugin-playwright: "npm:^0.22.1"
     fs-extra: "npm:^11.0.0"
     glob: "npm:^10.0.0"
     husky: "npm:^8.0.0"
@@ -13354,6 +13355,21 @@ __metadata:
   languageName: node
   linkType: hard
 
+"eslint-plugin-playwright@npm:^0.22.1":
+  version: 0.22.1
+  resolution: "eslint-plugin-playwright@npm:0.22.1"
+  dependencies:
+    globals: "npm:^13.23.0"
+  peerDependencies:
+    eslint: ">=7"
+    eslint-plugin-jest: ">=25"
+  peerDependenciesMeta:
+    eslint-plugin-jest:
+      optional: true
+  checksum: 4833fe0c7b8bb1da9ecdff085011fbfb46b595b284453049c16be3f22fe329b05453f8ad57bcc001cda7495f96573a3f7df77d4e34b7d8a0f96d46f884ad460c
+  languageName: node
+  linkType: hard
+
 "eslint-plugin-prettier@npm:^5.0.0":
   version: 5.0.0
   resolution: "eslint-plugin-prettier@npm:5.0.0"
@@ -15068,12 +15084,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"globals@npm:^13.19.0":
-  version: 13.20.0
-  resolution: "globals@npm:13.20.0"
+"globals@npm:^13.19.0, globals@npm:^13.23.0":
+  version: 13.24.0
+  resolution: "globals@npm:13.24.0"
   dependencies:
     type-fest: "npm:^0.20.2"
-  checksum: 9df85cde2f0dce6ac9b3a5e08bec109d2f3b38ddd055a83867e0672c55704866d53ce6a4265859fa630624baadd46f50ca38602a13607ad86be853a8c179d3e7
+  checksum: 62c5b1997d06674fc7191d3e01e324d3eda4d65ac9cc4e78329fa3b5c4fd42a0e1c8722822497a6964eee075255ce21ccf1eec2d83f92ef3f06653af4d0ee28e
   languageName: node
   linkType: hard