First approach and tests for no-await-sync-query

Author: Belco90

docs/rules/no-await-sync-query.md

@@ -1,6 +1,6 @@
 # Disallow unnecessary `await` for sync queries (no-await-sync-query)
 
-Please describe the origin of the rule here.
+TODO: Please describe the origin of the rule here.
 
 
 ## Rule Details
@@ -11,26 +11,26 @@ Examples of **incorrect** code for this rule:
 
 ```js
 
-// fill me in
+// TODO: fill me in
 
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
 
-// fill me in
+// TODO: fill me in
 
 ```
 
 ### Options
 
-If there are any options, describe them here. Otherwise, delete this section.
+TODO: If there are any options, describe them here. Otherwise, delete this section.
 
 ## When Not To Use It
 
-Give a short description of when it would be appropriate to turn off this rule.
+TODO: Give a short description of when it would be appropriate to turn off this rule.
 
 ## Further Reading
 
-If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.
+- [Testing Library queries cheatsheet](https://testing-library.com/docs/dom-testing-library/cheatsheet#queries)

lib/rules/await-async-query.js

@@ -6,6 +6,10 @@ const VALID_PARENTS = [
   'ReturnStatement',
 ];
 
+const ASYNC_QUERIES_REGEXP = /^find(All)?By(LabelText|PlaceholderText|Text|AltText|Title|DisplayValue|Role|TestId)$/;
+
+const getError = nodeName => `\`${nodeName}\` must have \`await\` operator`;
+
 module.exports = {
   meta: {
     type: 'problem',
@@ -22,9 +26,7 @@ module.exports = {
 
   create: function(context) {
     return {
-      'CallExpression Identifier[name=/^find(All)?By(LabelText|PlaceholderText|Text|AltText|Title|DisplayValue|Role|TestId)$/]'(
-        node
-      ) {
+      [`CallExpression Identifier[name=${ASYNC_QUERIES_REGEXP}]`](node) {
         let hasError = true;
         try {
           if (VALID_PARENTS.includes(node.parent.parent.type)) {
@@ -37,7 +39,7 @@ module.exports = {
         if (hasError) {
           context.report({
             node,
-            message: `\`${node.name}\` must have \`await\` operator`,
+            message: getError(node.name),
           });
         }
       },

lib/rules/no-await-sync-query.js

@@ -1,41 +1,32 @@
-/**
- * @fileoverview Disallow unnecessary `await` for sync queries
- * @author Mario
- */
 'use strict';
 
-// ------------------------------------------------------------------------------
-// Rule Definition
-// ------------------------------------------------------------------------------
+const SYNC_QUERIES_REGEXP = /^(get|query)(All)?By(LabelText|PlaceholderText|Text|AltText|Title|DisplayValue|Role|TestId)$/;
+
+const getError = nodeName => `\`${nodeName}\` does not need \`await\` operator`;
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Disallow unnecessary `await` for sync queries',
-      category: 'Fill me in',
-      recommended: false,
+      category: 'Best Practices',
+      recommended: true,
+      url: 'TODO',
     },
-    fixable: null, // or "code" or "whitespace"
-    schema: [
-      // fill in your schema
-    ],
+    fixable: null,
+    schema: [],
   },
 
   create: function(context) {
-    // variables should be defined here
-
-    // ----------------------------------------------------------------------
-    // Helpers
-    // ----------------------------------------------------------------------
-
-    // any helper functions should go here or else delete this section
-
-    // ----------------------------------------------------------------------
-    // Public
-    // ----------------------------------------------------------------------
-
     return {
-      // give me methods
+      [`AwaitExpression > CallExpression > Identifier[name=${SYNC_QUERIES_REGEXP}]`](
+        node
+      ) {
+        context.report({
+          node,
+          message: getError(node.name),
+        });
+      },
     };
   },
 };

tests/lib/rules/no-await-sync-query.js

@@ -1,7 +1,3 @@
-/**
- * @fileoverview Disallow unnecessary `await` for sync queries
- * @author Mario
- */
 'use strict';
 
 // ------------------------------------------------------------------------------
@@ -15,19 +11,26 @@ const RuleTester = require('eslint').RuleTester;
 // Tests
 // ------------------------------------------------------------------------------
 
-const ruleTester = new RuleTester();
+const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 2018 } });
 ruleTester.run('no-await-sync-query', rule, {
   valid: [
-    // give me some code that won't trigger a warning
+    {
+      code: `async () => {
+        getByText('foo')
+      }
+      `,
+    },
   ],
 
   invalid: [
     {
-      code: "await getByText('foo')",
+      code: `async () => {
+        await getByText('foo')
+      }
+      `,
       errors: [
         {
-          message: 'Fill me in.',
-          type: 'Me too',
+          message: '`getByText` does not need `await` operator',
         },
       ],
     },