fixup: add more terminators, allow passing custom, add function name

Author: Anemy

configs/eslint-plugin-devtools/rules/no-expect-method-without-call.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const PROPERTY_TERMINATORS = [
+  // Default chai terminators.
   'ok',
   'true',
   'false',
@@ -9,6 +10,28 @@ const PROPERTY_TERMINATORS = [
   'exist',
   'empty',
   'arguments',
+  'NaN',
+  'extensible',
+  'sealed',
+  'frozen',
+  'finite',
+
+  // Terminators from chai-as-promised.
+  'fulfilled',
+  'rejected',
+
+  // Terminators from sinon-chai.
+  'called',
+  'calledOnce',
+  'calledTwice',
+  'calledThrice',
+  'calledWithNew',
+
+  // Terminators from chai-dom.
+  'displayed',
+  'visible',
+  'focus',
+  'checked',
 ];
 
 function followNodeChainToExpectCall(node) {
@@ -41,18 +64,21 @@ module.exports = {
       description:
         'Require invocation of expect method assertions (e.g., to.throw())',
     },
-    messages: {
-      methodNotInvoked:
-        'expect().to.[METHOD] must be invoked with parentheses, e.g., expect(() => someFn()).to.throw()',
-    },
   },
 
   create(context) {
+    const options = context.options[0] ?? {};
+    const additionalTerminators = options.properties ?? [];
+    const validTerminators = [
+      ...PROPERTY_TERMINATORS,
+      ...additionalTerminators,
+    ];
+
     return {
       MemberExpression(node) {
         if (
           node.type !== 'MemberExpression' ||
-          PROPERTY_TERMINATORS.includes(node.property.name) ||
+          validTerminators.includes(node.property.name) ||
           node.property.name === 'expect'
         ) {
           return null;
@@ -77,9 +103,15 @@ module.exports = {
           return null;
         }
 
+        const source = context.getSourceCode();
+        const calleeText = source.getText(node);
+        const expectText = source.getText(expectCall);
+        const assertionText = calleeText.substring(expectText.length + 1);
+
         context.report({
           node,
-          messageId: 'methodNotInvoked',
+          // message: `"${assertionText}" used as function`
+          message: `expect().${assertionText} must be invoked with parentheses, e.g., expect().${assertionText}()`,
         });
       },
     };

configs/eslint-plugin-devtools/rules/no-expect-method-without-call.test.js

@@ -82,14 +82,24 @@ it('should test something', () => {
       code: 'expect(promise).to.be.rejectedWith(Error)',
       parserOptions: { ecmaVersion: 2021 },
     },
+    {
+      options: [{ properties: ['throw'] }],
+      code: `
+      it("does not fail passed property", function() {
+        expect(result).to.throw;
+      });
+    `,
+    },
   ],
+
   invalid: [
     {
       code: 'expect(() => someFn()).to.throw',
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },
@@ -98,16 +108,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
-        },
-      ],
-    },
-    {
-      code: 'expect("pineapple").to.include',
-      parserOptions: { ecmaVersion: 2021 },
-      errors: [
-        {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.be.a must be invoked with parentheses, e.g., expect().to.be.a()',
         },
       ],
     },
@@ -116,7 +118,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.not.include must be invoked with parentheses, e.g., expect().to.not.include()',
         },
       ],
     },
@@ -125,7 +128,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },
@@ -134,7 +138,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.not.throw must be invoked with parentheses, e.g., expect().to.not.throw()',
         },
       ],
     },
@@ -143,7 +148,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.not.throws must be invoked with parentheses, e.g., expect().to.not.throws()',
         },
       ],
     },
@@ -152,7 +158,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.not.Throw must be invoked with parentheses, e.g., expect().to.not.Throw()',
         },
       ],
     },
@@ -161,7 +168,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().not.to.throw must be invoked with parentheses, e.g., expect().not.to.throw()',
         },
       ],
     },
@@ -170,7 +178,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },
@@ -182,7 +191,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },
@@ -191,7 +201,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },
@@ -200,7 +211,8 @@ it('should test something', () => {
       parserOptions: { ecmaVersion: 2021 },
       errors: [
         {
-          messageId: 'methodNotInvoked',
+          message:
+            'expect().to.throw must be invoked with parentheses, e.g., expect().to.throw()',
         },
       ],
     },