improved recordAndTuple generator error message, added tests for inva…

…lid,missing options
babel · Jan 14, 2020 · 1437239 · 1437239
1 parent cdfd3bc
commit 1437239
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 14 deletions.
diff --git a/packages/babel-generator/src/generators/types.js b/packages/babel-generator/src/generators/types.js
@@ -119,7 +119,9 @@ export function RecordExpression(node: Object) {
     endToken = "}";
   } else {
     throw new Error(
-      `${this.format.recordAndTupleSyntaxType} is not a valid recordAndTuple syntax type`,
+      `The "recordAndTupleSyntaxType" generator option must be either "bar" or "hash" (${JSON.stringify(
+        this.format.recordAndTupleSyntaxType,
+      )} received).`,
     );
   }
 

diff --git a/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/invalid-option/input.js b/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/invalid-option/input.js
@@ -0,0 +1 @@
+#{ a: 1 }
diff --git a/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/invalid-option/options.json b/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/invalid-option/options.json
@@ -0,0 +1,5 @@
+{
+  "plugins": [["recordAndTuple", { "syntaxType": "hash" }]],
+  "recordAndTupleSyntaxType": "invalid",
+  "throws": "The \"recordAndTupleSyntaxType\" generator option must be either \"bar\" or \"hash\" (\"invalid\" received)"
+}
diff --git a/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/missing-option/input.js b/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/missing-option/input.js
@@ -0,0 +1 @@
+#{ a: 1 }
diff --git a/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/missing-option/options.json b/packages/babel-generator/test/fixtures/recordAndTupleSyntaxType/missing-option/options.json
@@ -0,0 +1,4 @@
+{
+  "plugins": [["recordAndTuple", { "syntaxType": "hash" }]],
+  "throws": "The \"recordAndTupleSyntaxType\" generator option must be either \"bar\" or \"hash\" (undefined received)"
+}
diff --git a/packages/babel-generator/test/index.js b/packages/babel-generator/test/index.js
@@ -525,22 +525,33 @@ suites.forEach(function(testSuite) {
               sourceMaps: task.sourceMap ? true : task.options.sourceMaps,
             };
 
-            const result = generate(actualAst, options, actualCode);
-
-            if (options.sourceMaps) {
-              expect(result.map).toEqual(task.sourceMap);
+            function run() {
+              return generate(actualAst, options, actualCode);
             }
 
-            if (
-              !expected.code &&
-              result.code &&
-              fs.statSync(path.dirname(expected.loc)).isDirectory() &&
-              !process.env.CI
-            ) {
-              console.log(`New test file created: ${expected.loc}`);
-              fs.writeFileSync(expected.loc, result.code);
+            const throwMsg = task.options.throws;
+            if (throwMsg) {
+              expect(() => run()).toThrow(
+                throwMsg === true ? undefined : throwMsg,
+              );
             } else {
-              expect(result.code).toBe(expected.code);
+              const result = run();
+
+              if (options.sourceMaps) {
+                expect(result.map).toEqual(task.sourceMap);
+              }
+
+              if (
+                !expected.code &&
+                result.code &&
+                fs.statSync(path.dirname(expected.loc)).isDirectory() &&
+                !process.env.CI
+              ) {
+                console.log(`New test file created: ${expected.loc}`);
+                fs.writeFileSync(expected.loc, result.code);
+              } else {
+                expect(result.code).toBe(expected.code);
+              }
             }
           }
         },