CHANGELOG.md

@@ -1,5 +1,96 @@
 # Changelog
 
+## 0.16.6
+
+* Do not mark subpath imports as external with `--packages=external` ([#2741](https://github.com/evanw/esbuild/issues/2741))
+
+    Node has a feature called [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) where special import paths that start with `#` are resolved using the `imports` field in the `package.json` file of the enclosing package. The intent of the newly-added `--packages=external` setting is to exclude a package's dependencies from the bundle. Since a package's subpath imports are only accessible within that package, it's wrong for them to be affected by `--packages=external`. This release changes esbuild so that `--packages=external` no longer affects subpath imports.
+
+* Forbid invalid numbers in JSON files
+
+    Previously esbuild parsed numbers in JSON files using the same syntax as JavaScript. But starting from this release, esbuild will now parse them with JSON syntax instead. This means the following numbers are no longer allowed by esbuild in JSON files:
+
+    * Legacy octal literals (non-zero integers starting with `0`)
+    * The `0b`, `0o`, and `0x` numeric prefixes
+    * Numbers containing `_` such as `1_000`
+    * Leading and trailing `.` such as `0.` and `.0`
+    * Numbers with a space after the `-` such as `- 1`
+
+* Add external imports to metafile ([#905](https://github.com/evanw/esbuild/issues/905), [#1768](https://github.com/evanw/esbuild/issues/1768), [#1933](https://github.com/evanw/esbuild/issues/1933), [#1939](https://github.com/evanw/esbuild/issues/1939))
+
+    External imports now appear in `imports` arrays in the metafile (which is present when bundling with `metafile: true`) next to normal imports, but additionally have `external: true` to set them apart. This applies both to files in the `inputs` section and the `outputs` section. Here's an example:
+
+    ```diff
+     {
+       "inputs": {
+         "style.css": {
+           "bytes": 83,
+           "imports": [
+    +        {
+    +          "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css",
+    +          "kind": "import-rule",
+    +          "external": true
+    +        }
+           ]
+         },
+         "app.js": {
+           "bytes": 100,
+           "imports": [
+    +        {
+    +          "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js",
+    +          "kind": "import-statement",
+    +          "external": true
+    +        },
+             {
+               "path": "style.css",
+               "kind": "import-statement"
+             }
+           ]
+         }
+       },
+       "outputs": {
+         "out/app.js": {
+           "imports": [
+    +        {
+    +          "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js",
+    +          "kind": "require-call",
+    +          "external": true
+    +        }
+           ],
+           "exports": [],
+           "entryPoint": "app.js",
+           "cssBundle": "out/app.css",
+           "inputs": {
+             "app.js": {
+               "bytesInOutput": 113
+             },
+             "style.css": {
+               "bytesInOutput": 0
+             }
+           },
+           "bytes": 528
+         },
+         "out/app.css": {
+           "imports": [
+    +        {
+    +          "path": "https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css",
+    +          "kind": "import-rule",
+    +          "external": true
+    +        }
+           ],
+           "inputs": {
+             "style.css": {
+               "bytesInOutput": 0
+             }
+           },
+           "bytes": 100
+         }
+       }
+     }
+    ```
+
+    One additional useful consequence of this is that the `imports` array is now populated when bundling is disabled. So you can now use esbuild with bundling disabled to inspect a file's imports.
+
 ## 0.16.5
 
 * Make it easy to exclude all packages from a bundle ([#1958](https://github.com/evanw/esbuild/issues/1958), [#1975](https://github.com/evanw/esbuild/issues/1975), [#2164](https://github.com/evanw/esbuild/issues/2164), [#2246](https://github.com/evanw/esbuild/issues/2246), [#2542](https://github.com/evanw/esbuild/issues/2542))

cmd/esbuild/version.go

@@ -1,3 +1,3 @@
 package main
 
-const esbuildVersion = "0.16.5"
+const esbuildVersion = "0.16.6"

internal/ast/ast.go

@@ -116,6 +116,9 @@ const (
 
 	// If true, "assert { type: 'json' }" was present
 	AssertTypeJSON
+
+	// If true, do not generate "external": true in the metafile
+	ShouldNotBeExternalInMetafile
 )
 
 func (flags ImportRecordFlags) Has(flag ImportRecordFlags) bool {

internal/bundler/bundler.go

@@ -1819,6 +1819,17 @@ func (s *scanner) processScannedFiles(entryPointMeta []graph.EntryPoint) []scann
 				// Skip this import record if the previous resolver call failed
 				resolveResult := result.resolveResults[importRecordIndex]
 				if resolveResult == nil || !record.SourceIndex.IsValid() {
+					if s.options.NeedsMetafile {
+						if isFirstImport {
+							isFirstImport = false
+							sb.WriteString("\n        ")
+						} else {
+							sb.WriteString(",\n        ")
+						}
+						sb.WriteString(fmt.Sprintf("{\n          \"path\": %s,\n          \"kind\": %s,\n          \"external\": true\n        }",
+							helpers.QuoteForJSON(record.Path.Text, s.options.ASCIIOnly),
+							helpers.QuoteForJSON(record.Kind.StringForMetafile(), s.options.ASCIIOnly)))
+					}
 					continue
 				}
 

internal/bundler/bundler_default_test.go

@@ -7083,23 +7083,131 @@ NOTE: You can either keep the import assertion and only use the "default" import
 func TestExternalPackages(t *testing.T) {
 	loader_suite.expectBundled(t, bundled{
 		files: map[string]string{
-			"/entry.js": `
+			"/project/entry.js": `
 				import 'pkg1'
 				import './file'
 				import './node_modules/pkg2/index.js'
+				import '#pkg3'
 			`,
-			"/file.js": `
+			"/project/package.json": `{
+				"imports": {
+					"#pkg3": "./libs/pkg3.js"
+				}
+			}`,
+			"/project/file.js": `
 				console.log('file')
 			`,
-			"/node_modules/pkg2/index.js": `
+			"/project/node_modules/pkg2/index.js": `
 				console.log('pkg2')
 			`,
+			"/project/libs/pkg3.js": `
+				console.log('pkg3')
+			`,
 		},
-		entryPaths: []string{"/entry.js"},
+		entryPaths: []string{"/project/entry.js"},
 		options: config.Options{
 			Mode:             config.ModeBundle,
 			AbsOutputFile:    "/out.js",
 			ExternalPackages: true,
 		},
 	})
 }
+
+func TestMetafileVariousCases(t *testing.T) {
+	loader_suite.expectBundled(t, bundled{
+		files: map[string]string{
+			"/project/entry.js": `
+				import a from 'extern-esm'
+				import b from './esm'
+				import c from 'data:application/json,2'
+				import d from './file.file'
+				import e from './copy.copy'
+				console.log(
+					a,
+					b,
+					c,
+					d,
+					e,
+					require('extern-cjs'),
+					require('./cjs'),
+					import('./dynamic'),
+				)
+				export let exported
+			`,
+			"/project/entry.css": `
+				@import "extern.css";
+				a { background: url(inline.svg) }
+				b { background: url(file.file) }
+				c { background: url(copy.copy) }
+				d { background: url(extern.png) }
+			`,
+			"/project/esm.js":     `export default 1`,
+			"/project/cjs.js":     `module.exports = 4`,
+			"/project/dynamic.js": `export default 5`,
+			"/project/file.file":  `file`,
+			"/project/copy.copy":  `copy`,
+			"/project/inline.svg": `<svg/>`,
+		},
+		entryPaths: []string{
+			"/project/entry.js",
+			"/project/entry.css",
+		},
+		options: config.Options{
+			Mode:         config.ModeBundle,
+			AbsOutputDir: "/out",
+			ExtensionToLoader: map[string]config.Loader{
+				".js":   config.LoaderJS,
+				".css":  config.LoaderCSS,
+				".file": config.LoaderFile,
+				".copy": config.LoaderCopy,
+				".svg":  config.LoaderDataURL,
+			},
+			ExternalSettings: config.ExternalSettings{
+				PreResolve: config.ExternalMatchers{
+					Exact: map[string]bool{
+						"extern-esm": true,
+						"extern-cjs": true,
+						"extern.css": true,
+						"extern.png": true,
+					},
+				},
+			},
+			NeedsMetafile: true,
+			CodeSplitting: true,
+		},
+	})
+}
+
+func TestMetafileNoBundle(t *testing.T) {
+	loader_suite.expectBundled(t, bundled{
+		files: map[string]string{
+			"/project/entry.js": `
+				import a from 'pkg'
+				import b from './file'
+				console.log(
+					a,
+					b,
+					require('pkg2'),
+					require('./file2'),
+					import('./dynamic'),
+				)
+				export let exported
+			`,
+			"/project/entry.css": `
+				@import "pkg";
+				@import "./file";
+				a { background: url(pkg2) }
+				a { background: url(./file2) }
+			`,
+		},
+		entryPaths: []string{
+			"/project/entry.js",
+			"/project/entry.css",
+		},
+		options: config.Options{
+			Mode:          config.ModeConvertFormat,
+			AbsOutputDir:  "/out",
+			NeedsMetafile: true,
+		},
+	})
+}

internal/bundler/bundler_packagejson_test.go

@@ -2179,6 +2179,64 @@ func TestPackageJsonExportsPatternTrailers(t *testing.T) {
 	})
 }
 
+// Node's package.json format for "exports" allows for arrays to be used as map
+// values, like in the example below. Webpack's implementation interprets this
+// as a way to specify several alternative directories to search for packages.
+// See: https://webpack.js.org/guides/package-exports/#alternatives. However,
+// this doesn't follow Node's specification for how "exports" should work:
+// https://nodejs.org/api/esm.html#resolver-algorithm. Also no one else
+// implements it this way (e.g. both Node and Rollup don't do this).
+//
+// This test case can only be built by Webpack. Implementations that follow the
+// specification (including esbuild) will fail to build this test case. This
+// test case only exists to document that esbuild doesn't follow Webpack's
+// behavior here.
+func TestPackageJsonExportsAlternatives(t *testing.T) {
+	packagejson_suite.expectBundled(t, bundled{
+		files: map[string]string{
+			"/Users/user/project/src/entry.js": `
+				import redApple from 'pkg/apples/red.js'
+				import greenApple from 'pkg/apples/green.js'
+				import redBook from 'pkg/books/red'
+				import greenBook from 'pkg/books/green'
+				console.log({redApple, greenApple, redBook, greenBook})
+			`,
+			"/Users/user/project/node_modules/pkg/package.json": `
+				{
+					"exports": {
+						"./apples/": ["./good-apples/", "./bad-apples/"],
+						"./books/*": ["./good-books/*-book.js", "./bad-books/*-book.js"]
+					}
+				}
+			`,
+			"/Users/user/project/node_modules/pkg/good-apples/green.js": `
+				export default '🍏'
+			`,
+			"/Users/user/project/node_modules/pkg/bad-apples/red.js": `
+				export default '🍎'
+			`,
+			"/Users/user/project/node_modules/pkg/good-books/green-book.js": `
+				export default '📗'
+			`,
+			"/Users/user/project/node_modules/pkg/bad-books/red-book.js": `
+				export default '📕'
+			`,
+		},
+		entryPaths: []string{"/Users/user/project/src/entry.js"},
+		options: config.Options{
+			Mode:          config.ModeBundle,
+			AbsOutputFile: "/Users/user/project/out.js",
+		},
+		expectedScanLog: `Users/user/project/src/entry.js: ERROR: Could not resolve "pkg/apples/red.js"
+Users/user/project/node_modules/pkg/package.json: NOTE: The module "./good-apples/red.js" was not found on the file system:
+NOTE: You can mark the path "pkg/apples/red.js" as external to exclude it from the bundle, which will remove this error.
+Users/user/project/src/entry.js: ERROR: Could not resolve "pkg/books/red"
+Users/user/project/node_modules/pkg/package.json: NOTE: The module "./good-books/red-book.js" was not found on the file system:
+NOTE: You can mark the path "pkg/books/red" as external to exclude it from the bundle, which will remove this error.
+`,
+	})
+}
+
 func TestPackageJsonImports(t *testing.T) {
 	packagejson_suite.expectBundled(t, bundled{
 		files: map[string]string{