feat(prefer-presence-queries): add absence & presence options (#557)

* fix: support configuration for prefer-presence-queries (#518)

* test(prefer-presence-queries): destructure options in the params of create

Co-authored-by: Michaël De Boey <[email protected]>

Co-authored-by: Rory Jennings <[email protected]>
Co-authored-by: Michaël De Boey <[email protected]>

Author: 3 people

docs/rules/prefer-presence-queries.md

@@ -59,6 +59,27 @@ test('some test', async () => {
 });
 ```
 
+## Options
+
+| Option     | Required | Default | Details                                                                                                                                                      |
+| ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `presence` | No       | `true`  | If enabled, this rule will ensure `getBy*` is used to validate whether an element is present. If disabled, `queryBy*` will be accepted for presence queries. |
+| `absence`  | No       | `true`  | If enabled, this rule will ensure `queryBy*` is used to validate whether an element is absent. If disabled, `getBy*` will be accepted for absence queries.   |
+
+## Example
+
+```json
+{
+  "testing-library/prefer-presence-queries": [
+    2,
+    {
+      "presence": true,
+      "absence": false
+    }
+  ]
+}
+```
+
 ## Further Reading
 
 - [Testing Library queries cheatsheet](https://testing-library.com/docs/dom-testing-library/cheatsheet#queries)

lib/rules/prefer-presence-queries.ts

@@ -5,7 +5,12 @@ import { findClosestCallNode, isMemberExpression } from '../node-utils';
 
 export const RULE_NAME = 'prefer-presence-queries';
 export type MessageIds = 'wrongAbsenceQuery' | 'wrongPresenceQuery';
-type Options = [];
+export type Options = [
+  {
+    presence?: boolean;
+    absence?: boolean;
+  }
+];
 
 export default createTestingLibraryRule<Options, MessageIds>({
   name: RULE_NAME,
@@ -26,12 +31,30 @@ export default createTestingLibraryRule<Options, MessageIds>({
       wrongAbsenceQuery:
         'Use `queryBy*` queries rather than `getBy*` for checking element is NOT present',
     },
-    schema: [],
+    schema: [
+      {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          presence: {
+            type: 'boolean',
+          },
+          absence: {
+            type: 'boolean',
+          },
+        },
+      },
+    ],
     type: 'suggestion',
   },
-  defaultOptions: [],
+  defaultOptions: [
+    {
+      presence: true,
+      absence: true,
+    },
+  ],
 
-  create(context, _, helpers) {
+  create(context, [{ absence = true, presence = true }], helpers) {
     return {
       'CallExpression Identifier'(node: TSESTree.Identifier) {
         const expectCallNode = findClosestCallNode(node, 'expect');
@@ -55,9 +78,9 @@ export default createTestingLibraryRule<Options, MessageIds>({
           return;
         }
 
-        if (isPresenceAssert && !isPresenceQuery) {
+        if (presence && isPresenceAssert && !isPresenceQuery) {
           context.report({ node, messageId: 'wrongPresenceQuery' });
-        } else if (isAbsenceAssert && isPresenceQuery) {
+        } else if (absence && isAbsenceAssert && isPresenceQuery) {
           context.report({ node, messageId: 'wrongAbsenceQuery' });
         }
       },