Merge branch 'main' into landau/fix-prerelease-job

Author: mikeland73

devbox.go

@@ -27,11 +27,12 @@ type Devbox interface {
 	Generate() error
 	GenerateDevcontainer(force bool) error
 	GenerateDockerfile(force bool) error
-	GenerateEnvrc(force bool, source string) error
+	GenerateEnvrcFile(force bool) error
 	Info(pkg string, markdown bool) error
 	ListScripts() []string
 	PrintEnv(ctx context.Context, includeHooks bool) (string, error)
 	PrintGlobalList() error
+	PrintEnvrcContent(w io.Writer) error
 	PullGlobal(path string) error
 	// Remove removes Nix packages from the config so that it no longer exists in
 	// the devbox environment.

internal/boxcli/featureflag/lockfile.go

@@ -1,3 +1,3 @@
 package featureflag
 
-var LockFile = disabled("LOCKFILE")
+var LockFile = enabled("LOCKFILE")

internal/boxcli/generate.go

@@ -4,8 +4,6 @@
 package boxcli
 
 import (
-	"os"
-
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 
@@ -14,9 +12,10 @@ import (
 )
 
 type generateCmdFlags struct {
-	config         configFlags
-	force          bool
-	githubUsername string
+	config            configFlags
+	force             bool
+	printEnvrcContent bool
+	githubUsername    string
 }
 
 func generateCmd() *cobra.Command {
@@ -98,6 +97,11 @@ func direnvCmd() *cobra.Command {
 	}
 	command.Flags().BoolVarP(
 		&flags.force, "force", "f", false, "force overwrite existing files")
+	command.Flags().BoolVarP(
+		&flags.printEnvrcContent, "print-envrc", "p", false, "output contents of devbox configuration to use in .envrc")
+	// this command marks a flag as hidden. Error handling for it is not necessary.
+	_ = command.Flags().MarkHidden("print-envrc")
+
 	flags.config.register(command)
 	return command
 }
@@ -125,7 +129,7 @@ func sshConfigCmd() *cobra.Command {
 
 func runGenerateCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
 	// Check the directory exists.
-	box, err := devbox.Open(flags.config.path, os.Stdout)
+	box, err := devbox.Open(flags.config.path, cmd.ErrOrStderr())
 	if err != nil {
 		return errors.WithStack(err)
 	}
@@ -137,7 +141,10 @@ func runGenerateCmd(cmd *cobra.Command, flags *generateCmdFlags) error {
 	case "dockerfile":
 		return box.GenerateDockerfile(flags.force)
 	case "direnv":
-		return box.GenerateEnvrc(flags.force, "generate")
+		if flags.printEnvrcContent {
+			return box.PrintEnvrcContent(cmd.OutOrStdout())
+		}
+		return box.GenerateEnvrcFile(flags.force)
 	}
 	return nil
 }

internal/boxcli/init.go

@@ -32,10 +32,6 @@ func runInitCmd(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return errors.WithStack(err)
 	}
-	box, err := devbox.Open(path, cmd.ErrOrStderr())
-	if err != nil {
-		return errors.WithStack(err)
-	}
 
-	return errors.WithStack(box.GenerateEnvrc(false, "init"))
+	return nil
 }

internal/envir/util.go

@@ -47,3 +47,14 @@ func IsCI() bool {
 	ci, err := strconv.ParseBool(os.Getenv("CI"))
 	return ci && err == nil
 }
+
+// GetValueOrDefault gets the value of an environment variable.
+// If it's empty, it will return the given default value instead.
+func GetValueOrDefault(key, def string) string {
+	val := os.Getenv(key)
+	if val == "" {
+		val = def
+	}
+
+	return val
+}

internal/impl/devbox.go

@@ -15,10 +15,9 @@ import (
 	"runtime/trace"
 	"strings"
 	"text/tabwriter"
+	"text/template"
 
-	"github.com/AlecAivazis/survey/v2"
 	"github.com/fatih/color"
-	"github.com/mattn/go-isatty"
 	"github.com/pkg/errors"
 	"github.com/samber/lo"
 	"golang.org/x/exp/slices"
@@ -42,6 +41,7 @@ import (
 	"go.jetpack.io/devbox/internal/searcher"
 	"go.jetpack.io/devbox/internal/services"
 	"go.jetpack.io/devbox/internal/telemetry"
+	"go.jetpack.io/devbox/internal/ux"
 	"go.jetpack.io/devbox/internal/wrapnix"
 )
 
@@ -142,7 +142,12 @@ func (d *Devbox) ConfigHash() (string, error) {
 }
 
 func (d *Devbox) NixPkgsCommitHash() string {
-	return d.cfg.Nixpkgs.Commit
+	if hash := d.cfg.Nixpkgs.Commit; hash != "" {
+		return hash
+	}
+	// Tests don't have a nixpkgs commit, so we use the default one.
+	// Not sure if users ever run into this.
+	return plansdk.DefaultNixpkgsCommit
 }
 
 func (d *Devbox) ShellPlan() (*plansdk.ShellPlan, error) {
@@ -197,10 +202,10 @@ func (d *Devbox) Shell(ctx context.Context) error {
 		return err
 	}
 
-	shellStartTime := os.Getenv(envir.DevboxShellStartTime)
-	if shellStartTime == "" {
-		shellStartTime = telemetry.UnixTimestampFromTime(telemetry.CommandStartTime())
-	}
+	shellStartTime := envir.GetValueOrDefault(
+		envir.DevboxShellStartTime,
+		telemetry.UnixTimestampFromTime(telemetry.CommandStartTime()),
+	)
 
 	opts := []ShellOption{
 		WithHooksFilePath(d.scriptPath(hooksFilename)),
@@ -383,8 +388,15 @@ func (d *Devbox) GenerateDockerfile(force bool) error {
 	return errors.WithStack(generate.CreateDockerfile(tmplFS, d.projectDir))
 }
 
-// GenerateEnvrc generates a .envrc file that makes direnv integration convenient
-func (d *Devbox) GenerateEnvrc(force bool, source string) error {
+func (d *Devbox) PrintEnvrcContent(w io.Writer) error {
+	tmplName := "envrcContent.tmpl"
+	t := template.Must(template.ParseFS(tmplFS, "tmpl/"+tmplName))
+	// write content into file
+	return t.Execute(w, nil)
+}
+
+// GenerateEnvrcFile generates a .envrc file that makes direnv integration convenient
+func (d *Devbox) GenerateEnvrcFile(force bool) error {
 	ctx, task := trace.NewTask(context.Background(), "devboxGenerateEnvrc")
 	defer task.End()
 
@@ -397,48 +409,31 @@ func (d *Devbox) GenerateEnvrc(force bool, source string) error {
 		)
 	}
 	// confirm .envrc doesn't exist and don't overwrite an existing .envrc
-	if cmdutil.Exists("direnv") {
-		// prompt for direnv allow
-		var result string
-		isInteractiveMode := isatty.IsTerminal(os.Stdin.Fd())
-		if isInteractiveMode {
-			prompt := &survey.Input{
-				Message: "Do you want to enable direnv integration for this devbox project? [y/N]",
-			}
-			err := survey.AskOne(prompt, &result)
-			if err != nil {
-				return errors.WithStack(err)
-			}
-		}
-
-		if strings.ToLower(result) == "y" || !isInteractiveMode || source == "generate" {
-			if err := nix.EnsureNixInstalled(
-				d.writer, func() *bool { return lo.ToPtr(false) },
-			); err != nil {
-				return err
-			}
-
-			// generate all shell files to ensure we can refer to them in the .envrc script
-			if err := d.ensurePackagesAreInstalled(ctx, ensure); err != nil {
-				return err
-			}
+	if err := nix.EnsureNixInstalled(
+		d.writer, func() *bool { return lo.ToPtr(false) },
+	); err != nil {
+		return err
+	}
 
-			// .envrc file creation
-			err := generate.CreateEnvrc(tmplFS, d.projectDir)
-			if err != nil {
-				return errors.WithStack(err)
-			}
-		}
+	// generate all shell files to ensure we can refer to them in the .envrc script
+	if err := d.ensurePackagesAreInstalled(ctx, ensure); err != nil {
+		return err
+	}
 
-		if strings.ToLower(result) == "y" || !isInteractiveMode {
-			cmd := exec.Command("direnv", "allow")
-			err := cmd.Run()
-			if err != nil {
-				return errors.WithStack(err)
-			}
+	// .envrc file creation
+	err := generate.CreateEnvrc(tmplFS, d.projectDir)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+	ux.Fsuccess(d.writer, "generated .envrc file\n")
+	if cmdutil.Exists("direnv") {
+		cmd := exec.Command("direnv", "allow")
+		err := cmd.Run()
+		if err != nil {
+			return errors.WithStack(err)
 		}
+		ux.Fsuccess(d.writer, "ran `direnv allow`\n")
 	}
-
 	return nil
 }
 

internal/impl/tmpl/envrc.tmpl

@@ -1,15 +1,7 @@
 # Automatically sets up your devbox environment whenever you cd into this
 # directory via our direnv integration:
 
-use_devbox() {
-    watch_file devbox.json
-    if [ -f .devbox/gen/flake/flake.nix ]; then
-        DEVBOX_SHELL_ENABLED_BACKUP=$DEVBOX_SHELL_ENABLED
-        eval "$(devbox shellenv --init-hook)"
-        export DEVBOX_SHELL_ENABLED=$DEVBOX_SHELL_ENABLED_BACKUP
-    fi
-}
-use devbox
+eval "$(devbox generate direnv --print-envrc)"
 
 # check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
 # for more details

internal/impl/tmpl/envrcContent.tmpl

@@ -0,0 +1,5 @@
+use_devbox() {
+    watch_file devbox.json
+    eval "$(devbox shellenv --init-hook)"
+}
+use devbox

internal/initrec/recommenders/javascript/nodejs.go

@@ -20,8 +20,7 @@ type Recommender struct {
 var _ recommenders.Recommender = (*Recommender)(nil)
 
 func (r *Recommender) IsRelevant() bool {
-	packageJSONPath := filepath.Join(r.SrcDir, "package.json")
-	return fileutil.Exists(packageJSONPath)
+	return fileutil.Exists(filepath.Join(r.SrcDir, "package.json"))
 }
 
 func (r *Recommender) Packages() []string {
@@ -74,8 +73,7 @@ func (r *Recommender) nodeVersion(project *nodeProject) *plansdk.Version {
 }
 
 func (r *Recommender) packageManager() string {
-	yarnPkgLockPath := filepath.Join(r.SrcDir, "yarn.lock")
-	if fileutil.Exists(yarnPkgLockPath) {
+	if fileutil.Exists(filepath.Join(r.SrcDir, "yarn.lock")) {
 		return "yarn"
 	}
 	return "npm"

internal/initrec/recommenders/python/python_poetry.go

@@ -39,7 +39,7 @@ func (r *RecommenderPoetry) Packages() []string {
 // TODO: This can be generalized to all python planners
 func (r *RecommenderPoetry) PythonVersion() *plansdk.Version {
 	defaultVersion, _ := plansdk.NewVersion("3.10.6")
-	project := r.PyProject()
+	project := r.pyProject()
 
 	if project == nil {
 		return defaultVersion
@@ -67,7 +67,7 @@ type pyProject struct {
 	} `toml:"tool"`
 }
 
-func (r *RecommenderPoetry) PyProject() *pyProject {
+func (r *RecommenderPoetry) pyProject() *pyProject {
 	pyProjectPath := filepath.Join(r.SrcDir, "pyproject.toml")
 	content, err := os.ReadFile(pyProjectPath)
 	if err != nil {