Merge pull request #1234 from wakatime/docs/max-category

Docs for max categories and allow zero value

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` |

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

@@ -824,7 +824,7 @@ func LoadStatusBarParams(v *viper.Viper, order FlagReadOrder) (StatusBar, error)
 			return StatusBar{}, fmt.Errorf("failed to parse today-max-categories: %s", err)
 		}
 
-		if val < 1 {
+		if val < 0 {
 			return StatusBar{}, fmt.Errorf("today-max-categories must be a positive number, got %d", val)
 		}
 

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)