Suppress missing enum warnings on github spec

Author: miniBill

cli/src/TestGenScript.elm

@@ -73,6 +73,7 @@ run =
         gitHub : OpenApi.Config.Input
         gitHub =
             OpenApi.Config.inputFrom (OpenApi.Config.File "./example/github-spec.json")
+                |> OpenApi.Config.withWarnOnMissingEnums False
 
         ifconfigOvh : OpenApi.Config.Input
         ifconfigOvh =

review/suppressed/Docs.NoMissing.json

@@ -3,7 +3,7 @@
   "automatically created by": "elm-review suppress",
   "learn more": "elm-review suppress --help",
   "suppressions": [
-    { "count": 33, "filePath": "src/OpenApi/Config.elm" },
-    { "count": 6, "filePath": "src/OpenApi/Generate.elm" }
+    { "count": 35, "filePath": "src/OpenApi/Config.elm" },
+    { "count": 5, "filePath": "src/OpenApi/Generate.elm" }
   ]
 }

src/CliMonad.elm

@@ -76,6 +76,7 @@ type CliMonad a
          , enums : FastDict.Dict (List String) { name : Common.UnsafeName, documentation : Maybe String }
          , namespace : List String
          , formats : FastDict.Dict InternalFormatName InternalFormat
+         , warnOnMissingEnums : Bool
          }
          -> Result Message ( a, Output )
         )
@@ -284,6 +285,7 @@ run :
         , enums : FastDict.Dict (List String) { name : Common.UnsafeName, documentation : Maybe String }
         , namespace : List String
         , formats : List OpenApi.Config.Format
+        , warnOnMissingEnums : Bool
         }
     -> CliMonad (List Declaration)
     ->
@@ -301,6 +303,7 @@ run oneOfDeclarations input (CliMonad x) =
             , enums : FastDict.Dict (List String) { name : Common.UnsafeName, documentation : Maybe String }
             , namespace : List String
             , formats : FastDict.Dict InternalFormatName InternalFormat
+            , warnOnMissingEnums : Bool
             }
         internalInput =
             { openApi = input.openApi
@@ -311,6 +314,7 @@ run oneOfDeclarations input (CliMonad x) =
                 input.formats
                     |> List.map toInternalFormat
                     |> FastDict.fromList
+            , warnOnMissingEnums = input.warnOnMissingEnums
             }
     in
     x internalInput
@@ -441,20 +445,32 @@ enumName variants =
                     succeed (Just name)
 
                 Nothing ->
-                    succeed Nothing
-                        |> withWarning
-                            ("No named enum found for [ "
-                                ++ String.join ", "
-                                    (List.map
-                                        (\variant ->
-                                            variant
-                                                |> Common.unwrapUnsafe
-                                                |> escapeString
-                                        )
-                                        variants
-                                    )
-                                ++ " ]. Define one to improve type safety"
-                            )
+                    CliMonad
+                        (\{ warnOnMissingEnums } ->
+                            if warnOnMissingEnums then
+                                let
+                                    variantNames : List String
+                                    variantNames =
+                                        List.map
+                                            (\variant ->
+                                                variant
+                                                    |> Common.unwrapUnsafe
+                                                    |> escapeString
+                                            )
+                                            variants
+
+                                    message : String
+                                    message =
+                                        "No named enum found for [ "
+                                            ++ String.join ", " variantNames
+                                            ++ " ]. Define one to improve type safety"
+                                in
+                                ( Nothing, { emptyOutput | warnings = [ { path = [], message = message } ] } )
+                                    |> Ok
+
+                            else
+                                Ok ( Nothing, emptyOutput )
+                        )
         )
         enums
 

src/OpenApi/Config.elm

@@ -2,7 +2,7 @@ module OpenApi.Config exposing
     ( Config, EffectType(..), effectTypeToPackage, Format, Input, Path(..), Server(..)
     , init, inputFrom, pathFromString
     , withAutoConvertSwagger, withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl
-    , withOutputModuleName, withOverrides, withServer, withWriteMergedTo
+    , withOutputModuleName, withOverrides, withServer, withWriteMergedTo, withWarnOnMissingEnums
     , autoConvertSwagger, inputs, outputDirectory, swaggerConversionCommand, swaggerConversionUrl
     , oasPath, overrides, writeMergedTo
     , toGenerationConfig, Generate, pathToString
@@ -21,7 +21,7 @@ module OpenApi.Config exposing
 
 @docs init, inputFrom, pathFromString
 @docs withAutoConvertSwagger, withEffectTypes, withFormat, withFormats, withGenerateTodos, withInput, withSwaggerConversionCommand, withSwaggerConversionUrl
-@docs withOutputModuleName, withOverrides, withServer, withWriteMergedTo
+@docs withOutputModuleName, withOverrides, withServer, withWriteMergedTo, withWarnOnMissingEnums
 
 
 # Config properties
@@ -92,6 +92,7 @@ type Input
         , overrides : List Path
         , writeMergedTo : Maybe String
         , effectTypes : List EffectType
+        , warnOnMissingEnums : Bool
         }
 
 
@@ -232,6 +233,7 @@ inputFrom path =
     , overrides = []
     , writeMergedTo = Nothing
     , effectTypes = [ ElmHttpCmd, ElmHttpTask ]
+    , warnOnMissingEnums = False
     }
         |> Input
 
@@ -472,6 +474,12 @@ withWriteMergedTo newWriteMergedTo (Input input) =
     Input { input | writeMergedTo = Just newWriteMergedTo }
 
 
+{-| -}
+withWarnOnMissingEnums : Bool -> Input -> Input
+withWarnOnMissingEnums newWarnOnMissingEnums (Input input) =
+    Input { input | warnOnMissingEnums = newWarnOnMissingEnums }
+
+
 {-| -}
 withFormat : Format -> Config -> Config
 withFormat newFormat (Config config) =
@@ -560,6 +568,7 @@ type alias Generate =
     , effectTypes : List EffectType
     , server : Server
     , formats : List Format
+    , warnOnMissingEnums : Bool
     }
 
 
@@ -591,6 +600,7 @@ toGenerationConfig formatsInput (Config config) augmentedInputs =
               , generateTodos = config.generateTodos
               , effectTypes = input.effectTypes
               , server = input.server
+              , warnOnMissingEnums = input.warnOnMissingEnums
               , formats = config.staticFormats ++ config.dynamicFormats formatsInput
               }
             , spec

src/OpenApi/Generate.elm

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