Better help message

Author: miniBill

cli/src/Cli.elm

@@ -60,21 +60,25 @@ program =
         |> Cli.Program.add
             (Cli.OptionsParser.build CliOptions
                 |> Cli.OptionsParser.with
-                    (Cli.Option.requiredPositionalArg "entryFilePath"
+                    (Cli.Option.requiredPositionalArg "input-file"
+                        |> Cli.Option.withDisplayName "file.json|file.yaml"
                         |> Cli.Option.map OpenApi.Config.pathFromString
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "output-dir"
                         |> Cli.Option.withDefault "generated"
+                        |> Cli.Option.withDisplayName "dir"
                         |> Cli.Option.withDescription "The directory to output to. Defaults to `generated/`."
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "module-name"
+                        |> Cli.Option.withDisplayName "Elm.Module.Name"
                         |> Cli.Option.withDescription "The Elm module name. Defaults to `OAS info.title`."
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "effect-types"
                         |> Cli.Option.validateMap effectTypesValidation
+                        |> Cli.Option.withDisplayName "pkg1.type1,..."
                         |> Cli.Option.withDescription
                             ([ "A list of which kind of APIs to generate."
                              , "Each item should be of the form `package.type`."
@@ -103,6 +107,7 @@ program =
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "server"
                         |> Cli.Option.validateMap serverValidation
+                        |> Cli.Option.withDisplayName "https://example.com"
                         |> Cli.Option.withDescription
                             ([ "The base URL for the OpenAPI server."
                              , "If not specified this will be extracted from the OAS"
@@ -120,7 +125,12 @@ program =
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "auto-convert-swagger"
-                        |> Cli.Option.validateMap autoConvertValidation
+                        |> Cli.Option.withDefault "ask"
+                        |> Cli.Option.oneOf
+                            [ ( "ask", OpenApi.Config.AskBeforeConversion )
+                            , ( "never", OpenApi.Config.NeverConvert )
+                            , ( "always", OpenApi.Config.AlwaysConvert )
+                            ]
                         |> Cli.Option.withDescription
                             ([ "\"ask\" If a Swagger doc is encountered, ask the user before converting"
                              , "it to an Open API file. This is the default."
@@ -133,6 +143,7 @@ program =
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "swagger-conversion-url"
+                        |> Cli.Option.withDisplayName "url"
                         |> Cli.Option.withDescription
                             ([ "The URL to use to convert a Swagger doc to an Open API"
                              , "file. Defaults to `https://converter.swagger.io/api/convert`."
@@ -142,6 +153,7 @@ program =
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "swagger-conversion-command"
+                        |> Cli.Option.withDisplayName "cmd"
                         |> Cli.Option.withDescription
                             ([ "Instead of making an HTTP request to convert"
                              , "from Swagger to Open API, use this command."
@@ -151,6 +163,7 @@ program =
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.keywordArgList "swagger-conversion-command-args"
+                        |> Cli.Option.withDisplayName "args"
                         |> Cli.Option.withDescription
                             ([ "Additional arguments to pass to the Swagger conversion command,"
                              , "before the contents of the Swagger file are passed in."
@@ -171,11 +184,13 @@ program =
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.keywordArgList "overrides"
+                        |> Cli.Option.withDisplayName "override.json|yaml"
                         |> Cli.Option.map (List.map OpenApi.Config.pathFromString)
                         |> Cli.Option.withDescription "Load an additional file to override parts of the original Open API file."
                     )
                 |> Cli.OptionsParser.with
                     (Cli.Option.optionalKeywordArg "write-merged-to"
+                        |> Cli.Option.withDisplayName "dir"
                         |> Cli.Option.withDescription "Write the merged Open API spec to the given file."
                     )
                 |> Cli.OptionsParser.with
@@ -206,28 +221,6 @@ formatOptionDescription descriptionLines =
         |> String.join "\n"
 
 
-autoConvertValidation : Maybe String -> Result String OpenApi.Config.AutoConvertSwagger
-autoConvertValidation input =
-    case input of
-        Nothing ->
-            Ok OpenApi.Config.AskBeforeConversion
-
-        Just "ask" ->
-            Ok OpenApi.Config.AskBeforeConversion
-
-        Just "" ->
-            Ok OpenApi.Config.AlwaysConvert
-
-        Just "always" ->
-            Ok OpenApi.Config.AlwaysConvert
-
-        Just "never" ->
-            Ok OpenApi.Config.NeverConvert
-
-        Just value ->
-            Err ("Unexpected value for auto-convert-swagger: " ++ value)
-
-
 effectTypesValidation : Maybe String -> Result String (List OpenApi.Config.EffectType)
 effectTypesValidation str =
     case str of