Cleanup in response to PR comments

Author: pstephan-geico-external

internal/boxcli/generate.go

@@ -157,13 +157,14 @@ func direnvCmd() *cobra.Command {
 	// --envrc-dir allows users to specify a directory where the .envrc file should be generated
 	// separately from the devbox config directory. Without this flag, the .envrc file
 	// will be generated in the same directory as the devbox config file (i.e., either the current
-	// directory or the directory specified by --config). This is useful for users who want to keep
-	// their .envrc and devbox config files in different locations.
+	// directory or the directory specified by --config). This flag is useful for users who want to
+	// keep their .envrc and devbox config files in different locations.
 	command.Flags().StringVar(
 		&flags.envrcDir, "envrc-dir", "",
-		"path to directory where the .envrc file should be generated. "+
-			"If not specified, the .envrc file will be generated in "+
-			"the current working directory.")
+		"path to directory where the .envrc file should be generated.\n"+
+			"If not specified, the .envrc file will be generated in the same directory as\n"+
+			"the devbox.json config file. Also, when specified along with --config, the config file\n"+
+			"location will be relative to the .envrc file location.")
 
 	flags.config.register(command)
 	return command
@@ -288,6 +289,11 @@ func runGenerateDirenvCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
 				"Use --envrc-dir to specify the directory where the .envrc file should be generated.")
 	}
 
+	if flags.printEnvrcContent {
+		return devbox.PrintEnvrcContent(
+			cmd.OutOrStdout(), devopt.EnvFlags(flags.envFlag), flags.config.path)
+	}
+
 	// Determine the directories for .envrc and config
 	configDir, envrcDir, err := determineDirenvDirs(flags.config.path, flags.envrcDir)
 	if err != nil {
@@ -300,10 +306,6 @@ func runGenerateDirenvCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
 		EnvFlags:  devopt.EnvFlags(flags.envFlag),
 	}
 
-	if flags.printEnvrcContent {
-		return devbox.PrintEnvrcContent(cmd.OutOrStdout(), generateOpts)
-	}
-
 	box, err := devbox.Open(&devopt.Opts{
 		Dir:         filepath.Join(envrcDir, configDir),
 		Environment: flags.config.environment,
@@ -317,7 +319,7 @@ func runGenerateDirenvCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
 		cmd.Context(), flags.force, generateOpts)
 }
 
-// Returns cononical paths for configDir and envrcDir. Both locations are relative to the current
+// Returns canonical paths for configDir and envrcDir. Both locations are relative to the current
 // working directory when provided to this function. However, since the config file will ultimately
 // be relative to the .envrc file, we need to determine the relative path from envrcDir to configDir.
 func determineDirenvDirs(configDir, envrcDir string) (string, string, error) {

internal/devbox/devbox.go

@@ -527,8 +527,8 @@ func (d *Devbox) GenerateDockerfile(ctx context.Context, generateOpts devopt.Gen
 	}))
 }
 
