Merge pull request #1235 from wakatime/develop

Release v1.131.0

Author: alanhamlett

USAGE.md

@@ -33,6 +33,7 @@ exclude_unknown_project = false
 status_bar_enabled = true
 status_bar_coding_activity = true
 status_bar_hide_categories = false
+status_bar_max_categories = 0
 offline = true
 proxy = https://user:pass@localhost:8080
 no_ssl_verify = false
@@ -100,6 +101,7 @@ Notice how you have to include the exclude patterns from your main `~/.wakatime.
 | status_bar_enabled             | Turns on wakatime status bar for certain editors. | _bool_ | `true` |
 | status_bar_coding_activity     | Enables displaying Today's code stats in the status bar of some editors. When false, only the WakaTime icon is displayed in the status bar. | _bool_ | `true` |
 | status_bar_hide_categories     | When `true`, --today only displays the total code stats, never displaying Categories in the output. | _bool_ | `false` |
+| status_bar_max_categories      | When greater than zero, limits the number of categories displayed in the status bar. | _int_ | `0` |
 | offline                        | Enables saving code stats locally to ~/.wakatime/offline_heartbeats.bdb when offline, and syncing to the dashboard later when back online. | _bool_ | `true` |
 | proxy                          | Optional proxy configuration. Supports HTTPS, SOCKS and NTLM proxies. For ex: `https://user:pass@host:port`, `socks5://user:pass@host:port`, `domain\\user:pass` | _string_ | |
 | no_ssl_verify                  | Disables SSL certificate verification for HTTPS requests. By default, SSL certificates are verified. | _bool_ | `false` |

cmd/today/today.go

@@ -58,7 +58,7 @@ func Today(ctx context.Context, v *viper.Viper) (string, error) {
 		return "", fmt.Errorf("failed fetching today from api: %w", err)
 	}
 
-	output, err := summary.RenderToday(s, paramStatusBar.HideCategories, paramStatusBar.Output)
+	output, err := summary.RenderToday(s, paramStatusBar.HideCategories, paramStatusBar.MaxCategories, paramStatusBar.Output)
 	if err != nil {
 		return "", fmt.Errorf("failed generating today output: %s", err)
 	}

go.mod

@@ -35,7 +35,7 @@ require (
 	github.com/alecthomas/repr v0.4.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
-	github.com/go-viper/mapstructure/v2 v2.3.0 // indirect
+	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/golang/mock v1.6.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/juju/errors v1.0.0 // indirect

go.sum

@@ -32,6 +32,8 @@ github.com/go-viper/encoding/ini v0.1.1 h1:MVWY7B2XNw7lnOqHutGRc97bF3rP7omOdgjdM
 github.com/go-viper/encoding/ini v0.1.1/go.mod h1:Pfi4M2V1eAGJVZ5q6FrkHPhtHED2YgLlXhvgMVrB+YQ=
 github.com/go-viper/mapstructure/v2 v2.3.0 h1:27XbWsHIqhbdR5TIC911OfYvgSaW93HM+dX7970Q7jk=
 github.com/go-viper/mapstructure/v2 v2.3.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
+github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
 github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
 github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=

pkg/params/params.go

@@ -150,6 +150,10 @@ var (
 		FlagReadOrderFlagPrecedence:          {"today-hide-categories", "settings.status_bar_hide_categories"},
 		FlagReadOrderProjectConfigPrecedence: {"settings.status_bar_hide_categories", "today-hide-categories"},
 	}
+	todayMaxCategoriesOrder = map[FlagReadOrder][]string{
+		FlagReadOrderFlagPrecedence:          {"today-max-categories", "settings.status_bar_max_categories"},
+		FlagReadOrderProjectConfigPrecedence: {"settings.status_bar_max_categories", "today-max-categories"},
+	}
 )
 
 type (
@@ -262,6 +266,7 @@ type (
 	// StatusBar contains status bar related parameters.
 	StatusBar struct {
 		HideCategories bool
+		MaxCategories  int
 		Output         output.Output
 	}
 )
@@ -811,6 +816,21 @@ func LoadStatusBarParams(v *viper.Viper, order FlagReadOrder) (StatusBar, error)
 		hideCategories = val
 	}
 
