eslint-plugin-playwright 1.3.0 → 1.3.1

package/dist/index.js

@@ -35,7 +35,7 @@ function getRawValue(node) {
   return node.type === "Literal" ? node.raw : void 0;
 }
 function isIdentifier(node, name) {
-  return node.type === "Identifier" && (typeof name === "string" ? node.name === name : name.test(node.name));
+  return node.type === "Identifier" && (!name || (typeof name === "string" ? node.name === name : name.test(node.name)));
 }
 function isLiteral(node, type, value) {
   return node.type === "Literal" && (value === void 0 ? typeof node.value === type : node.value === value);
@@ -48,8 +48,8 @@ function isStringLiteral(node, value) {
 function isBooleanLiteral(node, value) {
   return isLiteral(node, "boolean", value);
 }
-function isStringNode(node) {
-  return node && (isStringLiteral(node) || isTemplateLiteral(node));
+function isStringNode(node, value) {
+  return node && (isStringLiteral(node, value) || isTemplateLiteral(node, value));
 }
 function isPropertyAccessor(node, name) {
   return getStringValue(node.property) === name;
@@ -91,32 +91,15 @@ function findParent(node, type) {
 function isTestCall(context, node, modifiers) {
   return isTestIdentifier(context, node.callee) && !isDescribeCall(node) && (node.callee.type !== "MemberExpression" || !modifiers || modifiers?.includes(getStringValue(node.callee.property))) && node.arguments.length === 2 && isFunction(node.arguments[1]);
 }
-var testHooks = /* @__PURE__ */ new Set(["afterAll", "afterEach", "beforeAll", "beforeEach"]);
+var testHooks = /* @__PURE__ */ new Set([
+  "afterAll",
+  "afterEach",
+  "beforeAll",
+  "beforeEach"
+]);
 function isTestHook(context, node) {
   return node.callee.type === "MemberExpression" && isTestIdentifier(context, node.callee.object) && testHooks.has(getStringValue(node.callee.property));
 }
-function parseFnCall(context, node) {
-  if (isTestCall(context, node)) {
-    return {
-      fn: node.arguments[1],
-      name: getStringValue(node.callee),
-      type: "test"
-    };
-  }
-  if (node.callee.type === "MemberExpression" && isTestIdentifier(context, node.callee.object) && testHooks.has(getStringValue(node.callee.property))) {
-    return {
-      fn: node.arguments[0],
-      name: getStringValue(node.callee.property),
-      type: "hook"
-    };
-  }
-  if (isDescribeCall(node)) {
-    return {
-      name: getStringValue(node.callee),
-      type: "describe"
-    };
-  }
-}
 var expectSubCommands = /* @__PURE__ */ new Set(["soft", "poll"]);
 function getExpectType(context, node) {
   const aliases = context.settings.playwright?.globalAliases?.expect ?? [];
@@ -888,6 +871,132 @@ var no_get_by_title_default = {
   }
 };
 
+// src/utils/parseFnCall.ts
+var VALID_CHAINS = /* @__PURE__ */ new Set([
+  // Hooks
+  "afterAll",
+  "afterEach",
+  "beforeAll",
+  "beforeEach",
+  "test.afterAll",
+  "test.afterEach",
+  "test.beforeAll",
+  "test.beforeEach",
+  // Describe
+  "describe",
+  "describe.only",
+  "describe.skip",
+  "describe.fixme",
+  "describe.configure",
+  "test.describe",
+  "test.describe.only",
+  "test.describe.skip",
+  "test.describe.fixme",
+  "test.describe.configure",
+  // Test
+  "test",
+  "test.fail",
+  "text.fixme",
+  "test.only",
+  "test.skip",
+  "test.slow",
+  "test.step",
+  "test.use"
+]);
+var joinChains = (a, b) => a && b ? [...a, ...b] : null;
+var isSupportedAccessor = (node, value) => isIdentifier(node, value) || isStringNode(node, value);
+function getNodeChain(node) {
+  if (isSupportedAccessor(node)) {
+    return [node];
+  }
+  switch (node.type) {
+    case "TaggedTemplateExpression":
+      return getNodeChain(node.tag);
+    case "MemberExpression":
+      return joinChains(getNodeChain(node.object), getNodeChain(node.property));
+    case "CallExpression":
+      return getNodeChain(node.callee);
+  }
+  return null;
+}
+var resolvePossibleAliasedGlobal = (context, global) => {
+  const globalAliases = context.settings.playwright?.globalAliases ?? {};
+  const alias = Object.entries(globalAliases).find(
+    ([, aliases]) => aliases.includes(global)
+  );
+  return alias?.[0] ?? null;
+};
+var resolveToPlaywrightFn = (context, accessor) => {
+  const ident = getStringValue(accessor);
+  return {
+    local: ident,
+    original: resolvePossibleAliasedGlobal(context, ident),
+    type: "global"
+  };
+};
+function determinePlaywrightFnType(name) {
+  if (name === "expect")
+    return "expect";
+  if (name === "describe")
+    return "describe";
+  if (name === "test")
+    return "test";
+  if (testHooks.has(name))
+    return "hook";
+  return "unknown";
+}
+function parseFnCall(context, node) {
+  const chain = getNodeChain(node);
+  if (!chain?.length) {
+    return null;
+  }
+  const [first, ...rest] = chain;
+  const resolved = resolveToPlaywrightFn(context, first);
+  if (!resolved)
+    return null;
+  let name = resolved.original ?? resolved.local;
+  const links = [name, ...rest.map((link) => getStringValue(link))];
+  if (name !== "expect" && !VALID_CHAINS.has(links.join("."))) {
+    return null;
+  }
+  if (name === "test" && links.length > 1) {
+    const nextLinkName = links[1];
+    const nextLinkType = determinePlaywrightFnType(nextLinkName);
+    if (nextLinkType !== "unknown") {
+      name = nextLinkName;
+    }
+  }
+  const parsedFnCall = {
+    head: { ...resolved, node: first },
+    // every member node must have a member expression as their parent
+    // in order to be part of the call chain we're parsing
+    members: rest,
+    name
+  };
+  const type = determinePlaywrightFnType(name);
+  if (type === "expect") {
+    return {
+      ...parsedFnCall,
+      args: [],
+      matcher: rest[rest.length - 1],
+      modifiers: rest.slice(0, rest.length - 1),
+      type
+    };
+  }
+  if (chain.slice(0, chain.length - 1).some((n) => getParent(n)?.type !== "MemberExpression")) {
+    return null;
+  }
+  const parent = getParent(node);
+  if (parent?.type === "CallExpression" || parent?.type === "MemberExpression") {
+    return null;
+  }
+  return { ...parsedFnCall, type };
+}
+var isTypeOfFnCall = (context, node, types) => {
+  const call = parseFnCall(context, node);
+  return call !== null && types.includes(call.type);
+};
+
 // src/rules/no-hooks.ts
 var no_hooks_default = {
   create(context) {
@@ -1363,6 +1472,9 @@ var no_standalone_expect_default = {
         if (isTestCall(context, node)) {
           callStack.push("test");
         }
+        if (isTestHook(context, node)) {
+          callStack.push("hook");
+        }
         if (node.callee.type === "TaggedTemplateExpression") {
           callStack.push("template");
         }
@@ -2556,7 +2668,7 @@ var require_hook_default = {
     };
     return {
       CallExpression(node) {
-        if (!isDescribeCall(node) || node.arguments.length < 2) {
+        if (!isTypeOfFnCall(context, node, ["describe"]) || node.arguments.length < 2) {
           return;
         }
         const [, testFn] = node.arguments;

package/dist/index.mjs

@@ -16,7 +16,7 @@ function getRawValue(node) {
   return node.type === "Literal" ? node.raw : void 0;
 }
 function isIdentifier(node, name) {
-  return node.type === "Identifier" && (typeof name === "string" ? node.name === name : name.test(node.name));
+  return node.type === "Identifier" && (!name || (typeof name === "string" ? node.name === name : name.test(node.name)));
 }
 function isLiteral(node, type, value) {
   return node.type === "Literal" && (value === void 0 ? typeof node.value === type : node.value === value);
@@ -27,8 +27,8 @@ function isStringLiteral(node, value) {
 function isBooleanLiteral(node, value) {
   return isLiteral(node, "boolean", value);
 }
-function isStringNode(node) {
-  return node && (isStringLiteral(node) || isTemplateLiteral(node));
+function isStringNode(node, value) {
+  return node && (isStringLiteral(node, value) || isTemplateLiteral(node, value));
 }
 function isPropertyAccessor(node, name) {
   return getStringValue(node.property) === name;
@@ -66,28 +66,6 @@ function isTestCall(context, node, modifiers) {
 function isTestHook(context, node) {
   return node.callee.type === "MemberExpression" && isTestIdentifier(context, node.callee.object) && testHooks.has(getStringValue(node.callee.property));
 }
-function parseFnCall(context, node) {
-  if (isTestCall(context, node)) {
-    return {
-      fn: node.arguments[1],
-      name: getStringValue(node.callee),
-      type: "test"
-    };
-  }
-  if (node.callee.type === "MemberExpression" && isTestIdentifier(context, node.callee.object) && testHooks.has(getStringValue(node.callee.property))) {
-    return {
-      fn: node.arguments[0],
-      name: getStringValue(node.callee.property),
-      type: "hook"
-    };
-  }
-  if (isDescribeCall(node)) {
-    return {
-      name: getStringValue(node.callee),
-      type: "describe"
-    };
-  }
-}
 function getExpectType(context, node) {
   const aliases = context.settings.playwright?.globalAliases?.expect ?? [];
   const expectNames = ["expect", ...aliases];
@@ -135,7 +113,12 @@ var init_ast = __esm({
       "skip",
       "fixme"
     ]);
-    testHooks = /* @__PURE__ */ new Set(["afterAll", "afterEach", "beforeAll", "beforeEach"]);
+    testHooks = /* @__PURE__ */ new Set([
+      "afterAll",
+      "afterEach",
+      "beforeAll",
+      "beforeEach"
+    ]);
     expectSubCommands = /* @__PURE__ */ new Set(["soft", "poll"]);
     equalityMatchers = /* @__PURE__ */ new Set(["toBe", "toEqual", "toStrictEqual"]);
   }
@@ -966,12 +949,145 @@ var init_no_get_by_title = __esm({
   }
 });
 
+// src/utils/parseFnCall.ts
+function getNodeChain(node) {
+  if (isSupportedAccessor(node)) {
+    return [node];
+  }
+  switch (node.type) {
+    case "TaggedTemplateExpression":
+      return getNodeChain(node.tag);
+    case "MemberExpression":
+      return joinChains(getNodeChain(node.object), getNodeChain(node.property));
+    case "CallExpression":
+      return getNodeChain(node.callee);
+  }
+  return null;
+}
+function determinePlaywrightFnType(name) {
+  if (name === "expect")
+    return "expect";
+  if (name === "describe")
+    return "describe";
+  if (name === "test")
+    return "test";
+  if (testHooks.has(name))
+    return "hook";
+  return "unknown";
+}
+function parseFnCall(context, node) {
+  const chain = getNodeChain(node);
+  if (!chain?.length) {
+    return null;
+  }
+  const [first, ...rest] = chain;
+  const resolved = resolveToPlaywrightFn(context, first);
+  if (!resolved)
+    return null;
+  let name = resolved.original ?? resolved.local;
+  const links = [name, ...rest.map((link) => getStringValue(link))];
+  if (name !== "expect" && !VALID_CHAINS.has(links.join("."))) {
+    return null;
+  }
+  if (name === "test" && links.length > 1) {
+    const nextLinkName = links[1];
+    const nextLinkType = determinePlaywrightFnType(nextLinkName);
+    if (nextLinkType !== "unknown") {
+      name = nextLinkName;
+    }
+  }
+  const parsedFnCall = {
+    head: { ...resolved, node: first },
+    // every member node must have a member expression as their parent
+    // in order to be part of the call chain we're parsing
+    members: rest,
+    name
+  };
+  const type = determinePlaywrightFnType(name);
+  if (type === "expect") {
+    return {
+      ...parsedFnCall,
+      args: [],
+      matcher: rest[rest.length - 1],
+      modifiers: rest.slice(0, rest.length - 1),
+      type
+    };
+  }
+  if (chain.slice(0, chain.length - 1).some((n) => getParent(n)?.type !== "MemberExpression")) {
+    return null;
+  }
+  const parent = getParent(node);
+  if (parent?.type === "CallExpression" || parent?.type === "MemberExpression") {
+    return null;
+  }
+  return { ...parsedFnCall, type };
+}
+var VALID_CHAINS, joinChains, isSupportedAccessor, resolvePossibleAliasedGlobal, resolveToPlaywrightFn, isTypeOfFnCall;
+var init_parseFnCall = __esm({
+  "src/utils/parseFnCall.ts"() {
+    "use strict";
+    init_ast();
+    VALID_CHAINS = /* @__PURE__ */ new Set([
+      // Hooks
+      "afterAll",
+      "afterEach",
+      "beforeAll",
+      "beforeEach",
+      "test.afterAll",
+      "test.afterEach",
+      "test.beforeAll",
+      "test.beforeEach",
+      // Describe
+      "describe",
+      "describe.only",
+      "describe.skip",
+      "describe.fixme",
+      "describe.configure",
+      "test.describe",
+      "test.describe.only",
+      "test.describe.skip",
+      "test.describe.fixme",
+      "test.describe.configure",
+      // Test
+      "test",
+      "test.fail",
+      "text.fixme",
+      "test.only",
+      "test.skip",
+      "test.slow",
+      "test.step",
+      "test.use"
+    ]);
+    joinChains = (a, b) => a && b ? [...a, ...b] : null;
+    isSupportedAccessor = (node, value) => isIdentifier(node, value) || isStringNode(node, value);
+    resolvePossibleAliasedGlobal = (context, global) => {
+      const globalAliases = context.settings.playwright?.globalAliases ?? {};
+      const alias = Object.entries(globalAliases).find(
+        ([, aliases]) => aliases.includes(global)
+      );
+      return alias?.[0] ?? null;
+    };
+    resolveToPlaywrightFn = (context, accessor) => {
+      const ident = getStringValue(accessor);
+      return {
+        local: ident,
+        original: resolvePossibleAliasedGlobal(context, ident),
+        type: "global"
+      };
+    };
+    isTypeOfFnCall = (context, node, types) => {
+      const call = parseFnCall(context, node);
+      return call !== null && types.includes(call.type);
+    };
+  }
+});
+
 // src/rules/no-hooks.ts
 var no_hooks_default;
 var init_no_hooks = __esm({
   "src/rules/no-hooks.ts"() {
     "use strict";
-    init_ast();
+    init_parseFnCall();
     no_hooks_default = {
       create(context) {
         const options = {
@@ -1510,6 +1626,9 @@ var init_no_standalone_expect = __esm({
             if (isTestCall(context, node)) {
               callStack.push("test");
             }
+            if (isTestHook(context, node)) {
+              callStack.push("hook");
+            }
             if (node.callee.type === "TaggedTemplateExpression") {
               callStack.push("template");
             }
@@ -2809,6 +2928,7 @@ var init_require_hook = __esm({
   "src/rules/require-hook.ts"() {
     "use strict";
     init_ast();
+    init_parseFnCall();
     isNullOrUndefined = (node) => {
       return node.type === "Literal" && node.value === null || isIdentifier(node, "undefined");
     };
@@ -2848,7 +2968,7 @@ var init_require_hook = __esm({
         };
         return {
           CallExpression(node) {
-            if (!isDescribeCall(node) || node.arguments.length < 2) {
+            if (!isTypeOfFnCall(context, node, ["describe"]) || node.arguments.length < 2) {
               return;
             }
             const [, testFn] = node.arguments;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-playwright",
   "description": "ESLint plugin for Playwright testing.",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "repository": "https://github.com/playwright-community/eslint-plugin-playwright",
   "author": "Mark Skelton <mark@mskelton.dev>",
   "packageManager": "pnpm@8.12.0",
@@ -34,12 +34,11 @@
     "lint": "eslint .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "test": "jest",
-    "test:watch": "jest --watch --no-verbose",
+    "test": "vitest",
+    "test:watch": "vitest --reporter=dot",
     "ts": "tsc --noEmit"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@mskelton/eslint-config": "^8.4.0",
     "@mskelton/semantic-release-config": "^1.0.1",
     "@types/eslint": "^8.44.3",
@@ -50,13 +49,12 @@
     "dedent": "^1.5.1",
     "eslint": "^8.50.0",
     "eslint-plugin-sort": "^2.10.0",
-    "jest": "^29.7.0",
     "prettier": "^3.0.3",
     "prettier-plugin-jsdoc": "^1.3.0",
     "semantic-release": "^23.0.2",
-    "ts-jest": "^29.1.1",
     "tsup": "^8.0.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "vitest": "^1.3.1"
   },
   "peerDependencies": {
     "eslint": ">=8.40.0",