-func PrintEnvrcContent(w io.Writer, opts devopt.EnvrcOpts) error {
-	return generate.EnvrcContent(w, opts)
+func PrintEnvrcContent(w io.Writer, opts devopt.EnvFlags, configDir string) error {
+	return generate.EnvrcContent(w, opts, configDir)
 }
 
 // GenerateEnvrcFile generates a .envrc file that makes direnv integration convenient

internal/devbox/generate/devcontainer_util.go

@@ -165,8 +165,8 @@ func CreateEnvrc(ctx context.Context, opts devopt.EnvrcOpts) error {
 
 	// write content into file
 	return t.Execute(file, map[string]string{
-		"Flags": strings.Join(flags, " "),
-		"Dir":   opts.ConfigDir,
+		"EnvFlag":   strings.Join(flags, " "),
+		"ConfigDir": formatConfigDirArg(opts.ConfigDir),
 	})
 }
 
@@ -220,7 +220,7 @@ func (g *Options) getDevcontainerContent() *devcontainerObject {
 	return devcontainerContent
 }
 
-func EnvrcContent(w io.Writer, envFlags devopt.EnvrcOpts) error {
+func EnvrcContent(w io.Writer, envFlags devopt.EnvFlags, configDir string) error {
 	tmplName := "envrcContent.tmpl"
 	t := template.Must(template.ParseFS(tmplFS, "tmpl/"+tmplName))
 	envFlag := ""
@@ -229,9 +229,21 @@ func EnvrcContent(w io.Writer, envFlags devopt.EnvrcOpts) error {
 			envFlag += fmt.Sprintf("--env %s=%s ", k, v)
 		}
 	}
+
 	return t.Execute(w, map[string]string{
-		"EnvFlag": envFlag,
-		"EnvFile": envFlags.EnvFile,
-		"Dir":     envFlags.EnvrcDir,
+		"JSONPath":  filepath.Join(configDir, "devbox.json"),
+		"LockPath":  filepath.Join(configDir, "devbox.lock"),
+		"EnvFlag":   envFlag,
+		"EnvFile":   envFlags.EnvFile,
+		"ConfigDir": formatConfigDirArg(configDir),
 	})
 }
+
+func formatConfigDirArg(configDir string) string {
+	configDirArg := ""
+	if configDir != "" {
+		configDirArg = "--config " + configDir
+	}
+
+	return configDirArg
+}

internal/devbox/generate/tmpl/envrc.tmpl

@@ -3,7 +3,7 @@
 # Automatically sets up your devbox environment whenever you cd into this
 # directory via our direnv integration:
 
-eval "$(devbox generate direnv --print-envrc{{ if .Flags}} {{ .Flags }}{{ end }}{{ if .Dir }} --config {{ .Dir -}}{{ end }})"
+eval "$(devbox generate direnv --print-envrc{{ if .EnvFlag}} {{ .EnvFlag }}{{ end }}{{ if .ConfigDir }} {{ .ConfigDir }}{{ end }})"
 
 # check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
 # for more details

internal/devbox/generate/tmpl/envrcContent.tmpl

@@ -1,7 +1,6 @@
-{{define "DirPrefix"}}{{ if .Dir }}{{ .Dir }}/{{ end }}{{end}}
 use_devbox() {
-    watch_file {{template "DirPrefix" .}}devbox.json {{template "DirPrefix" .}}devbox.lock
-    eval "$(devbox shellenv --init-hook --install --no-refresh-alias {{ if .EnvFlag }}{{ .EnvFlag }}{{ end }} {{- if .Dir }}--config {{ .Dir -}}{{ end }})"
+    watch_file {{ .JSONPath }} {{ .LockPath }}
+    eval "$(devbox shellenv --init-hook --install --no-refresh-alias{{ if .EnvFlag}} {{ .EnvFlag }}{{ end }}{{ if .ConfigDir }} {{ .ConfigDir }}{{ end }})"
 }
 use devbox
 {{ if .EnvFile }}

testscripts/generate/direnv-envflag-config.test.txt

@@ -0,0 +1,7 @@
+# Testscript to validate generating the contents of the .envrc file.
+
+exec devbox init
+exec devbox generate direnv --env x=y
+exists .envrc
+exists devbox.json
+grep 'eval "\$\(devbox generate direnv --print-envrc --env x=y\)"' .envrc

testscripts/generate/direnv-envflag-envrcdir-config-subdir.test.txt

@@ -0,0 +1,9 @@
+# Testscript to validate generating a direnv .envrc in a specified location (./dir) that also
+# references a devbox config in another dir (./cfg) that is a subdir of the first.
+
+mkdir dir/cfg
+exec devbox init dir/cfg
+exists dir/cfg/devbox.json
+
+exec devbox generate direnv --envrc-dir dir --config dir/cfg --env x=y
+grep 'eval "\$\(devbox generate direnv --print-envrc --env x=y --config cfg\)"' dir/.envrc

testscripts/generate/direnv-envflag.test.txt

@@ -0,0 +1,10 @@
+# Testscript to validate generating the contents of the .envrc file.
+# Note that since --envrc-dir was NOT specified, the .envrc will be in the `dir` directory and
+# the config will be found there, which means the `--print-env` doesn't need to specify the dir.
+
+mkdir dir
+exec devbox init dir
+exec devbox generate direnv --env x=y --config dir
+exists dir/.envrc
+exists dir/devbox.json
+grep 'eval "\$\(devbox generate direnv --print-envrc --env x=y\)"' dir/.envrc

testscripts/generate/direnv-printenvrc.test.txt

@@ -4,5 +4,5 @@ exec devbox init
 exec devbox generate direnv --print-envrc
 cp stdout results.txt
 grep 'watch_file devbox.json devbox.lock' results.txt
-grep 'eval "\$\(devbox shellenv --init-hook --install --no-refresh-alias \)"' results.txt
+grep 'eval "\$\(devbox shellenv --init-hook --install --no-refresh-alias\)"' results.txt
 ! exists .envrc