fix: Use checked property of toBeChecked when it is not a boolean…

… literal Fixes #205
playwright-community · Feb 3, 2024 · 3563148 · 3563148
1 parent 3a8f674
commit 3563148
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 1 deletion.
diff --git a/src/rules/prefer-web-first-assertions.ts b/src/rules/prefer-web-first-assertions.ts
@@ -6,6 +6,7 @@ import { parseExpectCall } from '../utils/parseExpectCall';
 type MethodConfig = {
   inverse?: string;
   matcher: string;
+  prop?: string;
   type: 'boolean' | 'string';
 };
 
@@ -16,7 +17,11 @@ const methods: Record<string, MethodConfig> = {
   },
   innerText: { matcher: 'toHaveText', type: 'string' },
   inputValue: { matcher: 'toHaveValue', type: 'string' },
-  isChecked: { matcher: 'toBeChecked', type: 'boolean' },
+  isChecked: {
+    matcher: 'toBeChecked',
+    prop: 'checked',
+    type: 'boolean',
+  },
   isDisabled: {
     inverse: 'toBeEnabled',
     matcher: 'toBeDisabled',
@@ -149,6 +154,15 @@ export default {
               fixes.push(fixer.remove(matcherArg));
             }
 
+            // Add the prop argument if needed
+            else if (methodConfig.prop && matcherArg) {
+              const propArg = methodConfig.prop;
+              const variable = getStringValue(matcherArg);
+              const args = `{ ${propArg}: ${variable} }`;
+
+              fixes.push(fixer.replaceText(matcherArg, args));
+            }
+
             // Add the new matcher arguments if needed
             const hasOtherArgs = !!methodArgs.filter(
               (arg) => !isBooleanLiteral(arg),

diff --git a/test/spec/prefer-web-first-assertions.spec.ts b/test/spec/prefer-web-first-assertions.spec.ts
@@ -315,6 +315,21 @@ runRuleTester('prefer-web-first-assertions', rule, {
       ],
       output: test('await expect(page.locator("howdy")).toBeChecked()'),
     },
+    {
+      code: test('expect(await page.locator("howdy").isChecked()).toBe(foo)'),
+      errors: [
+        {
+          column: 28,
+          data: { matcher: 'toBeChecked', method: 'isChecked' },
+          endColumn: 75,
+          line: 1,
+          messageId: 'useWebFirstAssertion',
+        },
+      ],
+      output: test(
+        'await expect(page.locator("howdy")).toBeChecked({ checked: foo })',
+      ),
+    },
     {
       code: test(
         'expect(await page.locator("howdy").isChecked()).toBeTruthy()',
@@ -345,6 +360,23 @@ runRuleTester('prefer-web-first-assertions', rule, {
       ],
       output: test('await expect(page.locator("howdy")).not.toBeChecked()'),
     },
+    {
+      code: test(
+        'expect(await page.locator("howdy").isChecked()).not.toBe(bar)',
+      ),
+      errors: [
+        {
+          column: 28,
+          data: { matcher: 'toBeChecked', method: 'isChecked' },
+          endColumn: 75,
+          line: 1,
+          messageId: 'useWebFirstAssertion',
+        },
+      ],
+      output: test(
+        'await expect(page.locator("howdy")).not.toBeChecked({ checked: bar })',
+      ),
+    },
     {
       code: test('expect(await page.locator("howdy").isChecked()).toBe(false)'),
       errors: [