docs: rewrite validate error message

per babel#10181 (comment)
JLHwung · Jul 9, 2019 · ffc6a72 · ffc6a72
1 parent 056e197
commit ffc6a72
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/packages/babel-core/src/config/full.js b/packages/babel-core/src/config/full.js
@@ -284,9 +284,18 @@ const validateIfOptionNeedsFilename = (
   descriptor: UnloadedDescriptor,
 ): void => {
   if (options.test || options.include || options.exclude) {
+    const formattedPresetName = descriptor.name
+      ? `"${descriptor.name}"`
+      : "/* your preset */";
     throw new Error(
-      `Preset ${descriptor.name ||
-        ""} requires filename, but it was not passed.`.replace(/\s{2}/, " "),
+      [
+        `Preset ${formattedPresetName} requires a filename be set.`,
+        `For example, if you are calling Babel directly`,
+        `\`\`\``,
+        `babel.transform(code, { filename: 'file.js', presets: [${formattedPresetName}] });`,
+        `\`\`\``,
+        `See https://babeljs.io/docs/en/options#filename for more information.`,
+      ].join("\n"),
     );
   }
 };

diff --git a/packages/babel-core/test/config-chain.js b/packages/babel-core/test/config-chain.js
@@ -1061,15 +1061,15 @@ describe("buildConfigChain", function() {
         loadOptions({
           presets: [require("./fixtures/config-loading/preset4")],
         });
-      }).toThrow(/Preset requires filename/);
+      }).toThrow(/Preset \/\* your preset \*\/ requires sa filename/);
     });
 
     it("should throw when `preset.overrides` requires `filename` but it was not passed", () => {
       expect(() => {
         loadOptions({
           presets: [require("./fixtures/config-loading/preset5")],
         });
-      }).toThrow(/Preset requires filename/);
+      }).toThrow(/Preset \/\* your preset \*\/ requires a filename/);
     });
   });
 });