Support standard environment variables for ANSI terminal output (#6362)

---------

Signed-off-by: Phil Ewels <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Co-authored-by: Ben Sherman <[email protected]>

Author: 4 people

docs/reference/env-vars.md

@@ -250,7 +250,7 @@ The following environment variables control the configuration of the Nextflow ru
 : Defines the minimum size of the `.command.run` staging script for it to be written to a separate `.command.stage` file (default: `'1 MB'`).
 : This setting is useful for executors that impose a size limit on job scripts.
 
-## Proxy settings
+## Other settings
 
 `FTP_PROXY`
 : :::{versionadded} 21.06.0-edge
@@ -269,5 +269,12 @@ The following environment variables control the configuration of the Nextflow ru
   Proxy authentication is supported by providing the credentials in the proxy URL, e.g. `https://user:[email protected]:port`.
   :::
 
+`NO_COLOR`
+: Disables ANSI color codes in Nextflow log output. When this variable is set, Nextflow prints plain text logs following the [NO_COLOR standard](https://no-color.org/).
+: If both `NO_COLOR` and `NXF_ANSI_LOG` are set, `NXF_ANSI_LOG` takes precedence.
+
 `NO_PROXY`
 : Defines one or more host names that should not use the proxy server. Separate multiple names using a comma character.
+
+`TERMINAL_WIDTH`
+: Forces the terminal width of ANSI-formatted log output. Overrides automatic terminal width detection and uses the specified width for line wrapping when set to an integer value.

modules/nextflow/src/main/groovy/nextflow/cli/CliOptions.groovy

@@ -18,7 +18,9 @@ package nextflow.cli
 
 import com.beust.jcommander.DynamicParameter
 import com.beust.jcommander.Parameter
+import groovy.transform.CompileStatic
 import groovy.util.logging.Slf4j
+import nextflow.SysEnv
 import nextflow.exception.AbortOperationException
 import org.fusesource.jansi.Ansi
 
@@ -28,6 +30,7 @@ import org.fusesource.jansi.Ansi
  * @author Paolo Di Tommaso <[email protected]>
  */
 @Slf4j
+@CompileStatic
 class CliOptions {
 
     /**
@@ -102,18 +105,24 @@ class CliOptions {
         if( quiet )
             return ansiLog = false
 
-        final env = System.getenv('NXF_ANSI_LOG')
+        final env = SysEnv.get('NXF_ANSI_LOG')
         if( env ) try {
             return Boolean.parseBoolean(env)
         }
         catch (Exception e) {
             log.warn "Invalid boolean value for variable NXF_ANSI_LOG: $env -- it must be 'true' or 'false'"
         }
+
+        // Check NO_COLOR environment variable (https://no-color.org/)
+        final noColor = SysEnv.get('NO_COLOR')
+        if( noColor ) {
+            return ansiLog = false
+        }
         return Ansi.isEnabled()
     }
 
     boolean hasAnsiLogFlag() {
-        ansiLog==true || System.getenv('NXF_ANSI_LOG')=='true'
+        ansiLog==true || SysEnv.get('NXF_ANSI_LOG')=='true'
     }
 
 }

modules/nextflow/src/main/groovy/nextflow/trace/AnsiLogObserver.groovy

@@ -16,22 +16,21 @@
 
 package nextflow.trace
 
+import static nextflow.util.LoggerHelper.*
+import static org.fusesource.jansi.Ansi.*
+
 import java.util.regex.Pattern
 
 import groovy.transform.CompileStatic
 import jline.TerminalFactory
 import nextflow.Session
+import nextflow.SysEnv
 import nextflow.trace.event.TaskEvent
 import nextflow.util.Duration
 import nextflow.util.SysHelper
 import nextflow.util.Threads
 import org.fusesource.jansi.Ansi
 import org.fusesource.jansi.AnsiConsole
-
-import static nextflow.util.LoggerHelper.isHashLogPrefix
-import static org.fusesource.jansi.Ansi.Attribute
-import static org.fusesource.jansi.Ansi.Color
-import static org.fusesource.jansi.Ansi.ansi
 /**
  * Implements an observer which display workflow
  * execution progress and notifications using
@@ -97,12 +96,25 @@ class AnsiLogObserver implements TraceObserverV2 {
 
     private long lastWidthReset
 
-    private Boolean enableSummary = System.getenv('NXF_ANSI_SUMMARY') as Boolean
+    private Boolean enableSummary = SysEnv.get('NXF_ANSI_SUMMARY') as Boolean
 
     private final int WARN_MESSAGE_TIMEOUT = 35_000
 
     private WorkflowStatsObserver statsObserver
 
+    private static Integer getEnvTerminalWidth() {
+        final env = SysEnv.get('TERMINAL_WIDTH')
+        if( !env )
+            return null
+        try {
+            return Integer.parseInt(env)
+        }
+        catch( NumberFormatException e ) {
+            // do not log error to avoid catch-22 logging event (this class renders logging events)
+            return null
+        }
+    }
+
     private void markModified() {
         changeTimestamp = System.currentTimeMillis()
     }
@@ -256,7 +268,7 @@ class AnsiLogObserver implements TraceObserverV2 {
             return
         }
 
-        cols = TerminalFactory.get().getWidth()
+        cols = getEnvTerminalWidth() ?: TerminalFactory.get().getWidth()
         rows = TerminalFactory.get().getHeight()
 
         // calc max width