Don't skip paths by default

Author: miniBill

cli/src/Cli.elm

@@ -50,6 +50,7 @@ type alias CliOptions =
     , overrides : List OpenApi.Config.Path
     , writeMergedTo : Maybe String
     , noElmFormat : Bool
+    , keepGoing : Bool
     }
 
 
@@ -96,6 +97,8 @@ program =
                     (Cli.Option.optionalKeywordArg "write-merged-to")
                 |> Cli.OptionsParser.with
                     (Cli.Option.flag "no-elm-format")
+                |> Cli.OptionsParser.with
+                    (Cli.Option.flag "keep-going")
                 |> Cli.OptionsParser.withDoc
                     ([ ""
                      , """version: 0.7.0"""
@@ -166,6 +169,7 @@ program =
                      , formatOption "overrides" [ "Load an additional file to override parts of the original Open API file." ]
                      , formatOption "write-merged-to" [ "Write the merged Open API spec to the given file." ]
                      , formatOption "no-elm-format" [ "Don't run elm-format on the outputs." ]
+                     , formatOption "keep-going" [ "If a route can't be generated, skip it instead of erroring out." ]
                      ]
                         |> String.join "\n\n"
                     )
@@ -370,6 +374,7 @@ parseCliOptions cliOptions =
         |> OpenApi.Config.withGenerateTodos cliOptions.generateTodos
         |> OpenApi.Config.withAutoConvertSwagger cliOptions.autoConvertSwagger
         |> OpenApi.Config.withNoElmFormat cliOptions.noElmFormat
+        |> OpenApi.Config.withKeepGoing cliOptions.keepGoing
         |> maybe OpenApi.Config.withSwaggerConversionUrl cliOptions.swaggerConversionUrl
         |> maybe OpenApi.Config.withSwaggerConversionCommand
             (cliOptions.swaggerConversionCommand

src/CliMonad.elm

@@ -44,6 +44,7 @@ import OpenApi exposing (OpenApi)
 import OpenApi.Config
 import Pretty
 import String.Extra
+import Triple.Extra
 
 
 type alias Message =
@@ -85,6 +86,7 @@ type alias Input =
     , namespace : List String
     , formats : FastDict.Dict InternalFormatName InternalFormat
     , warnOnMissingEnums : Bool
+    , keepGoing : Bool
     }
 
 
@@ -126,6 +128,7 @@ run :
         , namespace : List String
         , formats : List OpenApi.Config.Format
         , warnOnMissingEnums : Bool
+        , keepGoing : Bool
         }
     -> CliMonad (List Declaration)
     ->
@@ -148,6 +151,7 @@ run oneOfDeclarations input (CliMonad x) =
                     |> List.map toInternalFormat
                     |> FastDict.fromList
             , warnOnMissingEnums = input.warnOnMissingEnums
+            , keepGoing = input.keepGoing
             }
 
         res : Result Message ( List Declaration, Output, Cache )
@@ -570,20 +574,28 @@ getApiSpec =
     CliMonad (\input cache -> Ok ( input.openApi, emptyOutput, cache ))
 
 
+{-| If the user has chosen to keep going in the face of errors, this will convert an error into a warning. Otherwise this returns the input
+-}
 errorToWarning : CliMonad a -> CliMonad (Maybe a)
 errorToWarning (CliMonad f) =
     CliMonad
         (\input cache ->
-            case f input cache of
-                Ok ( res, output, cache2 ) ->
-                    Ok ( Just res, output, cache2 )
+            if input.keepGoing then
+                case f input cache of
+                    Ok ( res, output, cache2 ) ->
+                        Ok ( Just res, output, cache2 )
 
-                Err { path, message } ->
-                    ( Nothing
-                    , { emptyOutput | warnings = [ { path = path, message = message, details = Pretty.empty } ] }
-                    , cache
-                    )
-                        |> Ok
+                    Err { path, message } ->
+                        ( Nothing
+                        , { emptyOutput | warnings = [ { path = path, message = message, details = Pretty.empty } ] }
+                        , cache
+                        )
+                            |> Ok
+
+            else
+                Result.map
+                    (Triple.Extra.mapFirst Just)
+                    (f input cache)
         )
 
 

src/OpenApi/Config.elm

