chore: improve CLI help output

Author: ldez

docs/data/cli_help.json

@@ -21,7 +21,7 @@ func newCacheCommand() *cacheCommand {
 
 	cacheCmd := &cobra.Command{
 		Use:   "cache",
-		Short: "Cache control and information",
+		Short: "Cache control and information.",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			return cmd.Help()

pkg/commands/cache.go

@@ -42,7 +42,7 @@ func newConfigCommand(log logutils.Log, info BuildInfo) *configCommand {
 
 	configCmd := &cobra.Command{
 		Use:   "config",
-		Short: "Config file information",
+		Short: "Configuration file information and verification.",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			return cmd.Help()
@@ -52,7 +52,7 @@ func newConfigCommand(log logutils.Log, info BuildInfo) *configCommand {
 
 	verifyCommand := &cobra.Command{
 		Use:               "verify",
-		Short:             "Verify configuration against JSON schema",
+		Short:             "Verify configuration against JSON schema.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.executeVerify,
@@ -62,7 +62,7 @@ func newConfigCommand(log logutils.Log, info BuildInfo) *configCommand {
 
 	pathCommand := &cobra.Command{
 		Use:               "path",
-		Short:             "Print used config path",
+		Short:             "Print used configuration path.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.executePath,

pkg/commands/config.go

@@ -26,7 +26,7 @@ func newCustomCommand(logger logutils.Log) *customCommand {
 
 	customCmd := &cobra.Command{
 		Use:          "custom",
-		Short:        "Build a version of golangci-lint with custom linters",
+		Short:        "Build a version of golangci-lint with custom linters.",
 		Args:         cobra.NoArgs,
 		PreRunE:      c.preRunE,
 		RunE:         c.runE,

pkg/commands/custom.go

@@ -50,7 +50,7 @@ func newFmtCommand(logger logutils.Log, info BuildInfo) *fmtCommand {
 
 	fmtCmd := &cobra.Command{
 		Use:               "fmt",
-		Short:             "Format Go source files",
+		Short:             "Format Go source files.",
 		RunE:              c.execute,
 		PreRunE:           c.preRunE,
 		PersistentPreRunE: c.persistentPreRunE,

pkg/commands/fmt.go

@@ -47,7 +47,7 @@ func newFormattersCommand(logger logutils.Log) *formattersCommand {
 
 	formattersCmd := &cobra.Command{
 		Use:               "formatters",
-		Short:             "List current formatters configuration",
+		Short:             "List current formatters configuration.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.execute,

pkg/commands/formatters.go

@@ -31,7 +31,7 @@ func newHelpCommand(logger logutils.Log) *helpCommand {
 
 	helpCmd := &cobra.Command{
 		Use:   "help",
-		Short: "Help",
+		Short: "Display extra help",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			return cmd.Help()
@@ -40,7 +40,7 @@ func newHelpCommand(logger logutils.Log) *helpCommand {
 
 	lintersCmd := &cobra.Command{
 		Use:               "linters",
-		Short:             "Help about linters",
+		Short:             "Display help for linters.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.lintersExecute,
@@ -56,7 +56,7 @@ func newHelpCommand(logger logutils.Log) *helpCommand {
 
 	formattersCmd := &cobra.Command{
 		Use:               "formatters",
-		Short:             "Help about formatters",
+		Short:             "Display help for formatters.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.formattersExecute,

pkg/commands/help.go

@@ -47,7 +47,7 @@ func newLintersCommand(logger logutils.Log) *lintersCommand {
 
 	lintersCmd := &cobra.Command{
 		Use:               "linters",
-		Short:             "List current linters configuration",
+		Short:             "List current linters configuration.",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
 		RunE:              c.execute,

pkg/commands/linters.go

@@ -51,7 +51,7 @@ func newMigrateCommand(log logutils.Log, info BuildInfo) *migrateCommand {
 
 	migrateCmd := &cobra.Command{
 		Use:               "migrate",
-		Short:             "Migrate configuration file from v1 to v2",
+		Short:             "Migrate configuration file from v1 to v2.",
 		SilenceUsage:      true,
 		SilenceErrors:     true,
 		Args:              cobra.NoArgs,

pkg/commands/migrate.go

@@ -111,7 +111,7 @@ func newRunCommand(logger logutils.Log, info BuildInfo) *runCommand {
 
 	runCmd := &cobra.Command{
 		Use:                "run",
-		Short:              "Run the linters",
+		Short:              "Lint the code.",
 		Run:                c.execute,
 		PreRunE:            c.preRunE,
 		PostRun:            c.postRun,