fix: source maps for manually added multi-line content (#15365)

liuxingbaoyu · web-flow · commit 6de6d58165f9 · 2023-01-25T13:40:34.000+01:00
Fixes #15363
diff --git a/packages/babel-cli/test/fixtures/babel/filename-sourcemap --out-file --source-maps inline/in-files/.babelrc b/packages/babel-cli/test/fixtures/babel/filename-sourcemap --out-file --source-maps inline/in-files/.babelrc
@@ -1,3 +1,3 @@
 {
-    "sourceMap": "inline"
-}
+    "sourceMaps": "inline"
+}
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/index.js.map b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/index.js.map
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/input.js b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/input.js
@@ -0,0 +1,6 @@
+/*
+line1
+line2
+*/
+const myConst = 'ANY CODE OR NO CODE AT ALL';
+export { myConst };
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/options.json
@@ -0,0 +1,5 @@
+{
+  "sourceType": "module",
+  "inputSourceMap": true,
+  "plugins": ["./plugin.js"]
+}
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/output.mjs b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/output.mjs
@@ -0,0 +1,8 @@
+/*line1
+line2*/
+/*
+line1
+line2
+*/
+const myConst = 'ANY CODE OR NO CODE AT ALL';
+export { myConst };
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/plugin.js b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/plugin.js
@@ -0,0 +1,9 @@
+module.exports = function () {
+  return {
+    visitor: {
+      Program(path) {
+        path.addComment("leading", "line1\nline2");
+      },
+    },
+  };
+};
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/source-map.json b/packages/babel-core/test/fixtures/transformation/source-maps/add-multi-line-comments/source-map.json
@@ -0,0 +1,13 @@
+{
+  "version": 3,
+  "names": [
+    "myConst"
+  ],
+  "sources": [
+    "source-maps/add-multi-line-comments/input.js"
+  ],
+  "sourcesContent": [
+    "/*\nline1\nline2\n*/\nconst myConst = 'ANY CODE OR NO CODE AT ALL';\nexport { myConst };"
+  ],
+  "mappings": ";;AAAA;AACA;AACA;AACA;AACA,MAAMA,OAAO,GAAG,4BAA4B;AAC5C,SAASA,OAAO"
+}
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/arrow-function/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/arrow-function/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-arrow-functions", "transform-function-name"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/class/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/class/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-classes", "transform-block-scoping"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/class/source-map.json b/packages/babel-core/test/fixtures/transformation/source-maps/class/source-map.json
@@ -12,5 +12,5 @@
   "sourcesContent": [
     "class Test {\n  get bar() {\n    throw new Error(\"wow\");\n  }\n}\n\nvar test = new Test;\ntest.bar;"
   ],
