flagDefaults as struct param; call flag --omit-nix-env and use in shellenv/shell/run commands

Author: savil

internal/boxcli/global.go

@@ -28,20 +28,20 @@ func globalCmd() *cobra.Command {
 PersistentPostRunE: ensureGlobalEnvEnabled,
 }
 
-shellEnv := shellEnvCmd(
-withEnvForPackageBins(true),
-withRecompute(false),
-)
-
 addCommandAndHideConfigFlag(globalCmd, addCmd())
 addCommandAndHideConfigFlag(globalCmd, installCmd())
 addCommandAndHideConfigFlag(globalCmd, pathCmd())
 addCommandAndHideConfigFlag(globalCmd, pullCmd())
 addCommandAndHideConfigFlag(globalCmd, pushCmd())
 addCommandAndHideConfigFlag(globalCmd, removeCmd())
-addCommandAndHideConfigFlag(globalCmd, runCmd())
+addCommandAndHideConfigFlag(globalCmd, runCmd(runFlagDefaults{
+omitNixEnv: true,
+}))
 addCommandAndHideConfigFlag(globalCmd, servicesCmd(persistentPreRunE))
-addCommandAndHideConfigFlag(globalCmd, shellEnv)
+addCommandAndHideConfigFlag(globalCmd, shellEnvCmd(shellenvFlagDefaults{
+omitNixEnv: true,
+recomputeEnv: false,
+}))
 addCommandAndHideConfigFlag(globalCmd, updateCmd())
 addCommandAndHideConfigFlag(globalCmd, listCmd())
 

internal/boxcli/root.go

