Require grammarSource when generating source maps. Fixes #285.

peggyjs · Jun 10, 2022 · 715e4f7 · 715e4f7
1 parent 46878cd
commit 715e4f7
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -125,6 +125,9 @@ Released: 2022-05-28
   definition of SyntaxError, from @cmfcmf
 - [#220](https://github.com/peggyjs/peggy/issues/220): Fix rollup warnings,
   from @hildjj
+- [#285](https://github.com/peggyjs/peggy/issues/285): Work around source-map
+  bug by throwing an exception if no grammarSource is given when generating
+  source maps, from @hildjj.
 
 1.2.0
 -----

diff --git a/docs/documentation.html b/docs/documentation.html
@@ -414,15 +414,14 @@ <h3 id="generating-a-parser-javascript-api">JavaScript API</h3>
     </ul>
     <p>(default: <code>"parser"</code>)</p>
     <blockquote>
-      <p><strong>Note</strong>: because of bug <a
-      href="https://github.com/mozilla/source-map/issues/444">source-map/444</a>
-      you should also set <code>grammarSource</code> to a not-empty string if
-      you set this value to <code>"source-and-map"</code> or
-      <code>"source-with-inline-map"</code>.  The path should be relative to
-      the location where the generated parser code will be stored.  For
-      example, if you are generating <code>lib/parser.js</code> from
-      <code>src/parser.peggy</code>, then your options should be:
-      <code>{ grammarSource: "../src/parser.peggy" }</code></p>
+      <p><strong>Note</strong>: You should also set <code>grammarSource</code>
+        to a not-empty string if you set this value to
+        <code>"source-and-map"</code> or
+        <code>"source-with-inline-map"</code>.  The path should be relative to
+        the location where the generated parser code will be stored.  For
+        example, if you are generating <code>lib/parser.js</code> from
+        <code>src/parser.peggy</code>, then your options should be:
+        <code>{ grammarSource: "../src/parser.peggy" }</code></p>
     </blockquote>
   </dd>
 

diff --git a/lib/compiler/index.js b/lib/compiler/index.js
@@ -93,6 +93,12 @@ const compiler = {
         }
       }
     }
+    if (((options.output === "source-and-map")
+         || (options.output === "source-with-inline-map"))
+        && ((typeof options.grammarSource !== "string")
+            || (options.grammarSource.length === 0))) {
+      throw new Error("Must provide grammarSource in order to generate source maps");
+    }
 
     const session = new Session(options);
     Object.keys(passes).forEach(stage => {

diff --git a/test/types/peg.test-d.ts b/test/types/peg.test-d.ts
@@ -110,13 +110,22 @@ describe("peg.d.ts", () => {
     const p1 = peggy.generate(src, { output: "source" });
     expectType<string>(p1);
 
-    const p2 = peggy.generate(src, { output: "source-and-map" });
+    const p2 = peggy.generate(src, {
+      output: "source-and-map",
+      grammarSource: "src.peggy",
+    });
     expectType<SourceNode>(p2);
 
-    const p3 = peggy.generate(src, { output: true as boolean ? "source-and-map" : "source" });
+    const p3 = peggy.generate(src, {
+      output: true as boolean ? "source-and-map" : "source",
+      grammarSource: "src.peggy",
+    });
     expectType<string | SourceNode>(p3);
 
-    const p4 = peggy.generate(src, { output: "source-with-inline-map" });
+    const p4 = peggy.generate(src, {
+      output: "source-with-inline-map",
+      grammarSource: "src.peggy",
+    });
     expectType<string>(p4);
   });
 
@@ -134,21 +143,27 @@ describe("peg.d.ts", () => {
     const p2 = peggy.compiler.compile(
       ast,
       peggy.compiler.passes,
-      { output: "source-and-map" }
+      { output: "source-and-map", grammarSource: "src.peggy" }
     );
     expectType<SourceNode>(p2);
 
     const p3 = peggy.compiler.compile(
       ast,
       peggy.compiler.passes,
-      { output: true as boolean ? "source-and-map" : "source" }
+      {
+        output: true as boolean ? "source-and-map" : "source",
+        grammarSource: "src.peggy",
+      }
     );
     expectType<string | SourceNode>(p3);
 
     const p4 = peggy.compiler.compile(
       ast,
       peggy.compiler.passes,
-      { output: "source-with-inline-map" }
+      {
+        output: "source-with-inline-map",
+        grammarSource: "src.peggy",
+      }
     );
     expectType<string>(p4);
   });

diff --git a/test/unit/compiler.spec.js b/test/unit/compiler.spec.js
@@ -39,6 +39,7 @@ describe("Peggy compiler", () => {
     if (typeof TextEncoder === "function") {
       expect(compiler.compile(ast, compiler.passes, {
         output: "source-with-inline-map",
+        grammarSource: "src.peggy",
       })).to.match(
         /^\/\/# sourceMappingURL=data:application\/json;charset=utf-8;base64,/m
       );
@@ -50,6 +51,7 @@ describe("Peggy compiler", () => {
         delete globalThis.TextEncoder;
         expect(() => compiler.compile(ast, compiler.passes, {
           output: "source-with-inline-map",
+          grammarSource: "src.peggy",
         })).to.throw("TextEncoder is not supported by this platform");
         globalThis.TextEncoder = TE;
       }