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.

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

Rename quickstart command [CLI-16] #102

Merged
merged 4 commits into from
Feb 22, 2021
Merged

Rename quickstart command [CLI-16] #102

merged 4 commits into from
Feb 22, 2021

Conversation

Widcket
Copy link
Contributor

@Widcket Widcket commented Feb 22, 2021

Description

This PR renames the quickstart command to its plural form,quickstarts.

Testing

  • This change adds test coverage for new/changed/fixed functionality

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not master

@Widcket Widcket changed the title Rename quickstart command Rename quickstart command [CLI-16] Feb 22, 2021
@rene00
Copy link
Contributor

rene00 commented Feb 22, 2021

I believe

Long: `auth0 quickstart download --type <type> --client-id <client-id> --stack <stack>`,
needs to be updated too changing auth0 quickstart to auth0 quickstarts.

@Widcket
Copy link
Contributor Author

Widcket commented Feb 22, 2021

auth0 quickstart download

Indeed, I changed it. Thanks!

Copy link
Contributor

@jfatta jfatta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎊


return cmd
}

func quickstartDownloadCmd(cli *cli) *cobra.Command {
func downloadQuickstart(cli *cli) *cobra.Command {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(NAB) all these commands and subcommands init functions live on the same package (cli), at some point it can be painful to find unique names, that's why I think keeping the "full subcommand path" as the func name is a good idea (quickstartsDownload() in this case). Alternatively we can move each family of commands to its own package 🤷‍♂️

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea is to eventually have each family of commands on its own package, yes.

@@ -59,7 +59,7 @@ func Execute() {
// order of the comamnds here matters
// so add new commands in a place that reflect its relevance or relation with other commands:
rootCmd.AddCommand(loginCmd(cli))
rootCmd.AddCommand(quickstartCmd(cli))
rootCmd.AddCommand(quickstartsCmd(cli))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor/NAB: I wonder if the intuitive flow would be: login -> create an app -> quickstart...
in that case let's switch the order here (since it is reflected on the overall CLI help, usage text, etc)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you need a client id to be able to run a QS app, so you need to create an app first. I've switched the order in 061d3e4.

@Widcket Widcket merged commit e318ece into main Feb 22, 2021
@Widcket Widcket deleted the rename-quickstarts branch February 22, 2021 18:10
@cyx
Copy link
Contributor

cyx commented Feb 22, 2021

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants