[Bug] Creating Project with Git Commit adds .env file too in repository

[iankityadav]

What is the problem?

.env file should be excluded when making initial commit

Operating System

Windows

Architecture Version (x86, x64, arm, etc)

x64

Steps to reproduce

1. With this command it will make an initial commit including .env file
   go-blueprint create --name test --framework fiber --driver none --git commit

Relevant log output

[Ujstor]

Thanks for the suggestion. We just need to add .env to .gitignore

---

Update

The cause is more complex than just adding .env to .gitignore; I just assumed that was the issue.

[Ujstor]

program.go

// InitializeGit handles git repository initialization after all files are created
func (p *Project) InitializeGit(projectPath string) error {
	if p.GitOptions == flags.Skip {
		return nil
	}

	// Check git config
	nameSet, err := utils.CheckGitConfig("user.name")
	if err != nil {
		return err
	}
	if !nameSet {
		fmt.Println("user.name is not set in git config.")
		fmt.Println("Please set up git config before trying again.")
		panic("\nGIT CONFIG ISSUE: user.name is not set in git config.\n")
	}

	emailSet, err := utils.CheckGitConfig("user.email")
	if err != nil {
		return err
	}
	if !emailSet {
		fmt.Println("user.email is not set in git config.")
		fmt.Println("Please set up git config before trying again.")
		panic("\nGIT CONFIG ISSUE: user.email is not set in git config.\n")
	}

	// Initialize git repo 
	err = utils.ExecuteCmd("git", []string{"init"}, projectPath)
	if err != nil {
		log.Printf("Error initializing git repo: %v", err)
		return err
	}

	// Git add files - .gitignore is now properly written and will be respected
	err = utils.ExecuteCmd("git", []string{"add", "."}, projectPath)
	if err != nil {
		log.Printf("Error adding files to git repo: %v", err)
		return err
	}

	if p.GitOptions == flags.Commit {
		// Git commit files
		err = utils.ExecuteCmd("git", []string{"commit", "-m", "Initial commit"}, projectPath)
		if err != nil {
			log.Printf("Error committing files to git repo: %v", err)
			return err
		}
	}

	return nil
}

create.go

		projectPath := filepath.Join(project.AbsolutePath, utils.GetRootDir(project.ProjectName))
		err = project.InitializeGit(projectPath)
		if err != nil {
			if releaseErr := spinner.ReleaseTerminal(); releaseErr != nil {
				log.Printf("Problem releasing terminal: %v", releaseErr)
			}
			log.Printf("Problem initializing git repository. %v", err)
			cobra.CheckErr(textinput.CreateErrorInputModel(err).Err())
		}

[2bitburrito]

Hello, just wanted to follow up on this. I believe that my pull request above fixes this issue.

Interestingly, I just read about this exact issue in the book 100 Go Mistakes and How to Fix Them. Here is the excerpt from mistake 10.5.3 Not Closing Resources:

Furthermore, success while closing a writable os.File doesn’t guarantee that the file will be written on disk. The write can still live in a buffer on the filesystem and not be flushed on disk. If durability is a critical factor, we can use the Sync() method to commit a change. In that case, errors coming from Close can be safely ignored:

func writeToFile(filename string, content []byte) error {
    // Open file
 
    defer func() {
        _ = f.Close()       ❶
    }()
 
    _, err = f.Write(content)
    if err != nil {
        return err
    }
 
    return f.Sync()         ❷
}