From d4c1d3ac3a0d67c5217a5049a02b5e932cf5f981 Mon Sep 17 00:00:00 2001 From: agrasth Date: Fri, 6 Mar 2026 16:05:12 +0530 Subject: [PATCH] Fixed Minor Violations by UX writing Audit of Jfrog CLI --- artifactory/cli.go | 5 +++-- docs/artifactory/gocommand/help.go | 2 +- docs/artifactory/groupcreate/help.go | 2 +- docs/artifactory/groupdelete/help.go | 2 +- docs/artifactory/mvn/help.go | 2 +- docs/artifactory/terraform/help.go | 2 +- docs/artifactory/transferconfig/help.go | 2 +- docs/artifactory/twine/help.go | 2 +- docs/artifactory/usercreate/help.go | 2 +- docs/artifactory/userscreate/help.go | 2 +- docs/general/summary/help.go | 2 +- docs/plugin/publish/help.go | 2 +- main.go | 18 +++++++++--------- main_test.go | 2 +- 14 files changed, 24 insertions(+), 23 deletions(-) diff --git a/artifactory/cli.go b/artifactory/cli.go index db13c4cbf..75076fab6 100644 --- a/artifactory/cli.go +++ b/artifactory/cli.go @@ -3,11 +3,12 @@ package artifactory import ( "errors" "fmt" + "os" + "strings" + "github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/python" "github.com/jfrog/jfrog-cli/docs/artifactory/cocoapodsconfig" "github.com/jfrog/jfrog-cli/docs/artifactory/swiftconfig" - "os" - "strings" "github.com/jfrog/jfrog-cli/utils/accesstoken" diff --git a/docs/artifactory/gocommand/help.go b/docs/artifactory/gocommand/help.go index 00cdd91e5..e4fcb91ea 100644 --- a/docs/artifactory/gocommand/help.go +++ b/docs/artifactory/gocommand/help.go @@ -3,7 +3,7 @@ package gocommand var Usage = []string{"rt go [command options]"} func GetDescription() string { - return "Runs go." + return "Run go" } func GetArguments() string { diff --git a/docs/artifactory/groupcreate/help.go b/docs/artifactory/groupcreate/help.go index bdcbf4c7f..6f82be7f4 100644 --- a/docs/artifactory/groupcreate/help.go +++ b/docs/artifactory/groupcreate/help.go @@ -3,7 +3,7 @@ package groupcreate var Usage = []string{"rt gc "} func GetDescription() string { - return "Create new users group." + return "Create a new user group" } func GetArguments() string { diff --git a/docs/artifactory/groupdelete/help.go b/docs/artifactory/groupdelete/help.go index f3c8a5bf6..18d8f7941 100644 --- a/docs/artifactory/groupdelete/help.go +++ b/docs/artifactory/groupdelete/help.go @@ -3,7 +3,7 @@ package groupdelete var Usage = []string{"rt gdel "} func GetDescription() string { - return "Delete a users group." + return "Delete a user group" } func GetArguments() string { diff --git a/docs/artifactory/mvn/help.go b/docs/artifactory/mvn/help.go index 5de631c71..ca5f7dee0 100644 --- a/docs/artifactory/mvn/help.go +++ b/docs/artifactory/mvn/help.go @@ -7,7 +7,7 @@ var Usage = []string{"rt mvn [command options]"} var EnvVar = []string{common.JfrogCliReleasesRepo, common.JfrogCliDependenciesDir} func GetDescription() string { - return "Run Maven build." + return "Run Maven build" } func GetArguments() string { diff --git a/docs/artifactory/terraform/help.go b/docs/artifactory/terraform/help.go index e6bd1b090..f5dc4dbf2 100644 --- a/docs/artifactory/terraform/help.go +++ b/docs/artifactory/terraform/help.go @@ -3,7 +3,7 @@ package terraformdocs var Usage = []string{"terraform [command options]"} func GetDescription() string { - return "Runs terraform " + return "Run Terraform" } func GetArguments() string { diff --git a/docs/artifactory/transferconfig/help.go b/docs/artifactory/transferconfig/help.go index 0f8a42157..7b490046d 100644 --- a/docs/artifactory/transferconfig/help.go +++ b/docs/artifactory/transferconfig/help.go @@ -3,7 +3,7 @@ package transferconfig var Usage = []string{"rt transfer-config [command options] "} func GetDescription() string { - return `Copy full Artifactory configuration from source Artifactory server to target Artifactory server.` + return `Copy the full configuration from a source Artifactory server to a target server` } func GetArguments() string { diff --git a/docs/artifactory/twine/help.go b/docs/artifactory/twine/help.go index 9fb5af93d..8613cbbf6 100644 --- a/docs/artifactory/twine/help.go +++ b/docs/artifactory/twine/help.go @@ -3,7 +3,7 @@ package twinedocs var Usage = []string{"twine [command options]"} func GetDescription() string { - return "Runs twine " + return "Run twine" } func GetArguments() string { diff --git a/docs/artifactory/usercreate/help.go b/docs/artifactory/usercreate/help.go index 22a3c42ad..bf213ecee 100644 --- a/docs/artifactory/usercreate/help.go +++ b/docs/artifactory/usercreate/help.go @@ -3,5 +3,5 @@ package usercreate var Usage = []string{"rt user-create "} func GetDescription() string { - return "Create new user." + return "Create a new user" } diff --git a/docs/artifactory/userscreate/help.go b/docs/artifactory/userscreate/help.go index 874f40de1..68a2ff023 100644 --- a/docs/artifactory/userscreate/help.go +++ b/docs/artifactory/userscreate/help.go @@ -3,5 +3,5 @@ package userscreate var Usage = []string{"rt uc --csv "} func GetDescription() string { - return "Create new users." + return "Create new users" } diff --git a/docs/general/summary/help.go b/docs/general/summary/help.go index d45aea503..a48d0964e 100644 --- a/docs/general/summary/help.go +++ b/docs/general/summary/help.go @@ -3,5 +3,5 @@ package summary var Usage = []string{"gsm"} func GetDescription() string { - return `Generates a Summary of recorded CLI commands there were executed on the current machine. The report is generated in Markdown format and saved in the directory stored in the JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR environment variable.` + return `Generate a summary of recorded CLI commands that were executed on the current machine. The report is generated in Markdown format and saved in the directory stored in the JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR environment variable.` } diff --git a/docs/plugin/publish/help.go b/docs/plugin/publish/help.go index ef84dbe98..90aefdf9f 100644 --- a/docs/plugin/publish/help.go +++ b/docs/plugin/publish/help.go @@ -7,7 +7,7 @@ var Usage = []string{"plugin publish "} var EnvVar = []string{common.JfrogCliPluginsServer, common.JfrogCliPluginsRepo} func GetDescription() string { - return "Publishing a JFrog CLI plugin." + return "Publish a JFrog CLI plugin" } func GetArguments() string { diff --git a/main.go b/main.go index 73585f5e4..6f5e38956 100644 --- a/main.go +++ b/main.go @@ -231,38 +231,38 @@ func getCommands() ([]cli.Command, error) { cliNameSpaces := []cli.Command{ { Name: cliutils.CmdArtifactory, - Usage: "Artifactory commands.", + Usage: "Artifactory commands", Subcommands: artifactory.GetCommands(), Category: commandNamespacesCategory, }, { Name: cliutils.CmdMissionControl, - Usage: "Mission Control commands.", + Usage: "Mission Control commands", Subcommands: missioncontrol.GetCommands(), Category: commandNamespacesCategory, }, { Name: cliutils.CmdPipelines, - Usage: "Pipelines commands.", + Usage: "Pipelines commands", Subcommands: pipelines.GetCommands(), Category: commandNamespacesCategory, }, { Name: cliutils.CmdCompletion, - Usage: "Generate autocomplete scripts.", + Usage: "Generate autocomplete scripts", Subcommands: completion.GetCommands(), Category: otherCategory, }, { Name: cliutils.CmdPlugin, - Usage: "Plugins handling commands.", + Usage: "Plugin commands", Subcommands: plugins.GetCommands(), Category: commandNamespacesCategory, }, { Name: cliutils.CmdConfig, Aliases: []string{"c"}, - Usage: "Server configurations commands.", + Usage: "Server configuration commands", Subcommands: config.GetCommands(), Category: commandNamespacesCategory, }, @@ -274,7 +274,7 @@ func getCommands() ([]cli.Command, error) { }, { Name: cliutils.CmdOptions, - Usage: "Show all supported environment variables.", + Usage: "Show all supported environment variables", Category: otherCategory, Action: func(*cli.Context) { fmt.Println(common.GetGlobalEnvVars()) @@ -437,7 +437,7 @@ func IntroCmd(_ *cli.Context) error { return err } clientlog.Output() - clientlog.Output(coreutils.PrintTitle(fmt.Sprintf("Thank you for installing version %s of JFrog CLI! 🐸", cliutils.CliVersion))) + clientlog.Output(coreutils.PrintTitle(fmt.Sprintf("Thank you for installing JFrog CLI version %s 🐸", cliutils.CliVersion))) var serverExists bool serverExists, err = coreconfig.IsServerConfExists() if serverExists || err != nil { @@ -445,7 +445,7 @@ func IntroCmd(_ *cli.Context) error { } clientlog.Output(coreutils.PrintTitle("So what's next?")) clientlog.Output() - clientlog.Output(coreutils.PrintTitle("Authenticate with your JFrog Platform by running one of the following two commands:")) + clientlog.Output(coreutils.PrintTitle("Authenticate with your JFrog Platform by running one of the following commands:")) clientlog.Output() clientlog.Output("jf login") clientlog.Output(coreutils.PrintTitle("or")) diff --git a/main_test.go b/main_test.go index 430682217..779e63dc5 100644 --- a/main_test.go +++ b/main_test.go @@ -407,7 +407,7 @@ func TestIntro(t *testing.T) { defer setEnvCallBack() runJfrogCli(t, "intro") - assert.Contains(t, buffer.String(), "Thank you for installing version") + assert.Contains(t, buffer.String(), "Thank you for installing JFrog CLI version") } func TestSurvey_NotDisplayedOnNonHelp(t *testing.T) {