✨ Add sparse commit #57

You can now perform a commit without including all the files by specifying them as args: 
For example: gut save myfile.go myfile.js

The function starts by verifying if all the paths are valid.
Then, all the logic is passed down to src/executor/commit.go:Commit()
If len(args)==0, it adds all the files to the staging area.
Otherwise it empties the staging area and adds only the specified files.

Author: julien040

cmd/save.go

@@ -29,8 +29,11 @@ import (
 
 // saveCmd represents the save command
 var saveCmd = &cobra.Command{
-	Use:     "save",
-	Short:   "Save (commit) your current work locally",
+	Use:   "save [files...]",
+	Short: "Save (commit) your current work locally",
+	Long: `Save (commit) your current work locally
+To commit only some files, pass them as arguments to the command.
+In case no files are passed as arguments, all files will be committed.`,
 	Aliases: []string{"s", "commit"},
 	Run:     controller.Save,
 }

src/controller/init.go

@@ -26,7 +26,7 @@ func Init(cmd *cobra.Command, args []string) {
 	}
 
 	associateProfileToPath(profile, wd)
-	_, err = executor.Commit(wd, "🎉 Initial commit from Gut")
+	_, err = executor.Commit(wd, "🎉 Initial commit from Gut", nil)
 	if err != nil {
 		exitOnError("Oups, something went wrong while creating the first commit", err)
 	}

src/controller/pathHelper.go

@@ -87,3 +87,27 @@ func isDirectoryEmpty(path string) (bool, error) {
 	}
 	return false, err
 }
+
+// Merge the path with the current directory if the path is relative
+// and return the absolute path
+// If the path is absolute, return the path
+func mergeLocalPathWithCurrDir(path string) string {
+	wd, err := os.Getwd()
+	if err != nil {
+		exitOnError("Sorry, I can't get the current directory 😓", err)
+	}
+	if filepath.IsAbs(path) {
+		return path
+	}
+	return filepath.Join(wd, path)
+}
+
+// Predicate function to check if the paths exist
+func validatePaths(paths []string) error {
+	for _, path := range paths {
+		if !checkIfPathExist(mergeLocalPathWithCurrDir(path)) {
+			return errors.New("the path " + path + " doesn't exist")
+		}
+	}
+	return nil
+}

src/controller/save.go

@@ -11,6 +11,7 @@ import (
 	"github.com/briandowns/spinner"
 	"github.com/julien040/gut/src/executor"
 	"github.com/julien040/gut/src/print"
+	"github.com/julien040/gut/src/prompt"
 	"github.com/spf13/cobra"
 )
 
@@ -108,6 +109,29 @@ func Save(cmd *cobra.Command, args []string) {
 	// Check if the user config is set
 	verifUserConfig(wd)
 
+	// Check if files have been passed as arguments
+	if len(args) > 0 {
+		err = validatePaths(args)
+		if err != nil {
+			exitOnError("I failed to validate the paths you entered", err)
+		}
+
+		message := "The following files will be saved:\n"
+		for _, arg := range args {
+			message += "\t- " + arg + "\n"
+		}
+		message += "Do you want to continue?"
+
+		res, err := prompt.InputBool(message, true)
+		if err != nil {
+			exitOnKnownError(errorReadInput, err)
+		}
+		if !res {
+			return
+		}
+
+	}
+
 	// Get the flag from the cmd
 	title := cmd.Flag("title").Value.String()
 	message := cmd.Flag("message").Value.String()
@@ -120,7 +144,7 @@ func Save(cmd *cobra.Command, args []string) {
 	sp.Start()
 
 	// Commit the changes
-	Result, err := executor.Commit(wd, commitMessage)
+	Result, err := executor.Commit(wd, commitMessage, args)
 	sp.Stop()
 	if err != nil {
 		exitOnError("Error while committing", err)

src/executor/commit.go

@@ -53,7 +53,49 @@ func AddAll(path string) error {
 	}
 }
 
-func Commit(path string, message string) (CommitResult, error) {
+// Remove all files from the staging area
+func RemoveAll(path string) error {
+	// Check if git is installed
+	isGitInstalled := IsGitInstalled()
+	if isGitInstalled {
+		// Run git add . to add all files using git
+		// This is a workaround for the fact that go-git does not support .gitignore
+		err := GitRemoveAll()
+
+		return err
+	} else {
+		repo, err := OpenRepo(path)
+		if err != nil {
+			return err
+		}
+		w, err := repo.Worktree()
+		if err != nil {
+			return err
+		}
+		// Replace the .gitignore file with the one in the repo
+		replaceGitIgnore(w, filepath.Join(path, ".gitignore"))
+
+		// Remove all files
+		err = w.Reset(&git.ResetOptions{
+			Mode: git.MixedReset,
+		})
+
+		return err
+	}
+}
+
+// Add a file to the staging area
+func AddIndexPath(w git.Worktree, path string) error {
+	// Add the file
+	_, err := w.Add(path)
+
+	return err
+}
+
+// Commit the changes
+// If no files are passed as arguments, all files will be committed
+// Otherwise, only the files passed as arguments will be committed
+func Commit(path string, message string, file []string) (CommitResult, error) {
 	repo, err := OpenRepo(path)
 	if err != nil {
 		return CommitResult{}, err
@@ -62,10 +104,26 @@ func Commit(path string, message string) (CommitResult, error) {
 	if err != nil {
 		return CommitResult{}, err
 	}
-	// Add all files
-	err = AddAll(path)
-	if err != nil {
-		return CommitResult{}, err
+
+	// If no files are passed as arguments, add all files
+	if len(file) == 0 {
+		// Add all files
+		err = AddAll(path)
+		if err != nil {
+			return CommitResult{}, err
+		}
+	} else {
+		// Add only the files passed as arguments
+		RemoveAll(path)
+		replaceGitIgnore(w, filepath.Join(path, ".gitignore"))
+
+		for _, v := range file {
+			// Add the file
+			err = AddIndexPath(*w, v)
+			if err != nil {
+				return CommitResult{}, err
+			}
+		}
 	}
 
 	status, err := w.Status()
@@ -87,7 +145,7 @@ func Commit(path string, message string) (CommitResult, error) {
 		}
 	}
 	hash, err := w.Commit(message, &git.CommitOptions{
-		All: true,
+		// All: true,
 	})
 	if err != nil {
 		return CommitResult{}, err

src/executor/git.go

@@ -205,6 +205,11 @@ func GitAddAll() error {
 	return runCommand("git", "add", ".")
 }
 
+// Remove all the files from the index
+func GitRemoveAll() error {
+	return runCommand("git", "reset", "HEAD", "--", ".")
+}
+
 // Diff the index with the HEAD and return true if there is no diff
 func GitDiffIndexHead() (bool, error) {
 	// If there is no diff, output will be empty