-  "mappings": "IAAMA,IAAI;EAAA;;EAAA;IAAA;EAAA;;EAAA;IAAA;IAAA,KACR,YAAU;MACR,MAAM,IAAIC,KAAK,CAAC,KAAK,CAAC;IACxB;EAAC;EAAA;AAAA;;AAGH,IAAIC,IAAI,GAAG,IAAIF,IAAI;AACnBE,IAAI,CAACC,GAAG"
+  "mappings": "IAAMA,IAAI;EAAA;;EAAA;IAAA;EAAA;EAAA;IAAA;IAAA,KACR,YAAU;MACR,MAAM,IAAIC,KAAK,CAAC,KAAK,CAAC;IACxB;EAAC;EAAA;AAAA;AAGH,IAAIC,IAAI,GAAG,IAAIF,IAAI;AACnBE,IAAI,CAACC,GAAG"
 }
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/inline/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/inline/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-arrow-functions"],
-  "sourceMap": "inline"
+  "sourceMaps": "inline"
 }
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-complex/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-complex/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-modules-commonjs"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-complex/source-map.json b/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-complex/source-map.json
@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAsFA;EACAA;;EACAC;IACA;MACAC;IACA;EACA;;AACA",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAsFA;EACAA;EACAC;IACA;MACAC;IACA;EACA;AACA",
   "names": [
     "name",
     "data",
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-multiple-output-sources/source-map.json b/packages/babel-core/test/fixtures/transformation/source-maps/input-source-map-multiple-output-sources/source-map.json
@@ -1,6 +1,6 @@
 {
   "version": 3,
-  "mappings": "AAAC,KAAG;;ACCJ,SAASA,GAAG,CAACC,GAAW;EACpB,MAAM,IAAIC,KAAK,CAAC,cAAc,CAAC;AACnC",
+  "mappings": "AAAC,KAAG;ACCJ,SAASA,GAAG,CAACC,GAAW;EACpB,MAAM,IAAIC,KAAK,CAAC,cAAc,CAAC;AACnC",
   "names": [
     "foo",
     "bar",
diff --git a/packages/babel-core/test/fixtures/transformation/source-maps/interpreter-directive-prefix/options.json b/packages/babel-core/test/fixtures/transformation/source-maps/interpreter-directive-prefix/options.json
@@ -1,3 +1,3 @@
 {
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-generator/src/buffer.ts b/packages/babel-generator/src/buffer.ts
@@ -261,7 +261,8 @@ export default class Buffer {
 
       // We mark the start of each line, which happens directly after this newline char
       // unless this is the last char.
-      if (last < len) {
+      // When manually adding multi-line content (such as a comment), `line` will be `undefined`.
+      if (last < len && line !== undefined) {
         this._mark(++line, 0, identifierName, filename);
       }
       i = str.indexOf("\n", last);
diff --git a/packages/babel-helper-transform-fixture-test-runner/src/index.ts b/packages/babel-helper-transform-fixture-test-runner/src/index.ts
@@ -513,8 +513,15 @@ export default function (
 
           async function () {
             const runTask = () => run(task);
-            if ("sourceMap" in task.options === false) {
-              task.options.sourceMap = !!task.sourceMap;
+
+            if ("sourceMap" in task.options) {
+              throw new Error(
+                "`sourceMap` option is deprecated. Use `sourceMaps` instead.",
+              );
+            }
+
+            if ("sourceMaps" in task.options === false) {
+              task.options.sourceMaps = !!task.sourceMap;
             }
 
             Object.assign(task.options, taskOpts);
diff --git a/packages/babel-plugin-transform-destructuring/test/fixtures/sourcemap/declaration-loc/options.json b/packages/babel-plugin-transform-destructuring/test/fixtures/sourcemap/declaration-loc/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-destructuring"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-plugin-transform-destructuring/test/fixtures/sourcemap/declaration-loc/source-map.json b/packages/babel-plugin-transform-destructuring/test/fixtures/sourcemap/declaration-loc/source-map.json
@@ -12,5 +12,5 @@
   "sourcesContent": [
     "const fn = (arg) => {\n  var [x, y] = arg;\n}"
   ],
-  "mappings": "AAAA,MAAMA,EAAE,GAAIC,GAAG,IAAK;EAClB,sCAAaA,GAAG;EAAA,IAAXC,CAAC;EAAA,IAAEC,CAAC;AACX,CAAC"
+  "mappings": "AAAA,MAAMA,EAAE,GAAIC,GAAG,IAAK;EAClB,sCAAaA,GAAG;IAAXC,CAAC;IAAEC,CAAC;AACX,CAAC"
 }
diff --git a/packages/babel-plugin-transform-modules-commonjs/test/fixtures/misc/reference-source-map/options.json b/packages/babel-plugin-transform-modules-commonjs/test/fixtures/misc/reference-source-map/options.json
@@ -1,5 +1,5 @@
 {
   "externalHelpers": true,
   "plugins": ["transform-modules-commonjs"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-plugin-transform-modules-commonjs/test/fixtures/misc/reference-source-map/source-map.json b/packages/babel-plugin-transform-modules-commonjs/test/fixtures/misc/reference-source-map/source-map.json
@@ -14,5 +14,5 @@
   "sourcesContent": [
     "import aDefault from \"one\";\nimport { aNamed } from \"two\";\nimport { orig as anAliased } from \"three\";\nimport * as aNamespace from \"four\";\n\nconsole.log(aDefault);\nconsole.log(aNamed);\nconsole.log(anAliased);\nconsole.log(aNamespace);\n\nconsole.log(aDefault());\nconsole.log(aNamed());\nconsole.log(anAliased());\nconsole.log(aNamespace());"
   ],
-  "mappings": ";;AAAA;;AACA;;AACA;;AACA;AAEAA,OAAO,CAACC,GAAG,CAACC,YAAQ,CAAC;AACrBF,OAAO,CAACC,GAAG,CAACE,WAAM,CAAC;AACnBH,OAAO,CAACC,GAAG,CAACG,WAAS,CAAC;AACtBJ,OAAO,CAACC,GAAG,CAACI,UAAU,CAAC;AAEvBL,OAAO,CAACC,GAAG,CAAC,IAAAC,YAAQ,GAAE,CAAC;AACvBF,OAAO,CAACC,GAAG,CAAC,IAAAE,WAAM,GAAE,CAAC;AACrBH,OAAO,CAACC,GAAG,CAAC,IAAAG,WAAS,GAAE,CAAC;AACxBJ,OAAO,CAACC,GAAG,CAACI,UAAU,EAAE,CAAC"
+  "mappings": ";;AAAA;AACA;AACA;AACA;AAEAA,OAAO,CAACC,GAAG,CAACC,YAAQ,CAAC;AACrBF,OAAO,CAACC,GAAG,CAACE,WAAM,CAAC;AACnBH,OAAO,CAACC,GAAG,CAACG,WAAS,CAAC;AACtBJ,OAAO,CAACC,GAAG,CAACI,UAAU,CAAC;AAEvBL,OAAO,CAACC,GAAG,CAAC,IAAAC,YAAQ,GAAE,CAAC;AACvBF,OAAO,CAACC,GAAG,CAAC,IAAAE,WAAM,GAAE,CAAC;AACrBH,OAAO,CAACC,GAAG,CAAC,IAAAG,WAAS,GAAE,CAAC;AACxBJ,OAAO,CAACC,GAAG,CAACI,UAAU,EAAE,CAAC"
 }
diff --git a/packages/babel-plugin-transform-modules-commonjs/test/fixtures/strict/import/options.json b/packages/babel-plugin-transform-modules-commonjs/test/fixtures/strict/import/options.json
@@ -1 +1 @@
-{ "sourceMap": true }
+{ "sourceMaps": true }
diff --git a/packages/babel-plugin-transform-react-jsx/test/fixtures/sourcemaps/JSXText/options.json b/packages/babel-plugin-transform-react-jsx/test/fixtures/sourcemaps/JSXText/options.json
@@ -1,5 +1,5 @@
 {
   "sourceType": "module",
   "plugins": [["transform-react-jsx", { "runtime": "classic" }]],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-traverse/test/fixtures/conversion/arguments-source-maps/options.json b/packages/babel-traverse/test/fixtures/conversion/arguments-source-maps/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-arrow-functions"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-traverse/test/fixtures/conversion/arguments-source-maps/source-map.json b/packages/babel-traverse/test/fixtures/conversion/arguments-source-maps/source-map.json
@@ -13,5 +13,5 @@
   "sourcesContent": [
     "function fn() {\n  var inner = () => {\n    console.log(arguments);\n  };\n}"
   ],
-  "mappings": "AAAA,SAASA,EAAE,GAAG;EAAA;;EACZ,IAAIC,KAAK,GAAG,YAAM;IAChBC,OAAO,CAACC,GAAG,CAACC,UAAS,CAAC;EACxB,CAAC;AACH"
+  "mappings": "AAAA,SAASA,EAAE,GAAG;EAAA;EACZ,IAAIC,KAAK,GAAG,YAAM;IAChBC,OAAO,CAACC,GAAG,CAACC,UAAS,CAAC;EACxB,CAAC;AACH"
 }
diff --git a/packages/babel-traverse/test/fixtures/conversion/this-source-maps/options.json b/packages/babel-traverse/test/fixtures/conversion/this-source-maps/options.json
@@ -1,4 +1,4 @@
 {
   "plugins": ["transform-arrow-functions"],
-  "sourceMap": true
+  "sourceMaps": true
 }
diff --git a/packages/babel-traverse/test/fixtures/conversion/this-source-maps/source-map.json b/packages/babel-traverse/test/fixtures/conversion/this-source-maps/source-map.json
@@ -12,5 +12,5 @@
   "sourcesContent": [
     "function fn() {\n  var inner = () => {\n    console.log(this);\n  };\n}"
   ],
-  "mappings": "AAAA,SAASA,EAAE,GAAG;EAAA;;EACZ,IAAIC,KAAK,GAAG,YAAM;IAChBC,OAAO,CAACC,GAAG,CAAC,KAAI,CAAC;EACnB,CAAC;AACH"
+  "mappings": "AAAA,SAASA,EAAE,GAAG;EAAA;EACZ,IAAIC,KAAK,GAAG,YAAM;IAChBC,OAAO,CAACC,GAAG,CAAC,KAAI,CAAC;EACnB,CAAC;AACH"
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "sourceMap": "inline"`
`3`		`-}`
	`2`	`+ "sourceMaps": "inline"`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +/*
 +line1
 +line2
 +*/
 +const myConst = 'ANY CODE OR NO CODE AT ALL';
 +export { myConst };
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"plugins": ["transform-arrow-functions", "transform-function-name"],`
`3`		`- "sourceMap": true`
	`3`	`+ "sourceMaps": true`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"plugins": ["transform-classes", "transform-block-scoping"],`
`3`		`- "sourceMap": true`
	`3`	`+ "sourceMaps": true`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,5 @@`
`12`	`12`	`"sourcesContent": [`
`13`	`13`	`"class Test {\n get bar() {\n throw new Error(\"wow\");\n }\n}\n\nvar test = new Test;\ntest.bar;"`
`14`	`14`	`],`
`15`		`- "mappings": "IAAMA,IAAI;EAAA;;EAAA;IAAA;EAAA;;EAAA;IAAA;IAAA,KACR,YAAU;MACR,MAAM,IAAIC,KAAK,CAAC,KAAK,CAAC;IACxB;EAAC;EAAA;AAAA;;AAGH,IAAIC,IAAI,GAAG,IAAIF,IAAI;AACnBE,IAAI,CAACC,GAAG"`
	`15`	`+ "mappings": "IAAMA,IAAI;EAAA;;EAAA;IAAA;EAAA;EAAA;IAAA;IAAA,KACR,YAAU;MACR,MAAM,IAAIC,KAAK,CAAC,KAAK,CAAC;IACxB;EAAC;EAAA;AAAA;AAGH,IAAIC,IAAI,GAAG,IAAIF,IAAI;AACnBE,IAAI,CAACC,GAAG"`
`16`	`16`	`}`