@@ -1,9 +1,9 @@
 module OpenApi.Config exposing
     ( Config, EffectType(..), effectTypeToPackage, Format, Input, Path(..), Server(..)
     , init, inputFrom, pathFromString
-    , withAutoConvertSwagger, AutoConvertSwagger(..), withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl, withNoElmFormat
+    , withAutoConvertSwagger, AutoConvertSwagger(..), withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl, withNoElmFormat, withKeepGoing
     , withOutputModuleName, withOverrides, withServer, withWriteMergedTo, withWarnOnMissingEnums
-    , autoConvertSwagger, inputs, outputDirectory, swaggerConversionCommand, swaggerConversionUrl, noElmFormat
+    , autoConvertSwagger, inputs, outputDirectory, swaggerConversionCommand, swaggerConversionUrl, noElmFormat, keepGoing
     , oasPath, overrides, writeMergedTo
     , toGenerationConfig, Generate, pathToString
     , defaultFormats
@@ -20,13 +20,13 @@ module OpenApi.Config exposing
 # Creation
 
 @docs init, inputFrom, pathFromString
-@docs withAutoConvertSwagger, AutoConvertSwagger, withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl, withNoElmFormat
+@docs withAutoConvertSwagger, AutoConvertSwagger, withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl, withNoElmFormat, withKeepGoing
 @docs withOutputModuleName, withOverrides, withServer, withWriteMergedTo, withWarnOnMissingEnums
 
 
 # Config properties
 
-@docs autoConvertSwagger, inputs, outputDirectory, swaggerConversionCommand, swaggerConversionUrl, noElmFormat
+@docs autoConvertSwagger, inputs, outputDirectory, swaggerConversionCommand, swaggerConversionUrl, noElmFormat, keepGoing
 
 
 # Input properties
@@ -83,6 +83,7 @@ type Config
         , staticFormats : List Format
         , dynamicFormats : List { format : String, basicType : Common.BasicType } -> List Format
         , noElmFormat : Bool
+        , keepGoing : Bool
         }
 
 
@@ -242,6 +243,7 @@ init initialOutputDirectory =
     , staticFormats = defaultFormats
     , dynamicFormats = \_ -> []
     , noElmFormat = False
+    , keepGoing = False
     }
         |> Config
 
@@ -550,6 +552,11 @@ withNoElmFormat newNoElmFormat (Config config) =
     Config { config | noElmFormat = newNoElmFormat }
 
 
+withKeepGoing : Bool -> Config -> Config
+withKeepGoing newKeepGoing (Config config) =
+    Config { config | keepGoing = newKeepGoing }
+
+
 
 -------------
 -- Getters --
@@ -592,6 +599,12 @@ noElmFormat (Config config) =
     config.noElmFormat
 
 
+{-| -}
+keepGoing : Config -> Bool
+keepGoing (Config config) =
+    config.keepGoing
+
+
 {-| -}
 oasPath : Input -> Path
 oasPath (Input input) =
@@ -624,6 +637,7 @@ type alias Generate =
     , server : Server
     , formats : List Format
     , warnOnMissingEnums : Bool
+    , keepGoing : Bool
     }
 
 
@@ -657,6 +671,7 @@ toGenerationConfig formatsInput (Config config) augmentedInputs =
               , server = input.server
               , warnOnMissingEnums = input.warnOnMissingEnums
               , formats = config.staticFormats ++ config.dynamicFormats formatsInput
+              , keepGoing = config.keepGoing
               }
             , spec
             )

src/OpenApi/Generate.elm

@@ -119,7 +119,7 @@ files :
             , warnings : List Message
             , requiredPackages : FastSet.Set String
             }
-files { namespace, generateTodos, effectTypes, server, formats, warnOnMissingEnums } apiSpec =
+files { namespace, generateTodos, effectTypes, server, formats, warnOnMissingEnums, keepGoing } apiSpec =
     case extractEnums apiSpec of
         Err e ->
             Err e
@@ -148,6 +148,7 @@ files { namespace, generateTodos, effectTypes, server, formats, warnOnMissingEnu
                     , namespace = namespace
                     , formats = formats
                     , warnOnMissingEnums = warnOnMissingEnums
+                    , keepGoing = keepGoing
                     }
                 |> Result.map
                     (\{ declarations, warnings, requiredPackages } ->

tests/Test/OpenApi/Generate.elm

@@ -129,6 +129,7 @@ fuzzTitle =
                                 , server = OpenApi.Config.Default
                                 , formats = OpenApi.Config.defaultFormats
                                 , warnOnMissingEnums = True
+                                , keepGoing = False
                                 }
                                 oas
                     in
@@ -257,6 +258,7 @@ pr267 =
                                 , server = OpenApi.Config.Default
                                 , formats = OpenApi.Config.defaultFormats
                                 , warnOnMissingEnums = True
+                                , keepGoing = False
                                 }
                                 oas
                     in