Merge pull request #1593 from rsteube/git-notes

git: notes

completers/git_completer/cmd/notes_generated.go → completers/git_completer/cmd/notes.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 )
 
@@ -12,6 +13,8 @@ var notesCmd = &cobra.Command{
 }
 
 func init() {
+	carapace.Gen(notesCmd).Standalone()
+
 	notesCmd.Flags().String("ref", "", "use notes from <notes-ref>")
 	rootCmd.AddCommand(notesCmd)
 }

completers/git_completer/cmd/notes_add.go

@@ -0,0 +1,34 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_addCmd = &cobra.Command{
+	Use:   "add",
+	Short: "Add notes for a given object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_addCmd).Standalone()
+
+	notes_addCmd.Flags().Bool("allow-empty", false, "Allow an empty note object to be stored")
+	notes_addCmd.Flags().StringP("file", "F", "", "Take the note message from the given file")
+	notes_addCmd.Flags().StringP("message", "m", "", "Use the given note message")
+	notes_addCmd.Flags().StringP("reedit-message", "c", "", "Like -C, but with -c the editor is invoked")
+	notes_addCmd.Flags().StringP("reuse-message", "C", "", "Take the given blob object as the note message")
+	notesCmd.AddCommand(notes_addCmd)
+
+	carapace.Gen(notes_addCmd).FlagCompletion(carapace.ActionMap{
+		"file":           carapace.ActionFiles(),
+		"reedit-message": git.ActionRefs(git.RefOption{}.Default()),
+		"reuse-message":  git.ActionRefs(git.RefOption{}.Default()),
+	})
+
+	carapace.Gen(notes_addCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

completers/git_completer/cmd/notes_append.go

@@ -0,0 +1,35 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_appendCmd = &cobra.Command{
+	Use:   "append",
+	Short: "Append to the notes of an existing object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_appendCmd).Standalone()
+
+	notes_appendCmd.Flags().Bool("allow-empty", false, "Allow an empty note object to be stored")
+	notes_appendCmd.Flags().StringP("file", "F", "", "Take the note message from the given file")
+	notes_appendCmd.Flags().StringP("message", "m", "", "Use the given note message")
+	notes_appendCmd.Flags().StringP("reedit-message", "c", "", "Like -C, but with -c the editor is invoked")
+	notes_appendCmd.Flags().StringP("reuse-message", "C", "", "Take the given blob object as the note message")
+	notesCmd.AddCommand(notes_appendCmd)
+
+	carapace.Gen(notes_appendCmd).FlagCompletion(carapace.ActionMap{
+		"file":           carapace.ActionFiles(),
+		"reedit-message": git.ActionRefs(git.RefOption{}.Default()),
+		"reuse-message":  git.ActionRefs(git.RefOption{}.Default()),
+	})
+
+	carapace.Gen(notes_appendCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+
+}

completers/git_completer/cmd/notes_copy.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_copyCmd = &cobra.Command{
+	Use:   "copy",
+	Short: "Copy the notes for the first object onto the second object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_copyCmd).Standalone()
+
+	notes_copyCmd.Flags().BoolP("force", "f", false, "Overwrite existing notes")
+	notes_copyCmd.Flags().Bool("stdin", false, "Also read the object names to remove notes from the standard input")
+	notesCmd.AddCommand(notes_copyCmd)
+
+	carapace.Gen(notes_copyCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

completers/git_completer/cmd/notes_edit.go

@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_editCmd = &cobra.Command{
+	Use:   "edit",
+	Short: "Edit the notes for a given object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_editCmd).Standalone()
+
+	notes_editCmd.Flags().Bool("allow-empty", false, "Allow an empty note object to be stored")
+	notesCmd.AddCommand(notes_editCmd)
+
+	carapace.Gen(notes_editCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

completers/git_completer/cmd/notes_getRef.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/spf13/cobra"
+)
+
+var notes_getRefCmd = &cobra.Command{
+	Use:   "get-ref",
+	Short: "Print the current notes ref",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_getRefCmd).Standalone()
+
+	notesCmd.AddCommand(notes_getRefCmd)
+}

completers/git_completer/cmd/notes_list.go

@@ -0,0 +1,23 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_listCmd = &cobra.Command{
+	Use:   "list",
+	Short: "List the notes object for a given object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_listCmd).Standalone()
+
+	notesCmd.AddCommand(notes_listCmd)
+
+	carapace.Gen(notes_listCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

completers/git_completer/cmd/notes_merge.go

@@ -0,0 +1,34 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_mergeCmd = &cobra.Command{
+	Use:   "merge",
+	Short: "Merge the given notes ref into the current notes ref",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_mergeCmd).Standalone()
+
+	notes_mergeCmd.Flags().Bool("abort", false, "Abort/reset an in-progress git notes merge")
+	notes_mergeCmd.Flags().Bool("commit", false, "Finalize an in-progress git notes merge")
+	notes_mergeCmd.Flags().BoolP("quiet", "q", false, "When merging notes, operate quietly")
+	notes_mergeCmd.Flags().StringP("strategy", "s", "", "Resolve notes conflicts using the given strategy")
+	notes_mergeCmd.Flags().BoolP("verbose", "v", false, "When merging notes, be more verbose")
+	notesCmd.AddCommand(notes_mergeCmd)
+
+	notes_mergeCmd.MarkFlagsMutuallyExclusive("abort", "commit", "strategy")
+
+	carapace.Gen(notes_mergeCmd).FlagCompletion(carapace.ActionMap{
+		"strategy": git.ActionNotesMergeStrategies(),
+	})
+
+	carapace.Gen(notes_mergeCmd).PositionalCompletion(
+		git.ActionNotes(),
+	)
+}

completers/git_completer/cmd/notes_prune.go

@@ -0,0 +1,20 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/spf13/cobra"
+)
+
+var notes_pruneCmd = &cobra.Command{
+	Use:   "prune",
+	Short: "Remove all notes for non-existing/unreachable objects",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_pruneCmd).Standalone()
+
+	notes_pruneCmd.Flags().BoolP("dry-run", "n", false, "Do not remove anything, just report")
+	notes_pruneCmd.Flags().BoolP("verbose", "v", false, "When merging notes, be more verbose")
+	notesCmd.AddCommand(notes_pruneCmd)
+}

completers/git_completer/cmd/notes_remove.go

@@ -0,0 +1,25 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_removeCmd = &cobra.Command{
+	Use:   "remove",
+	Short: "Remove the notes for given objects",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_removeCmd).Standalone()
+
+	notes_removeCmd.Flags().Bool("ignore-missing", false, "Do not consider it an error to request removing non existing notes")
+	notes_removeCmd.Flags().Bool("stdin", false, "Also read the object names to remove notes from the standard input")
+	notesCmd.AddCommand(notes_removeCmd)
+
+	carapace.Gen(notes_removeCmd).PositionalAnyCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

completers/git_completer/cmd/notes_show.go

@@ -0,0 +1,23 @@
+package cmd
+
+import (
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/actions/tools/git"
+	"github.com/spf13/cobra"
+)
+
+var notes_showCmd = &cobra.Command{
+	Use:   "show",
+	Short: "Show the notes for a given object",
+	Run:   func(cmd *cobra.Command, args []string) {},
+}
+
+func init() {
+	carapace.Gen(notes_showCmd).Standalone()
+
+	notesCmd.AddCommand(notes_showCmd)
+
+	carapace.Gen(notes_showCmd).PositionalCompletion(
+		git.ActionRefs(git.RefOption{}.Default()),
+	)
+}

pkg/actions/tools/git/action.go

@@ -21,6 +21,7 @@ type RefOption struct {
 	HeadCommits    int
 	Tags           bool
 	Stashes        bool
+	Notes          bool
 }
 
 func (o RefOption) Default() RefOption {
@@ -30,6 +31,7 @@ func (o RefOption) Default() RefOption {
 	o.HeadCommits = 100
 	o.Tags = true
 	o.Stashes = true
+	o.Notes = false
 	return o
 
 }
@@ -66,6 +68,10 @@ func ActionRefs(refOption RefOption) carapace.Action {
 			batch = append(batch, ActionStashes())
 		}
 
+		if refOption.Notes {
+			batch = append(batch, ActionNotes())
+		}
+
 		return batch.ToA()
 
 	})

pkg/actions/tools/git/commit.go

@@ -15,7 +15,7 @@ import (
 //	HEAD~1 (commit message)
 func ActionHeadCommits(limit int) carapace.Action {
 	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
-		args := []string{"log", "--pretty=tformat:%h   %<(64,trunc)%s", "--max-count", strconv.Itoa(limit)}
+		args := []string{"log", "--no-notes", "--pretty=tformat:%h   %<(64,trunc)%s", "--max-count", strconv.Itoa(limit)}
 		return carapace.ActionExecCommand("git", args...)(func(output []byte) carapace.Action {
 			lines := strings.Split(string(output), "\n")
 
@@ -38,7 +38,7 @@ func ActionHeadCommits(limit int) carapace.Action {
 //	123456B ((refname) commit message)
 func ActionRecentCommits(limit int) carapace.Action {
 	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
-		args := []string{"log", "--all", "--no-merges", "--pretty=tformat:%h   %<(64,trunc)%s", "--max-count", strconv.Itoa(limit)}
+		args := []string{"log", "--exclude=refs/notes/*", "--all", "--no-merges", "--pretty=tformat:%h   %<(64,trunc)%s", "--max-count", strconv.Itoa(limit)}
 		return carapace.ActionExecCommand("git", args...)(func(output []byte) carapace.Action {
 			lines := strings.Split(string(output), "\n")
 

pkg/actions/tools/git/note.go

@@ -0,0 +1,31 @@
+package git
+
+import (
+	"strings"
+
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/pkg/styles"
+)
+
+// ActionNotes completes notes
+
+func ActionNotes() carapace.Action {
+	return carapace.ActionExecCommand("git", "log", "--pretty=format:%h\n%<(64,trunc)%s", "--show-notes")(func(output []byte) carapace.Action {
+		lines := strings.Split(string(output), "\n")
+		return carapace.ActionValuesDescribed(lines...).Style(styles.Git.Note)
+	}).Tag("notes")
+}
+
+// ActionNotesMergeStrategies completes notes merge strategies
+//
+//	ours (favor the local version)
+//	theirs (favor the remote version)
+func ActionNotesMergeStrategies() carapace.Action {
+	return carapace.ActionValuesDescribed(
+		"manual", "check out conflicting notes in a special work tree",
+		"ours", "favor the local version",
+		"theirs", "favor the remote version",
+		"union", "concatenate the local and remote versions",
+		"cat_sort_uniq", "similar to \"union\", but also sorts removes duplicate lines",
+	)
+}

pkg/styles/git.go

@@ -6,12 +6,14 @@ var Git = struct {
 	Branch     string `desc:"git branches"`
 	Commit     string `desc:"git commits"`
 	HeadCommit string `desc:"git HEAD~ commits"`
+	Note       string `desc:"git notes"`
 	Stash      string `desc:"git stashes"`
 	Tag        string `desc:"git tags"`
 }{
 	Branch:     style.Blue,
 	Commit:     style.Default,
 	HeadCommit: style.Bold,
+	Note:       style.Cyan,
 	Stash:      style.Green,
 	Tag:        style.Yellow,
 }