release notes for #3539

evanw · evanw · commit 3f57db853fac · 2024-06-30T14:34:27.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -50,6 +50,12 @@
 
     Plugins that return values from `onResolve` without resolving the path (i.e. without setting either `path` or `external: true`) will now cause a warning. This is because esbuild only uses return values from `onResolve` if it successfully resolves the path, and it's not good for invalid input to be silently ignored.
 
+* Add a new Go API for running the CLI with plugins ([#3539](https://github.com/evanw/esbuild/pull/3539))
+
+    With esbuild's Go API, you can now call `cli.RunWithPlugins(args, plugins)` to pass an array of esbuild plugins to be used during the build process. This allows you to create a CLI that behaves similarly to esbuild's CLI but with additional Go plugins enabled.
+
+    This was contributed by [@edewit](https://github.com/edewit).
+
 ## 0.21.5
 
 * Fix `Symbol.metadata` on classes without a class decorator ([#3781](https://github.com/evanw/esbuild/issues/3781))
diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go
@@ -31,11 +31,10 @@ func Run(osArgs []string) int {
 	return runImpl(osArgs, []api.Plugin{})
 }
 
-// This function invokes the esbuild CLI. It takes an array of command-line
-// arguments (excluding the executable argument itself) and returns an exit
-// code. It also takes adds some plugins that need to be added to the run
-func RunWithPlugins(osArgs []string, plugin []api.Plugin) int {
-	return runImpl(osArgs, plugin)
+// This is similar to "Run()" but also takes an array of plugins to be used
+// during the build process.
+func RunWithPlugins(osArgs []string, plugins []api.Plugin) int {
+	return runImpl(osArgs, plugins)
 }
 
 // This parses an array of strings into an options object suitable for passing
diff --git a/pkg/cli/cli_impl.go b/pkg/cli/cli_impl.go
@@ -1143,6 +1143,12 @@ func runImpl(osArgs []string, plugins []api.Plugin) int {
 
 	osArgs, analyze := filterAnalyzeFlags(osArgs)
 	buildOptions, transformOptions, extras, err := parseOptionsForRun(osArgs)
+
+	// Add any plugins from the caller after parsing the build options
+	if buildOptions != nil {
+		buildOptions.Plugins = append(buildOptions.Plugins, plugins...)
+	}
+
 	if analyze != analyzeDisabled {
 		addAnalyzePlugin(buildOptions, analyze, osArgs)
 	}
@@ -1280,7 +1286,6 @@ func runImpl(osArgs []string, plugins []api.Plugin) int {
 			}
 		}
 
-		buildOptions.Plugins = plugins
 		// Handle post-build actions with a plugin so they also work in watch mode
 		buildOptions.Plugins = append(buildOptions.Plugins, api.Plugin{
 			Name: "PostBuildActions",

Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,10 @@ func Run(osArgs []string) int {`
`31`	`31`	`return runImpl(osArgs, []api.Plugin{})`
`32`	`32`	`}`
`33`	`33`
`34`		`-// This function invokes the esbuild CLI. It takes an array of command-line`
`35`		`-// arguments (excluding the executable argument itself) and returns an exit`
`36`		`-// code. It also takes adds some plugins that need to be added to the run`
`37`		`-func RunWithPlugins(osArgs []string, plugin []api.Plugin) int {`
`38`		`- return runImpl(osArgs, plugin)`
	`34`	`+// This is similar to "Run()" but also takes an array of plugins to be used`
	`35`	`+// during the build process.`
	`36`	`+func RunWithPlugins(osArgs []string, plugins []api.Plugin) int {`
	`37`	`+ return runImpl(osArgs, plugins)`
`39`	`38`	`}`
`40`	`39`
`41`	`40`	`// This parses an array of strings into an options object suitable for passing`
Original file line number	Diff line number	Diff line change
`@@ -1143,6 +1143,12 @@ func runImpl(osArgs []string, plugins []api.Plugin) int {`
`1143`	`1143`
`1144`	`1144`	`osArgs, analyze := filterAnalyzeFlags(osArgs)`
`1145`	`1145`	`buildOptions, transformOptions, extras, err := parseOptionsForRun(osArgs)`
	`1146`	`+`
	`1147`	`+ // Add any plugins from the caller after parsing the build options`
	`1148`	`+ if buildOptions != nil {`
	`1149`	`+ buildOptions.Plugins = append(buildOptions.Plugins, plugins...)`
	`1150`	`+ }`
	`1151`	`+`
`1146`	`1152`	`if analyze != analyzeDisabled {`
`1147`	`1153`	`addAnalyzePlugin(buildOptions, analyze, osArgs)`
`1148`	`1154`	`}`
`@@ -1280,7 +1286,6 @@ func runImpl(osArgs []string, plugins []api.Plugin) int {`
`1280`	`1286`	`}`
`1281`	`1287`	`}`
`1282`	`1288`
`1283`		`- buildOptions.Plugins = plugins`
`1284`	`1289`	`// Handle post-build actions with a plugin so they also work in watch mode`
`1285`	`1290`	`buildOptions.Plugins = append(buildOptions.Plugins, api.Plugin{`
`1286`	`1291`	`Name: "PostBuildActions",`