feat(valid-title): allow ignoring tests with non-string titles (#1460)

* feat(valid-title): allow disabling titleMustBeString on test titles Signed-off-by: Sebastian Malton <sebastian@malton.name> * docs(valid-title): update wording --------- Signed-off-by: Sebastian Malton <sebastian@malton.name> Co-authored-by: Gareth Jones <Jones258@Gmail.com>
jest-community · Oct 26, 2023 · ea89da9 · ea89da9
1 parent f2af519
commit ea89da9
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 6 deletions.
diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -51,10 +51,9 @@ xtest('foo', () => {});
 
 **titleMustBeString**
 
-Titles for test blocks should always be a string.
-
-This is also applied to `describe` blocks by default, but can be turned off via
-the `ignoreTypeOfDescribeName` option:
+Titles for `describe`, `test`, and `it` blocks should always be a string; you
+can disable this with the `ignoreTypeOfDescribeName` and `ignoreTypeOfTestName`
+options.
 
 Examples of **incorrect** code for this rule:
 
@@ -93,6 +92,18 @@ xdescribe(myFunction, () => {});
 describe(6, function () {});
 ```
 
+Examples of **correct** code when `ignoreTypeOfTestName` is `true`:
+
+```js
+const myTestName = 'is a string';
+
+it(String(/.+/), () => {});
+it(myFunction, () => {});
+it(myTestName, () => {});
+xit(myFunction, () => {});
+it(6, function () {});
+```
+
 **duplicatePrefix**
 
 A `describe` / `test` block should not start with `duplicatePrefix`

diff --git a/src/rules/__tests__/valid-title.test.ts b/src/rules/__tests__/valid-title.test.ts
@@ -521,6 +521,14 @@ ruleTester.run('title-must-be-string', rule, {
       code: 'describe(String(/.+/), () => {});',
       options: [{ ignoreTypeOfDescribeName: true }],
     },
+    {
+      code: 'it(String(/.+/), () => {});',
+      options: [{ ignoreTypeOfTestName: true }],
+    },
+    {
+      code: 'const foo = "my-title"; it(foo, () => {});',
+      options: [{ ignoreTypeOfTestName: true }],
+    },
     {
       code: 'describe(myFunction, () => {});',
       options: [{ ignoreTypeOfDescribeName: true }],
@@ -541,6 +549,28 @@ ruleTester.run('title-must-be-string', rule, {
         },
       ],
     },
+    {
+      code: 'it(String(/.+/), () => {});',
+      options: [{ ignoreTypeOfTestName: false }],
+      errors: [
+        {
+          messageId: 'titleMustBeString',
+          column: 4,
+          line: 1,
+        },
+      ],
+    },
+    {
+      code: 'const foo = "my-title"; it(foo, () => {});',
+      options: [{ ignoreTypeOfTestName: false }],
+      errors: [
+        {
+          messageId: 'titleMustBeString',
+          column: 28,
+          line: 1,
+        },
+      ],
+    },
     {
       code: 'it.skip.each([])(1, () => {});',
       errors: [

diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
@@ -87,6 +87,7 @@ type MatcherGroups = 'describe' | 'test' | 'it';
 interface Options {
   ignoreSpaces?: boolean;
   ignoreTypeOfDescribeName?: boolean;
+  ignoreTypeOfTestName?: boolean;
   disallowedWords?: string[];
   mustNotMatch?:
     | Partial<Record<MatcherGroups, string | MatcherAndMessage>>
@@ -141,6 +142,10 @@ export default createRule<[Options], MessageIds>({
             type: 'boolean',
             default: false,
           },
+          ignoreTypeOfTestName: {
+            type: 'boolean',
+            default: false,
+          },
           disallowedWords: {
             type: 'array',
             items: { type: 'string' },
@@ -170,6 +175,7 @@ export default createRule<[Options], MessageIds>({
     {
       ignoreSpaces: false,
       ignoreTypeOfDescribeName: false,
+      ignoreTypeOfTestName: false,
       disallowedWords: [],
     },
   ],
@@ -179,6 +185,7 @@ export default createRule<[Options], MessageIds>({
       {
         ignoreSpaces,
         ignoreTypeOfDescribeName,
+        ignoreTypeOfTestName,
         disallowedWords = [],
         mustNotMatch,
         mustMatch,
@@ -216,8 +223,11 @@ export default createRule<[Options], MessageIds>({
           }
 
           if (
-            argument.type !== AST_NODE_TYPES.TemplateLiteral &&
-            !(ignoreTypeOfDescribeName && jestFnCall.type === 'describe')
+            !(
+              (jestFnCall.type === 'describe' && ignoreTypeOfDescribeName) ||
+              (jestFnCall.type === 'test' && ignoreTypeOfTestName)
+            ) &&
+            argument.type !== AST_NODE_TYPES.TemplateLiteral
           ) {
             context.report({
               messageId: 'titleMustBeString',