feat(valid-title): support ignoring leading and trailing whitespace (#…

…1433) * feat: add ignoreSpaces option to valid-title rule * chore: fix format
jest-community · Sep 15, 2023 · bc96473 · bc96473
1 parent bc4eae4
commit bc96473
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -125,7 +125,8 @@ describe('foo', () => {
 
 **accidentalSpace**
 
-A `describe` / `test` block should not contain accidentalSpace
+A `describe` / `test` block should not contain accidentalSpace, but can be
+turned off via the `ignoreSpaces` option:
 
 Examples of **incorrect** code for this rule
 
@@ -161,13 +162,20 @@ describe('foo', () => {
 
 ```ts
 interface Options {
+  ignoreSpaces?: boolean;
   ignoreTypeOfDescribeName?: boolean;
   disallowedWords?: string[];
   mustNotMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
   mustMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
 }
 ```
 
+#### `ignoreSpaces`
+
+Default: `false`
+
+When enabled, the leading and trailing spaces won't be checked.
+
 #### `ignoreTypeOfDescribeName`
 
 Default: `false`

diff --git a/src/rules/__tests__/valid-title.test.ts b/src/rules/__tests__/valid-title.test.ts
@@ -848,6 +848,10 @@ ruleTester.run('no-accidental-space', rule, {
         it('bar', () => {})
       })
     `,
+    {
+      code: 'it(`GIVEN... \n  `, () => {});',
+      options: [{ ignoreSpaces: true }],
+    },
   ],
   invalid: [
     {

diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
@@ -85,6 +85,7 @@ const MatcherAndMessageSchema: JSONSchema.JSONSchema7 = {
 type MatcherGroups = 'describe' | 'test' | 'it';
 
 interface Options {
+  ignoreSpaces?: boolean;
   ignoreTypeOfDescribeName?: boolean;
   disallowedWords?: string[];
   mustNotMatch?:
@@ -132,6 +133,10 @@ export default createRule<[Options], MessageIds>({
       {
         type: 'object',
         properties: {
+          ignoreSpaces: {
+            type: 'boolean',
+            default: false,
+          },
           ignoreTypeOfDescribeName: {
             type: 'boolean',
             default: false,
@@ -161,11 +166,18 @@ export default createRule<[Options], MessageIds>({
     ],
     fixable: 'code',
   },
-  defaultOptions: [{ ignoreTypeOfDescribeName: false, disallowedWords: [] }],
+  defaultOptions: [
+    {
+      ignoreSpaces: false,
+      ignoreTypeOfDescribeName: false,
+      disallowedWords: [],
+    },
+  ],
   create(
     context,
     [
       {
+        ignoreSpaces,
         ignoreTypeOfDescribeName,
         disallowedWords = [],
         mustNotMatch,
@@ -247,7 +259,7 @@ export default createRule<[Options], MessageIds>({
           }
         }
 
-        if (title.trim().length !== title.length) {
+        if (ignoreSpaces === false && title.trim().length !== title.length) {
           context.report({
             messageId: 'accidentalSpace',
             node: argument,