+	maxCategories := 2
+
+	if maxCategoriesStr := vipertools.FirstNonEmptyString(v, todayMaxCategoriesOrder[order]...); maxCategoriesStr != "" {
+		val, err := strconv.Atoi(maxCategoriesStr)
+		if err != nil {
+			return StatusBar{}, fmt.Errorf("failed to parse today-max-categories: %s", err)
+		}
+
+		if val < 0 {
+			return StatusBar{}, fmt.Errorf("today-max-categories must be a positive number, got %d", val)
+		}
+
+		maxCategories = val
+	}
+
 	var out output.Output
 
 	if outputStr := vipertools.GetString(v, "output"); outputStr != "" {
@@ -824,6 +844,7 @@ func LoadStatusBarParams(v *viper.Viper, order FlagReadOrder) (StatusBar, error)
 
 	return StatusBar{
 		HideCategories: hideCategories,
+		MaxCategories:  maxCategories,
 		Output:         out,
 	}, nil
 }
@@ -1248,8 +1269,9 @@ func (p SanitizeParams) String() string {
 // String implements fmt.Stringer interface.
 func (p StatusBar) String() string {
 	return fmt.Sprintf(
-		"hide categories: %t, output: '%s'",
+		"hide categories: %t, max categories: %d, output: '%s'",
 		p.HideCategories,
+		p.MaxCategories,
 		p.Output,
 	)
 }

pkg/params/params_test.go

@@ -2919,6 +2919,46 @@ func TestLoadStatusBarParams_Output_Invalid(t *testing.T) {
 	assert.Equal(t, "failed to parse output: invalid output \"invalid\"", err.Error())
 }
 
+func TestLoadStatusBarParams_MaxCategories(t *testing.T) {
+	v := vipertools.MustNew()
+	v.Set("today-max-categories", 0)
+
+	params, err := paramspkg.LoadStatusBarParams(v, paramspkg.FlagReadOrderFlagPrecedence)
+	require.NoError(t, err)
+
+	assert.Equal(t, output.TextOutput, params.Output)
+}
+
+func TestLoadStatusBarParams_MaxCategoriesNegative(t *testing.T) {
+	v := vipertools.MustNew()
+	v.Set("today-max-categories", -1)
+
+	_, err := paramspkg.LoadStatusBarParams(v, paramspkg.FlagReadOrderFlagPrecedence)
+	require.Error(t, err)
+
+	assert.Equal(t, "today-max-categories must be a positive number, got -1", err.Error())
+}
+
+func TestLoadStatusBarParams_MaxCategoriesSetting(t *testing.T) {
+	v := vipertools.MustNew()
+	v.Set("settings.status_bar_max_categories", 1)
+
+	params, err := paramspkg.LoadStatusBarParams(v, paramspkg.FlagReadOrderFlagPrecedence)
+	require.NoError(t, err)
+
+	assert.Equal(t, output.TextOutput, params.Output)
+}
+
+func TestLoadStatusBarParams_MaxCategoriesNegativeSetting(t *testing.T) {
+	v := vipertools.MustNew()
+	v.Set("settings.status_bar_max_categories", -1)
+
+	_, err := paramspkg.LoadStatusBarParams(v, paramspkg.FlagReadOrderFlagPrecedence)
+	require.Error(t, err)
+
+	assert.Equal(t, "today-max-categories must be a positive number, got -1", err.Error())
+}
+
 func TestLoadHeartbeatParams_ExtraHeartbeats_StdinReadOnlyOnce(t *testing.T) {
 	r, w, err := os.Pipe()
 	require.NoError(t, err)
@@ -3159,7 +3199,7 @@ func TestStatusBar_String(t *testing.T) {
 
 	assert.Equal(
 		t,
-		"hide categories: true, output: 'json'",
+		"hide categories: true, max categories: 0, output: 'json'",
 		statusbar.String(),
 	)
 }

pkg/summary/summary.go

@@ -158,7 +158,7 @@ type (
 // RenderToday generates a text representation from summary of the current day.
 // If out is set to output.RawJSONOutput or output.JSONOutput, the summary will be marshaled to JSON.
 // Expects exactly one summary for the current day. Will return an error otherwise.
-func RenderToday(summary *Summary, hideCategories bool, out output.Output) (string, error) {
+func RenderToday(summary *Summary, hideCategories bool, maxCategories int, out output.Output) (string, error) {
 	if summary == nil {
 		return "", errors.New("no summary found for the current day")
 	}
@@ -179,7 +179,7 @@ func RenderToday(summary *Summary, hideCategories bool, out output.Output) (stri
 		}
 
 		s := simplified{
-			Text:            getText(summary, hideCategories),
+			Text:            getText(summary, hideCategories, maxCategories),
 			HasTeamFeatures: summary.HasTeamFeatures,
 		}
 
@@ -191,18 +191,31 @@ func RenderToday(summary *Summary, hideCategories bool, out output.Output) (stri
 		return string(data), nil
 	}
 
-	return getText(summary, hideCategories), nil
+	return getText(summary, hideCategories, maxCategories), nil
 }
 
-func getText(summary *Summary, hideCategories bool) string {
+func getText(summary *Summary, hideCategories bool, maxCategories int) string {
 	if len(summary.Data.Categories) < 2 || hideCategories {
 		return summary.Data.GrandTotal.Text
 	}
 
 	var outputs []string
-	for _, category := range summary.Data.Categories {
+
+	categories := summary.Data.Categories
+
+	if maxCategories > 0 && len(categories) > maxCategories {
+		categories = categories[:maxCategories]
+	}
+
+	for _, category := range categories {
 		outputs = append(outputs, fmt.Sprintf("%s %s", category.Text, category.Name))
 	}
 
-	return strings.Join(outputs, ", ")
+	result := strings.Join(outputs, ", ")
+
+	if maxCategories > 1 && len(summary.Data.Categories) > maxCategories {
+		result += "..."
+	}
+
+	return result
 }

pkg/summary/summary_test.go

@@ -14,26 +14,56 @@ import (
 
 func TestRenderToday(t *testing.T) {
 	tests := map[string]struct {
-		Output   output.Output
-		Expected string
+		Output        output.Output
+		MaxCategories int
+		Expected      string
 	}{
 		"text output": {
-			Output:   output.TextOutput,
-			Expected: "2 hrs 17 mins Coding, 7 secs Debugging",
+			Output:        output.TextOutput,
+			MaxCategories: 0,
+			Expected:      "2 hrs 17 mins Coding, 7 secs Debugging, 6 secs AI Coding",
+		},
+		"text output truncated 2": {
+			Output:        output.TextOutput,
+			MaxCategories: 2,
+			Expected:      "2 hrs 17 mins Coding, 7 secs Debugging...",
+		},
+		"text output truncated 1": {
+			Output:        output.TextOutput,
+			MaxCategories: 1,
+			Expected:      "2 hrs 17 mins Coding",
 		},
 		"json output": {
-			Output:   output.JSONOutput,
-			Expected: readFile(t, "testdata/statusbar_today_simplified.json"),
+			Output:        output.JSONOutput,
+			MaxCategories: 0,
+			Expected:      readFile(t, "testdata/statusbar_today_simplified.json"),
+		},
+		"json output truncated 2": {
+			Output:        output.JSONOutput,
+			MaxCategories: 2,
+			Expected:      readFile(t, "testdata/statusbar_today_simplified_truncated_2.json"),
+		},
+		"json output truncated 1": {
+			Output:        output.JSONOutput,
+			MaxCategories: 1,
+			Expected:      readFile(t, "testdata/statusbar_today_simplified_truncated_1.json"),
 		},
 		"raw json output": {
-			Output:   output.RawJSONOutput,
-			Expected: readFile(t, "testdata/statusbar_today.json"),
+			Output:        output.RawJSONOutput,
+			MaxCategories: 0,
+			Expected:      readFile(t, "testdata/statusbar_today.json"),
+		},
+		"raw json output not truncated": {
+			Output:        output.RawJSONOutput,
+			MaxCategories: 1,
+			Expected:      readFile(t, "testdata/statusbar_today.json"),
 		},
 	}
 
 	for name, test := range tests {
 		t.Run(name, func(t *testing.T) {
-			rendered, err := summary.RenderToday(testSummary(), false, test.Output)
+			s := testSummary()
+			rendered, err := summary.RenderToday(s, false, test.MaxCategories, test.Output)
 			require.NoError(t, err)
 
 			assert.Equal(t, test.Expected, rendered)
@@ -45,14 +75,32 @@ func TestRenderToday_OneCategory(t *testing.T) {
 	s := testSummary()
 	s.Data.Categories = s.Data.Categories[:1]
 
-	rendered, err := summary.RenderToday(s, false, output.TextOutput)
+	rendered, err := summary.RenderToday(s, false, 1, output.TextOutput)
 	require.NoError(t, err)
 
 	assert.Equal(t, "2 hrs 17 mins", rendered)
 }
 
+func TestRenderToday_OneCategoryTruncated(t *testing.T) {
+	s := testSummary()
+
+	rendered, err := summary.RenderToday(s, false, 1, output.TextOutput)
+	require.NoError(t, err)
+
+	assert.Equal(t, "2 hrs 17 mins Coding", rendered)
+}
+
+func TestRenderToday_Truncated(t *testing.T) {
+	s := testSummary()
+
+	rendered, err := summary.RenderToday(s, false, 2, output.TextOutput)
+	require.NoError(t, err)
+
+	assert.Equal(t, "2 hrs 17 mins Coding, 7 secs Debugging...", rendered)
+}
+
 func TestRenderToday_MultipleCategoriesHidden(t *testing.T) {
-	rendered, err := summary.RenderToday(testSummary(), true, output.TextOutput)
+	rendered, err := summary.RenderToday(testSummary(), true, 0, output.TextOutput)
 	require.NoError(t, err)
 
 	assert.Equal(t, "2 hrs 17 mins", rendered)
@@ -92,6 +140,17 @@ func testSummary() *summary.Summary {
 					Text:         "7 secs",
 					TotalSeconds: 7.100772,
 				},
+				{
+					Decimal:      "0.00",
+					Digital:      "0:00:06",
+					Hours:        0,
+					Minutes:      0,
+					Name:         "AI Coding",
+					Percent:      0.08,
+					Seconds:      6,
+					Text:         "6 secs",
+					TotalSeconds: 6.100772,
+				},
 			},
 			Dependencies: []summary.Dependency{
 				{

pkg/summary/testdata/statusbar_today.json

@@ -1 +1 @@
-{"cached_at":"2023-01-29T17:32:05Z","data":{"categories":[{"decimal":"2.28","digital":"2:17:36","hours":2,"minutes":17,"name":"Coding","percent":99.02,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234},{"decimal":"0.00","digital":"0:00:07","hours":0,"minutes":0,"name":"Debugging","percent":0.08,"seconds":7,"text":"7 secs","total_seconds":7.100772}],"dependencies":[{"decimal":"1.25","digital":"1:15:44","hours":1,"minutes":15,"name":"strings","percent":64.82,"seconds":44,"text":"1 hr 15 mins","total_seconds":4544.055638},{"decimal":"0.82","digital":"0:49:06","hours":0,"minutes":49,"name":"io","percent":35.18,"seconds":6,"text":"49 mins","total_seconds":2946.01205}],"editors":[{"decimal":"2.07","digital":"2:04:07","hours":2,"minutes":4,"name":"VS Code","percent":90.2,"seconds":7,"text":"2 hrs 4 mins","total_seconds":7447.112447},{"decimal":"0.22","digital":"0:13:29","hours":0,"minutes":13,"name":"Zsh-Wakatime-Sobolevn","percent":9.8,"seconds":29,"text":"13 mins","total_seconds":809.485787}],"grand_total":{"decimal":"2.28","digital":"2:17","hours":2,"minutes":17,"text":"2 hrs 17 mins","total_seconds":8256.598234},"languages":[{"decimal":"1.93","digital":"1:56:49","hours":1,"minutes":56,"name":"Go","percent":86.15,"seconds":49,"text":"1 hr 56 mins","total_seconds":7009.317188},{"decimal":"0.27","digital":"0:16:11","hours":0,"minutes":16,"name":"Other","percent":13.85,"seconds":11,"text":"16 mins","total_seconds":971.489169}],"machines":[{"decimal":"2.28","digital":"2:17:36","hours":2,"machine_name_id":"370471e8-b6dd-41aa-a94e-d4fb59a7db85","minutes":17,"name":"WakaMachine","percent":100,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234}],"operating_systems":[{"decimal":"2.28","digital":"2:17:36","hours":2,"minutes":17,"name":"Mac","percent":100,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234}],"projects":[{"decimal":"2.05","digital":"2:03:44","hours":2,"minutes":3,"name":"wakatime-cli","percent":97.53,"seconds":44,"text":"2 hrs 3 mins","total_seconds":7424.621273},{"decimal":"0.05","digital":"0:03:02","hours":0,"minutes":3,"name":"Terminal","percent":2.46,"seconds":2,"text":"3 mins","total_seconds":182.934009}],"range":{"date":"2023-01-29","end":"2023-01-30T02:59:59Z","start":"2023-01-29T03:00:00Z","text":"Sun Jan 29th 2023","timezone":"America/Sao_Paulo"}},"has_team_features":true}
+{"cached_at":"2023-01-29T17:32:05Z","data":{"categories":[{"decimal":"2.28","digital":"2:17:36","hours":2,"minutes":17,"name":"Coding","percent":99.02,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234},{"decimal":"0.00","digital":"0:00:07","hours":0,"minutes":0,"name":"Debugging","percent":0.08,"seconds":7,"text":"7 secs","total_seconds":7.100772},{"decimal":"0.00","digital":"0:00:06","hours":0,"minutes":0,"name":"AI Coding","percent":0.08,"seconds":6,"text":"6 secs","total_seconds":6.100772}],"dependencies":[{"decimal":"1.25","digital":"1:15:44","hours":1,"minutes":15,"name":"strings","percent":64.82,"seconds":44,"text":"1 hr 15 mins","total_seconds":4544.055638},{"decimal":"0.82","digital":"0:49:06","hours":0,"minutes":49,"name":"io","percent":35.18,"seconds":6,"text":"49 mins","total_seconds":2946.01205}],"editors":[{"decimal":"2.07","digital":"2:04:07","hours":2,"minutes":4,"name":"VS Code","percent":90.2,"seconds":7,"text":"2 hrs 4 mins","total_seconds":7447.112447},{"decimal":"0.22","digital":"0:13:29","hours":0,"minutes":13,"name":"Zsh-Wakatime-Sobolevn","percent":9.8,"seconds":29,"text":"13 mins","total_seconds":809.485787}],"grand_total":{"decimal":"2.28","digital":"2:17","hours":2,"minutes":17,"text":"2 hrs 17 mins","total_seconds":8256.598234},"languages":[{"decimal":"1.93","digital":"1:56:49","hours":1,"minutes":56,"name":"Go","percent":86.15,"seconds":49,"text":"1 hr 56 mins","total_seconds":7009.317188},{"decimal":"0.27","digital":"0:16:11","hours":0,"minutes":16,"name":"Other","percent":13.85,"seconds":11,"text":"16 mins","total_seconds":971.489169}],"machines":[{"decimal":"2.28","digital":"2:17:36","hours":2,"machine_name_id":"370471e8-b6dd-41aa-a94e-d4fb59a7db85","minutes":17,"name":"WakaMachine","percent":100,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234}],"operating_systems":[{"decimal":"2.28","digital":"2:17:36","hours":2,"minutes":17,"name":"Mac","percent":100,"seconds":36,"text":"2 hrs 17 mins","total_seconds":8256.598234}],"projects":[{"decimal":"2.05","digital":"2:03:44","hours":2,"minutes":3,"name":"wakatime-cli","percent":97.53,"seconds":44,"text":"2 hrs 3 mins","total_seconds":7424.621273},{"decimal":"0.05","digital":"0:03:02","hours":0,"minutes":3,"name":"Terminal","percent":2.46,"seconds":2,"text":"3 mins","total_seconds":182.934009}],"range":{"date":"2023-01-29","end":"2023-01-30T02:59:59Z","start":"2023-01-29T03:00:00Z","text":"Sun Jan 29th 2023","timezone":"America/Sao_Paulo"}},"has_team_features":true}

pkg/summary/testdata/statusbar_today_simplified.json

@@ -1 +1 @@
-{"text":"2 hrs 17 mins Coding, 7 secs Debugging","has_team_features":true}
+{"text":"2 hrs 17 mins Coding, 7 secs Debugging, 6 secs AI Coding","has_team_features":true}