Skip to content

apiviewgo: print help instead of panicking when given no args #8333

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 30, 2024
Merged

apiviewgo: print help instead of panicking when given no args #8333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions src/go/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,18 @@ import (

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "apiview <packageDir> <outputDir>",
Short: "apiview will generate the JSON token output for APIView",
Long: `The apiview command can be used to generate the tokenized
output needed by the APIView tool to show a view of publicly
exposed portions of an SDK. The generated file will use the
following naming format: <module name>.json
NOTE: This command will overwrite any file with the same name
in the output directory.`,
// Uncomment the following line if your bare application
// has an action associated with it:
Use: "apiviewgo <moduleDir> <outputDir>",
Long: `apiviewgo outputs a file representing the public API of an Azure SDK for Go
module in APIView format. It writes this file to <outputDir>/<module name>.json,
overwriting any file of the same name.`,
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 2 {
err := cmd.Help()
if err != nil {
fmt.Println(err)
}
return
}
err := CreateAPIView(args[0], args[1])
if err != nil {
fmt.Println(err)
Expand Down