Avoid spinners when NO_COLOR is set or the output is not a TTY

Author: miniBill

cli/custom-backend-task.js

@@ -5,3 +5,7 @@ export function profile(label) {
 export function profileEnd(label) {
     console.profileEnd(label);
 }
+
+export function isTTY() {
+    return !!process.stdout.isTTY;
+}

cli/src/Cli.elm

@@ -4,6 +4,8 @@ import Ansi
 import Ansi.Color
 import Ansi.Font
 import BackendTask exposing (BackendTask)
+import BackendTask.Custom
+import BackendTask.Env
 import BackendTask.Extra
 import BackendTask.File
 import BackendTask.Http
@@ -377,16 +379,55 @@ parseCliOptions cliOptions =
             )
 
 
+type alias Step a =
+    ( Pages.Script.Spinner.Steps FatalError a
+    , BackendTask FatalError a
+    )
+
+
+withStep :
+    String
+    -> (a -> BackendTask FatalError b)
+    -> Step a
+    -> Step b
+withStep label toTask ( steps, task ) =
+    ( Pages.Script.Spinner.withStep label toTask steps
+    , task
+        |> BackendTask.andThen
+            (\input ->
+                Pages.Script.log label
+                    |> BackendTask.andThen (\() -> toTask input)
+            )
+    )
+
+
 withInnerStep :
     Int
     -> Int
     -> String
     -> (a -> BackendTask FatalError b)
-    -> Pages.Script.Spinner.Steps FatalError ( a, c, d )
-    -> Pages.Script.Spinner.Steps FatalError ( b, c, d )
-withInnerStep index total label toTask =
-    Pages.Script.Spinner.withStep (counter index total ++ " " ++ label)
-        (\( input, acc1, acc2 ) -> toTask input |> BackendTask.map (\result -> ( result, acc1, acc2 )))
+    -> Step ( a, c, d )
+    -> Step ( b, c, d )
+withInnerStep index total label toTask ( steps, task ) =
+    let
+        fullLabel : String
+        fullLabel =
+            counter index total ++ " " ++ label
+
+        combinedTask : ( a, c, d ) -> BackendTask FatalError ( b, c, d )
+        combinedTask ( input, acc1, acc2 ) =
+            toTask input |> BackendTask.map (\result -> ( result, acc1, acc2 ))
+    in
+    ( Pages.Script.Spinner.withStep fullLabel
+        combinedTask
+        steps
+    , task
+        |> BackendTask.andThen
+            (\( input, acc1, acc2 ) ->
+                Pages.Script.log fullLabel
+                    |> BackendTask.andThen (\() -> combinedTask ( input, acc1, acc2 ))
+            )
+    )
 
 
 withConfig : OpenApi.Config.Config -> BackendTask FatalError ()
@@ -453,7 +494,7 @@ withConfig config =
                         Just destination ->
                             withInnerStep index total "Writing merged OAS" (writeMerged destination)
                    )
-                |> Pages.Script.Spinner.withStep (counter index total ++ " Parse OAS")
+                |> withStep (counter index total ++ " Parse OAS")
                     (\( merged, apiSpecAcc, formatsAcc ) ->
                         merged
                             |> decodeOpenApiSpecOrFail { hasAttemptedToConvertFromSwagger = False } config input
@@ -468,12 +509,14 @@ withConfig config =
             )
         )
         ( 1
-        , Pages.Script.Spinner.steps
-            |> Pages.Script.Spinner.withStep "Collecting configuration" (\_ -> BackendTask.succeed ( (), [], [] ))
+        , ( Pages.Script.Spinner.steps
+                |> Pages.Script.Spinner.withStep "Collecting configuration" (\_ -> BackendTask.succeed ( (), [], [] ))
+          , Pages.Script.log "Collecting configuration" |> BackendTask.map (\() -> ( (), [], [] ))
+          )
         )
         (OpenApi.Config.inputs config)
         |> Tuple.second
-        |> Pages.Script.Spinner.withStep "Generate Elm modules"
+        |> withStep "Generate Elm modules"
             (\( (), apiSpecs, allFormats ) ->
                 OpenApi.Config.toGenerationConfig (List.concat allFormats) config apiSpecs
                     |> generateFilesFromOpenApiSpecs
@@ -482,14 +525,34 @@ withConfig config =
                 identity
 
             else
-                Pages.Script.Spinner.withStep "Format with elm-format" (onFirst attemptToFormat)
+                withStep "Format with elm-format" (onFirst attemptToFormat)
+           )
+        |> withStep "Write to disk" (onFirst (writeSdkToDisk (OpenApi.Config.outputDirectory config)))
+        |> (\( steps, task ) ->
+                terminalInfo
+                    |> BackendTask.andThen
+                        (\{ isTTY, noColor } ->
+                            if isTTY && not noColor then
+                                Pages.Script.Spinner.runSteps steps
+
+                            else
+                                task
+                        )
            )
-        |> Pages.Script.Spinner.withStep "Write to disk" (onFirst (writeSdkToDisk (OpenApi.Config.outputDirectory config)))
-        |> Pages.Script.Spinner.runSteps
         |> BackendTask.map convertElmCodegenWarnings
         |> BackendTask.andThen printSuccessMessageAndWarnings
 
 
+terminalInfo : BackendTask FatalError { isTTY : Bool, noColor : Bool }
+terminalInfo =
+    BackendTask.map2 (\isTTY noColor -> { isTTY = isTTY, noColor = noColor })
+        (BackendTask.Custom.run "isTTY" Json.Encode.null Json.Decode.bool
+            |> BackendTask.allowFatal
+            |> BackendTask.quiet
+        )
+        (BackendTask.Env.get "NO_COLOR" |> BackendTask.map (\nc -> nc /= Nothing && nc /= Just ""))
+
+
 convertElmCodegenWarnings :
     ( List ( String, List { declaration : String, warning : String } )
     , { warnings : List OpenApi.Generate.Message, requiredPackages : FastSet.Set String }
@@ -725,7 +788,17 @@ convertToSwaggerAndThenDecode config input value =
                 parseOriginal input swagger
                     |> BackendTask.andThen mergeOverrides
             )
-        |> Pages.Script.Spinner.runTask "Convert Swagger to Open API"
+        |> (\task ->
+                terminalInfo
+                    |> BackendTask.andThen
+                        (\{ isTTY, noColor } ->
+                            if isTTY && not noColor then
+                                Pages.Script.Spinner.runTask "Convert Swagger to Open API" task
+
+                            else
+                                task
+                        )
+           )
         |> BackendTask.andThen (\converted -> decodeOpenApiSpecOrFail { hasAttemptedToConvertFromSwagger = True } config input converted)