Method GenerateEnvrcFile

internal/devbox/devbox.go:553–593

GenerateEnvrcFile generates a .envrc file that makes direnv integration convenient

(ctx context.Context, opts devopt.EnvrcOpts)

// GenerateEnvrcFile generates a .envrc file that makes direnv integration convenient
func (d *Devbox) GenerateEnvrcFile(ctx context.Context, opts devopt.EnvrcOpts) error {
	ctx, task := trace.NewTask(ctx, "devboxGenerateEnvrc")
	defer task.End()

	// If no envrcDir was specified, use the configDir. This is for backward compatibility
	// where the .envrc was placed in the same location as specified by --config. Note that
	// if that is also blank, the .envrc will be generated in the current working directory.
	if opts.EnvrcDir == "" {
		opts.EnvrcDir = opts.ConfigDir
	}

	envrcFilePath := filepath.Join(opts.EnvrcDir, ".envrc")
	filesExist := fileutil.Exists(envrcFilePath)
	if !opts.Force && filesExist {
		return usererr.New(
			"A .envrc is already present in %q. Remove it or use --force to overwrite it.",
			opts.EnvrcDir,
		)
	}

	// generate all shell files to ensure we can refer to them in the .envrc script
	if err := d.ensureStateIsUpToDate(ctx, ensure); err != nil {
		return err
	}

	// .envrc file creation
	err := generate.CreateEnvrc(ctx, opts)
	if err != nil {
		return errors.WithStack(err)
	}
	ux.Fsuccessf(d.stderr, "generated .envrc file in %q.\n", opts.EnvrcDir)
	if cmdutil.Exists("direnv") {
		cmd := exec.Command("direnv", "allow", opts.EnvrcDir)
		err := cmd.Run()
		if err != nil {
			return errors.WithStack(err)
		}
		ux.Fsuccessf(d.stderr, "ran `direnv allow %s`\n", opts.EnvrcDir)
	}
	return nil
}

// saveCfg writes the config file to the devbox directory.
func (d *Devbox) saveCfg() error {