chore: merge no-empty-title into valid-title

jest-community · Oct 27, 2019 · 60443d2 · 60443d2
1 parent 88a2921
commit 60443d2
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 1 deletion.
diff --git a/src/rules/__tests__/valid-title.test.ts b/src/rules/__tests__/valid-title.test.ts
@@ -7,11 +7,117 @@ const ruleTester = new TSESLint.RuleTester({
   },
 });
 
+ruleTester.run('no-empty-title', rule, {
+  valid: [
+    'describe()',
+    'someFn("", function () {})',
+    'describe(1, function () {})',
+    'describe("foo", function () {})',
+    'describe("foo", function () { it("bar", function () {}) })',
+    'test("foo", function () {})',
+    'test(`foo`, function () {})',
+    'test(`${foo}`, function () {})',
+    "it('foo', function () {})",
+    "xdescribe('foo', function () {})",
+    "xit('foo', function () {})",
+    "xtest('foo', function () {})",
+  ],
+  invalid: [
+    {
+      code: 'describe("", function () {})',
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'describe' },
+        },
+      ],
+    },
+    {
+      code: ["describe('foo', () => {", "it('', () => {})", '})'].join('\n'),
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 2,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+    {
+      code: 'it("", function () {})',
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+    {
+      code: 'test("", function () {})',
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+    {
+      code: 'test(``, function () {})',
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+    {
+      code: "xdescribe('', () => {})",
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'describe' },
+        },
+      ],
+    },
+    {
+      code: "xit('', () => {})",
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+    {
+      code: "xtest('', () => {})",
+      errors: [
+        {
+          messageId: 'emptyTitle',
+          column: 1,
+          line: 1,
+          data: { jestFunctionName: 'test' },
+        },
+      ],
+    },
+  ],
+});
+
 ruleTester.run('no-accidental-space', rule, {
   valid: [
     'it()',
     'describe()',
-    'it("")',
     'it.each()()',
     'describe("foo", function () {})',
     'describe(6, function () {})',

diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
@@ -3,6 +3,8 @@ import {
   TSESTree,
 } from '@typescript-eslint/experimental-utils';
 import {
+  DescribeAlias,
+  TestCaseName,
   createRule,
   getNodeName,
   getStringValue,
@@ -23,6 +25,7 @@ export default createRule({
       recommended: false,
     },
     messages: {
+      emptyTitle: '{{ jestFunctionName }} should not have an empty title',
       duplicatePrefix: 'should not have duplicate prefix',
       accidentalSpace: 'should not have leading or trailing spaces',
     },
@@ -47,6 +50,18 @@ export default createRule({
         const title = getStringValue(argument);
 
         if (!title) {
+          if (typeof title === 'string') {
+            context.report({
+              messageId: 'emptyTitle',
+              data: {
+                jestFunctionName: isDescribe(node)
+                  ? DescribeAlias.describe
+                  : TestCaseName.test,
+              },
+              node,
+            });
+          }
+
           return;
         }