Show suggestion only when unrecognized cli param length is greater th…

…an 1
jestjs · Oct 7, 2020 · fac872b · fac872b
1 parent 5da90b5
commit fac872b
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ### Fixes
 
+- `[jest-validate]` Show suggestion only when unrecognized cli param length is greater than 1 ([#10604](https://github.com/facebook/jest/pull/10604))
+
 ### Chore & Maintenance
 
 ### Performance

diff --git a/packages/jest-validate/src/__tests__/__snapshots__/validateCLIOptions.test.js.snap b/packages/jest-validate/src/__tests__/__snapshots__/validateCLIOptions.test.js.snap
@@ -1,5 +1,15 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`does not show suggestion when unrecognized cli param length <= 1 1`] = `
+"<red><bold><bold>●</><bold> Unrecognized CLI Parameter</>:</>
+<red></>
+<red>  Unrecognized option <bold>\\"l\\"</>.</>
+<red></>
+<red>  <bold>CLI Options Documentation</>:</>
+<red>  https://jestjs.io/docs/en/cli.html</>
+<red></>"
+`;
+
 exports[`fails for multiple unknown options 1`] = `
 "<red><bold><bold>●</><bold> Unrecognized CLI Parameters</>:</>
 <red></>
@@ -20,3 +30,13 @@ exports[`fails for unknown option 1`] = `
 <red>  https://jestjs.io/docs/en/cli.html</>
 <red></>"
 `;
+
+exports[`shows suggestion when unrecognized cli param length > 1 1`] = `
+"<red><bold><bold>●</><bold> Unrecognized CLI Parameter</>:</>
+<red></>
+<red>  Unrecognized option <bold>\\"hell\\"</>. Did you mean <bold>\\"help\\"</>?</>
+<red></>
+<red>  <bold>CLI Options Documentation</>:</>
+<red>  https://jestjs.io/docs/en/cli.html</>
+<red></>"
+`;
diff --git a/packages/jest-validate/src/__tests__/validateCLIOptions.test.js b/packages/jest-validate/src/__tests__/validateCLIOptions.test.js
@@ -41,3 +41,25 @@ test('fails for multiple unknown options', () => {
     validateCLIOptions(argv, options),
   ).toThrowErrorMatchingSnapshot();
 });
+
+test('does not show suggestion when unrecognized cli param length <= 1', () => {
+  const options = ['$0', '_', 'help', 'h'];
+  const argv = {
+    $0: true,
+    l: true,
+  };
+  expect(() =>
+    validateCLIOptions(argv, options),
+  ).toThrowErrorMatchingSnapshot();
+});
+
+test('shows suggestion when unrecognized cli param length > 1', () => {
+  const options = ['$0', '_', 'help', 'h'];
+  const argv = {
+    $0: true,
+    hell: true,
+  };
+  expect(() =>
+    validateCLIOptions(argv, options),
+  ).toThrowErrorMatchingSnapshot();
+});
diff --git a/packages/jest-validate/src/validateCLIOptions.ts b/packages/jest-validate/src/validateCLIOptions.ts
@@ -31,10 +31,10 @@ const createCLIValidationError = (
 
   if (unrecognizedOptions.length === 1) {
     const unrecognized = unrecognizedOptions[0];
-    const didYouMeanMessage = createDidYouMeanMessage(
-      unrecognized,
-      Array.from(allowedOptions),
-    );
+    const didYouMeanMessage =
+      unrecognized.length > 1
+        ? createDidYouMeanMessage(unrecognized, Array.from(allowedOptions))
+        : '';
     message =
       `  Unrecognized option ${chalk.bold(format(unrecognized))}.` +
       (didYouMeanMessage ? ` ${didYouMeanMessage}` : '');