Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add flag for json output #58

Merged
merged 1 commit into from
Apr 10, 2024
Merged

feat: add flag for json output #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,19 @@ The following configuration options are available in either as a command-line ar

--prompt-suffix or prompt_suffix
A suffix that is added to the end of the prompt.

--json
Output the results in JSON format. The keys of the JSON result are
branchInfo, branchStatus, color, promptPrefix, and promptSuffix.

Example:
{
"branchInfo": "main",
"branchStatus": "",
"color": "green",
"promptPrefix": "  ",
"promptSuffix": ""
}
```

#### Specifying colors
Expand Down
88 changes: 88 additions & 0 deletions integration/gps_test.go → integration/git_prompt_string_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
)

Expand Down Expand Up @@ -76,6 +77,93 @@ func TestGitPromptString(t *testing.T) {
{"configs", []string{}, fmt.Sprintf("\x1b[31m git-prompt-string error(unmarshal config): \"toml: expected character %s\"\x1b[0m", escapedEqualSign), []string{"GIT_PROMPT_STRING_CONFIG=invalid_syntax.toml"}, errors.New("exit status 1")},

{"norepo", []string{"--config=NONE"}, "", nil, nil},

// json
{
"bare",
[]string{"--config=NONE", "--json"},
strings.TrimSpace(`
{
"branchInfo": "BARE:main",
"branchStatus": "",
"color": "bright-black",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil,
},
{"no_upstream_remote", []string{"--config=NONE", "--json"}, strings.TrimSpace(`
{
"branchInfo": "main → mikesmithgh/test/main",
"branchStatus": "",
"color": "bright-black",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
{"git_dir", []string{"--config=NONE", "--json"}, strings.TrimSpace(`
{
"branchInfo": "GIT_DIR!",
"branchStatus": "",
"color": "bright-black",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
{"clean", []string{"--config=NONE", "--json", "--prompt-prefix=a"}, strings.TrimSpace(`
{
"branchInfo": "main",
"branchStatus": "",
"color": "green",
"promptPrefix": "a",
"promptSuffix": ""
}
`), nil, nil},
{"tag", []string{"--config=NONE", "--json", "--prompt-suffix=z"}, strings.TrimSpace(`
{
"branchInfo": "(v1.0.0)",
"branchStatus": "",
"color": "bright-black",
"promptPrefix": "  ",
"promptSuffix": "z"
}
`), nil, nil},
{"dirty", []string{"--config=NONE", "--json", "--color-dirty=CustomRed"}, strings.TrimSpace(`
{
"branchInfo": "main",
"branchStatus": " *",
"color": "CustomRed",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
{"conflict_diverged", []string{"--config=NONE", "--json"}, strings.TrimSpace(`
{
"branchInfo": "main",
"branchStatus": " ↕ ↑[1] ↓[1]",
"color": "yellow",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
{"untracked", []string{"--config=NONE", "--json"}, strings.TrimSpace(`
{
"branchInfo": "main",
"branchStatus": " *",
"color": "magenta",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
{"sparse", []string{"--config=NONE", "--json"}, strings.TrimSpace(`
{
"branchInfo": "main|SPARSE",
"branchStatus": "",
"color": "green",
"promptPrefix": "  ",
"promptSuffix": ""
}
`), nil, nil},
}

for _, test := range tests {
Expand Down
29 changes: 27 additions & 2 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package main

import (
"encoding/json"
"flag"
"fmt"
"os"
Expand Down Expand Up @@ -34,6 +35,7 @@ var (
colorUntracked = flag.String("color-untracked", "magenta", "The color of the prompt when there are untracked files in the\nworking directory.")
colorNoUpstream = flag.String("color-no-upstream", "bright-black", "The color of the prompt when there is no remote upstream branch.\n")
colorMerging = flag.String("color-merging", "blue", "The color of the prompt during a merge, rebase, cherry-pick,\nrevert, or bisect.")
jsonFormat = flag.Bool("json", false, "Output the results in JSON format. The keys of the JSON result are\nbranchInfo, branchStatus, color, promptPrefix, and promptSuffix.\n\nExample:\n{\n \"branchInfo\": \"main\",\n \"branchStatus\": \"\",\n \"color\": \"green\",\n \"promptPrefix\": \"  \",\n \"promptSuffix\": \"\"\n}")
versionFlag = flag.Bool("version", false, "Print version information for git-prompt-string.")
)

Expand Down Expand Up @@ -189,10 +191,33 @@ func main() {
if err != nil {
util.ErrMsg("branch info", err)
}
branchStatus, promptColor, err := gitRepo.BranchStatus(cfg)
branchStatus, statusColor, err := gitRepo.BranchStatus(cfg)
if err != nil {
util.ErrMsg("branch status", err)
}

fmt.Printf("%s%s%s%s%s%s", promptColor, cfg.PromptPrefix, branchInfo, branchStatus, cfg.PromptSuffix, resetColor)
if *jsonFormat {
color := ""
if !cfg.ColorDisabled {
color = statusColor
}
output := map[string]string{
"branchInfo": branchInfo,
"branchStatus": branchStatus,
"promptPrefix": cfg.PromptPrefix,
"promptSuffix": cfg.PromptSuffix,
"color": color,
}
jsonOutput, err := json.MarshalIndent(output, "", " ")
if err != nil {
util.ErrMsg("marshal json", err)
}
fmt.Print(string(jsonOutput))
} else {
promptColor, err := color.Color(strings.Split(statusColor, " ")...)
if err != nil {
util.ErrMsg("prompt color", err)
}
fmt.Printf("%s%s%s%s%s%s", promptColor, cfg.PromptPrefix, branchInfo, branchStatus, cfg.PromptSuffix, resetColor)
}
}
42 changes: 8 additions & 34 deletions pkg/git/repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"path/filepath"
"strings"

"github.com/mikesmithgh/git-prompt-string/pkg/color"
"github.com/mikesmithgh/git-prompt-string/pkg/config"
"github.com/mikesmithgh/git-prompt-string/pkg/util"
)
Expand Down Expand Up @@ -195,11 +194,7 @@ func (g *GitRepo) BranchStatus(cfg config.GitPromptStringConfig) (string, string
statusColor := ""

if g.IsInBareRepo || g.IsInGitDir {
c, err := color.Color(strings.Split(cfg.ColorNoUpstream, " ")...)
if err != nil {
util.ErrMsg("color no upstream", err)
}
return status, c, nil
return status, cfg.ColorNoUpstream, nil
}

cleanWorkingTree, err := HasCleanWorkingTree()
Expand All @@ -220,24 +215,15 @@ func (g *GitRepo) BranchStatus(cfg config.GitPromptStringConfig) (string, string
}

if cleanWorkingTree {
statusColor, err = color.Color(strings.Split(cfg.ColorClean, " ")...)
if err != nil {
util.ErrMsg("color clean", err)
}
statusColor = cfg.ColorClean
}

if ahead > 0 {
statusColor, err = color.Color(strings.Split(cfg.ColorDelta, " ")...)
if err != nil {
util.ErrMsg("color delta ahead", err)
}
statusColor = cfg.ColorDelta
status = fmt.Sprintf(cfg.AheadFormat, ahead)
}
if behind > 0 {
statusColor, err = color.Color(strings.Split(cfg.ColorDelta, " ")...)
if err != nil {
util.ErrMsg("color delta behind", err)
}
statusColor = cfg.ColorDelta
status = fmt.Sprintf(cfg.BehindFormat, behind)
}

Expand All @@ -246,32 +232,20 @@ func (g *GitRepo) BranchStatus(cfg config.GitPromptStringConfig) (string, string
}

if g.ShortSha == "" {
statusColor, err = color.Color(strings.Split(cfg.ColorNoUpstream, " ")...)
if err != nil {
util.ErrMsg("color no upstream", err)
}
statusColor = cfg.ColorNoUpstream
}

if g.PromptMergeStatus != "" {
statusColor, err = color.Color(strings.Split(cfg.ColorMerging, " ")...)
if err != nil {
util.ErrMsg("color merging", err)
}
statusColor = cfg.ColorMerging
}

if hasUntracked {
statusColor, err = color.Color(strings.Split(cfg.ColorUntracked, " ")...)
if err != nil {
util.ErrMsg("color untracked", err)
}
statusColor = cfg.ColorUntracked
status = fmt.Sprintf("*%s", status)
}

if !cleanWorkingTree && !hasUntracked {
statusColor, err = color.Color(strings.Split(cfg.ColorDirty, " ")...)
if err != nil {
util.ErrMsg("color dirty", err)
}
statusColor = cfg.ColorDirty
status = fmt.Sprintf("*%s", status)
}
if status != "" {
Expand Down
Loading