@@ -71,12 +71,14 @@ func RootCmd() *cobra.Command {
 command.AddCommand(listCmd())
 command.AddCommand(logCmd())
 command.AddCommand(removeCmd())
-command.AddCommand(runCmd())
+command.AddCommand(runCmd(runFlagDefaults{}))
 command.AddCommand(searchCmd())
 command.AddCommand(servicesCmd())
 command.AddCommand(setupCmd())
-command.AddCommand(shellCmd())
-command.AddCommand(shellEnvCmd())
+command.AddCommand(shellCmd(shellFlagDefaults{}))
+command.AddCommand(shellEnvCmd(shellenvFlagDefaults{
+recomputeEnv: true,
+}))
 command.AddCommand(updateCmd())
 command.AddCommand(versionCmd())
 // Preview commands

internal/boxcli/run.go

@@ -22,11 +22,18 @@ import (
 type runCmdFlags struct {
 envFlag
 config configFlags
+omitNixEnv bool
 pure bool
 listScripts bool
 }
 
-func runCmd() *cobra.Command {
+// runFlagDefaults are the flag default values that differ
+// from the `devbox` command versus `devbox global` command.
+type runFlagDefaults struct {
+omitNixEnv bool
+}
+
+func runCmd(defaults runFlagDefaults) *cobra.Command {
 flags := runCmdFlags{}
 command := &cobra.Command{
 Use: "run [<script> | <cmd>]",
@@ -50,6 +57,11 @@ func runCmd() *cobra.Command {
 &flags.pure, "pure", false, "if this flag is specified, devbox runs the script in an isolated environment inheriting almost no variables from the current environment. A few variables, in particular HOME, USER and DISPLAY, are retained.")
 command.Flags().BoolVarP(
 &flags.listScripts, "list", "l", false, "list all scripts defined in devbox.json")
+command.Flags().BoolVar(
+&flags.omitNixEnv, "omit-nix-env", defaults.omitNixEnv,
+"shell environment will omit the env-vars from print-dev-env",
+)
+_ = command.Flags().MarkHidden("omit-nix-env")
 
 command.ValidArgs = listScripts(command, flags)
 
@@ -102,6 +114,7 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
 Dir: path,
 Environment: flags.config.environment,
 Stderr: cmd.ErrOrStderr(),
+OmitNixEnv: flags.omitNixEnv,
 Pure: flags.pure,
 Env: env,
 })

internal/boxcli/shell.go

@@ -17,12 +17,19 @@ import (
 
 type shellCmdFlags struct {
 envFlag
-config configFlags
-printEnv bool
-pure bool
+config configFlags
+omitNixEnv bool
+printEnv bool
+pure bool
 }
 
-func shellCmd() *cobra.Command {
+// shellFlagDefaults are the flag default values that differ
+// from the `devbox` command versus `devbox global` command.
+type shellFlagDefaults struct {
+omitNixEnv bool
+}
+
+func shellCmd(defaults shellFlagDefaults) *cobra.Command {
 flags := shellCmdFlags{}
 command := &cobra.Command{
 Use: "shell",
@@ -41,6 +48,11 @@ func shellCmd() *cobra.Command {
 &flags.printEnv, "print-env", false, "print script to setup shell environment")
 command.Flags().BoolVar(
 &flags.pure, "pure", false, "if this flag is specified, devbox creates an isolated shell inheriting almost no variables from the current environment. A few variables, in particular HOME, USER and DISPLAY, are retained.")
+command.Flags().BoolVar(
+&flags.omitNixEnv, "omit-nix-env", defaults.omitNixEnv,
+"shell environment will omit the env-vars from print-dev-env",
+)
+_ = command.Flags().MarkHidden("omit-nix-env")
 
 flags.config.register(command)
 flags.envFlag.register(command)
@@ -57,6 +69,7 @@ func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
 Dir: flags.config.path,
 Env: env,
 Environment: flags.config.environment,
+OmitNixEnv: flags.omitNixEnv,
 Pure: flags.pure,
 Stderr: cmd.ErrOrStderr(),
 })

internal/boxcli/shellenv.go

@@ -15,9 +15,8 @@ import (
 
 type shellEnvCmdFlags struct {
 envFlag
-config configFlags
-// TODO: is this flag needed in other commands?
-envForPackageBins bool
+config configFlags
+omitNixEnv bool
 install bool
 noRefreshAlias bool
 preservePathStack bool
@@ -26,32 +25,14 @@ type shellEnvCmdFlags struct {
 runInitHook bool
 }
 
+// shellenvFlagDefaults are the flag default values that differ
+// from the `devbox` command versus `devbox global` command.
 type shellenvFlagDefaults struct {
-envForPackageBins bool
-recomputeEnv  bool
+omitNixEnv  bool
+recomputeEnv bool
 }
 
-type shellenvFlagDefault func(*shellenvFlagDefaults)
-
-func withEnvForPackageBins(envForPackageBins bool) shellenvFlagDefault {
-return func(o *shellenvFlagDefaults) {
-o.envForPackageBins = envForPackageBins
-}
-}
-
-func withRecompute(recompute bool) shellenvFlagDefault {
-return func(o *shellenvFlagDefaults) {
-o.recomputeEnv = recompute
-}
-}
-
-func shellEnvCmd(opts ...shellenvFlagDefault) *cobra.Command {
-defaults := shellenvFlagDefaults{
-recomputeEnv: true,
-}
-for _, opt := range opts {
-opt(&defaults)
-}
+func shellEnvCmd(defaults shellenvFlagDefaults) *cobra.Command {
 
 flags := shellEnvCmdFlags{}
 command := &cobra.Command{
@@ -90,9 +71,10 @@ func shellEnvCmd(opts ...shellenvFlagDefault) *cobra.Command {
 "Use this flag to disable this behavior.")
 _ = command.Flags().MarkHidden("no-refresh-alias")
 command.Flags().BoolVar(
-&flags.envForPackageBins, "env-for-package-binaries", defaults.envForPackageBins,
-"include package bin directories in the PATH")
-_ = command.Flags().MarkHidden("env-for-package-binaries")
+&flags.omitNixEnv, "omit-nix-env", defaults.omitNixEnv,
+"shell environment will omit the env-vars from print-dev-env",
+)
+_ = command.Flags().MarkHidden("omit-nix-env")
 
 command.Flags().BoolVarP(
 &flags.recomputeEnv, "recompute", "r", defaults.recomputeEnv,
@@ -116,7 +98,7 @@ func shellEnvFunc(
 box, err := devbox.Open(&devopt.Opts{
 Dir: flags.config.path,
 Environment: flags.config.environment,
-EnvForPackageBins: flags.envForPackageBins,
+OmitNixEnv: flags.omitNixEnv,
 Stderr: cmd.ErrOrStderr(),
 PreservePathStack: flags.preservePathStack,
 Pure: flags.pure,

internal/devbox/devbox.go

@@ -98,7 +98,7 @@ func Open(opts *devopt.Opts) (*Devbox, error) {
 box := &Devbox{
 cfg: cfg,
 env: opts.Env,
-envForPackageBins: opts.EnvForPackageBins,
+envForPackageBins: opts.OmitNixEnv,
 environment: environment,
 nix: &nix.Nix{},
 projectDir: projectDir,

internal/devbox/devopt/devboxopts.go

@@ -9,13 +9,10 @@ import (
 // - omit suffix Opts for other structs that are composed into an Opts struct
 
 type Opts struct {
-Dir string
-Env map[string]string
-Environment string
-// EnvForPackageBins will create the Devbox environment from print-dev-env
-// such that it is optimized for executing binaries, and not for developing
-// software using dependencies installed in the Devbox environment.
-EnvForPackageBins bool
+Dir string
+Env map[string]string
+Environment string
+OmitNixEnv bool
 PreservePathStack bool
 Pure bool
 IgnoreWarnings bool