Cherry pick from next 1 (#446)

* chore(valid-title): merge if conditions * chore(valid-title): order imports * chore(valid-title): add type annotation to `node` parameter * chore(valid-title): inline `getNodeTitle` function * chore(valid-title): adjust documentation * chore(utils): remove unneeded exporting of `isTemplateLiteral`
jest-community · Oct 27, 2019 · e9f0503 · e9f0503
1 parent f07a10f
commit e9f0503
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -150,7 +150,7 @@ installations requiring long-term consistency.
 | [valid-describe][]             | Enforce valid `describe()` callback                               | ![recommended][] |                     |
 | [valid-expect-in-promise][]    | Enforce having return statement when testing with promises        | ![recommended][] |                     |
 | [valid-expect][]               | Enforce valid `expect()` usage                                    | ![recommended][] |                     |
-| [valid-title][]                | Disallow invalid `describe`/`test` titles                         |                  |                     |
+| [valid-title][]                | Enforce valid titles for jest blocks                              |                  |                     |
 
 ## Credit
 

diff --git a/docs/rules/valid-title.md b/docs/rules/valid-title.md
@@ -1,6 +1,9 @@
 # describe/test titles should be valid (valid-title)
 
-A describe/ test block should not contain accidentalSpace or duplicatePrefix.
+Checks that the title of Jest blocks are valid by ensuring that titles are:
+
+- not prefixed with their block name,
+- have no leading or trailing spaces
 
 ## Rule Details
 

diff --git a/src/rules/utils.ts b/src/rules/utils.ts
@@ -100,7 +100,7 @@ interface TemplateLiteral<Value extends string = string>
  *
  * @template V
  */
-export const isTemplateLiteral = <V extends string>(
+const isTemplateLiteral = <V extends string>(
   node: TSESTree.Node,
   value?: V,
 ): node is TemplateLiteral<V> =>

diff --git a/src/rules/valid-title.ts b/src/rules/valid-title.ts
@@ -1,3 +1,4 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
 import {
   createRule,
   getNodeName,
@@ -7,17 +8,9 @@ import {
   isTestCase,
 } from './utils';
 
-import { TSESTree } from '@typescript-eslint/experimental-utils';
-
 const trimFXprefix = (word: string) =>
   ['f', 'x'].includes(word.charAt(0)) ? word.substr(1) : word;
 
-const getNodeTitle = (node: TSESTree.CallExpression): string | null => {
-  const [argument] = node.arguments;
-
-  return isStringNode(argument) ? getStringValue(argument) : null;
-};
-
 export default createRule({
   name: __filename,
   meta: {
@@ -36,13 +29,22 @@ export default createRule({
   defaultOptions: [],
   create(context) {
     return {
-      CallExpression(node) {
-        if (!isDescribe(node) && !isTestCase(node)) return;
+      CallExpression(node: TSESTree.CallExpression) {
+        if (!(isDescribe(node) || isTestCase(node)) || !node.arguments.length) {
+          return;
+        }
+
+        const [argument] = node.arguments;
 
-        if (!node.arguments.length) return;
+        if (!isStringNode(argument)) {
+          return;
+        }
 
-        const title = getNodeTitle(node);
-        if (!title) return;
+        const title = getStringValue(argument);
+
+        if (!title) {
+          return;
+        }
 
         if (title.trimLeft().length !== title.length) {
           context.report({