ColorScheme not working

[sysmat]

picocli: 4.5.1

When exception is in Callable then from cli I should expect massage to be color red, but is not(powershell, gitbash)

My code:

static IExecutionExceptionHandler errorHandler = (Exception ex, CommandLine cmdL, ParseResult pr) -> {
        cmdL.getErr().println(cmdL.getColorScheme().errorText(ex.getMessage())); 
        return cmdL.getCommandSpec().exitCodeOnExecutionException();
};

public static void main( String[] args ) {
       ColorScheme colorScheme = createColorScheme();
       CommandLine commands = new CommandLine(new TopLavelCommands()).setColorScheme(colorScheme).setExecutionExceptionHandler(errorHandler);
        System.exit(commands ).execute(args);
}

private static ColorScheme createColorScheme() {
        return new ColorScheme.Builder()
                .commands(CommandLine.Help.Ansi.Style.bold, CommandLine.Help.Ansi.Style.underline) // combine multiple styles
                .options(CommandLine.Help.Ansi.Style.fg_yellow) // yellow foreground color
                .parameters(CommandLine.Help.Ansi.Style.fg_yellow)
                .optionParams(CommandLine.Help.Ansi.Style.italic)
                .errors(CommandLine.Help.Ansi.Style.fg_red, CommandLine.Help.Ansi.Style.bold)
                .stackTraces(CommandLine.Help.Ansi.Style.italic)
                .build();
}

[remkop]

@sysmat Are colors showing correctly when you execute <yourcmd> --help in those shells?

To help troubleshoot this issue, can you run again with system property -Dpicocli.trace=DEBUG on both shells, and copy-paste the output here?

The powershell problem may be related to this issue.
(I have not heard any reports of problems with ANSI colors in gitbash until now.)

[sysmat]

[picocli DEBUG] Creating CommandSpec for si.arnes.kdo.cli.TopLavelCommands@3f8f9dd6 with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Creating CommandSpec for class picocli.CommandLine$HelpCommand with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Adding subcommand 'help' to '<main class>'
[picocli DEBUG] Creating CommandSpec for class si.arnes.kdo.cli.SearchCmd with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Adding subcommand 'search' to '<main class>'
[picocli INFO] Picocli version: 4.5.1, JVM: 1.8.0_201 (Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.201-b09), OS: Windows 10 10.0 amd64
[picocli INFO] Parsing 1 command line args [help]
[picocli DEBUG] Parser configuration: optionsCaseInsensitive=false, subcommandsCaseInsensitive=false, abbreviatedOptionsAllowed=false, abbreviatedSubcommandsAllowed=false, aritySatisfiedByAttachedOptionParam=false, atFileCommentChar=#, caseInsensitiveEnumValuesAllowed=false, collectErrors=false, endOfOptionsDelimiter=--, expandAtFiles=true, limitSplit=false, overwrittenOptionsAllowed=false, posixClusteredShortOptionsAllowed=true, separator=null, splitQuotedStrings=false, stopAtPositional=false, stopAtUnmatched=false, toggleBooleanFlags=false, trimQuotes=false, unmatchedArgumentsAllowed=false, unmatchedOptionsAllowedAsOptionParameters=true, unmatchedOptionsArePositionalParams=false, useSimplifiedAtFiles=false
[picocli DEBUG] (ANSI is disabled by default: systemproperty[picocli.ansi]=null, isatty=true, TERM=cygwin, OSTYPE=null, isWindows=true, JansiConsoleInstalled=false, ANSICON=null, ConEmuANSI=null, NO_COLOR=null, CLICOLOR=null, CLICOLOR_FORCE=null)
[picocli DEBUG] Initializing command 'null' (user object: si.arnes.kdo.cli.TopLavelCommands@3f8f9dd6): 0 options, 0 positional parameters, 0 required, 0 groups, 2 subcommands.
[picocli DEBUG] [0] Processing argument 'help'. Remainder=[]
[picocli DEBUG] Found subcommand 'help' (command 'help' (user object: class picocli.CommandLine$HelpCommand))
[picocli DEBUG] Checking required args for parent command 'null' (user object: si.arnes.kdo.cli.TopLavelCommands@3f8f9dd6)...
[picocli DEBUG] Initializing command 'help' (user object: class picocli.CommandLine$HelpCommand): 1 options, 1 positional parameters, 0 required, 0 groups, 0 subcommands.
[picocli DEBUG] Getting a picocli.CommandLine$HelpCommand instance from factory picocli.CommandLine$DefaultFactory@33e5ccce
[picocli DEBUG] Factory returned a picocli.CommandLine$HelpCommand instance (5a42bbf4)
[picocli DEBUG] Set initial value for field boolean picocli.CommandLine$HelpCommand.helpRequested of type boolean to false.
[picocli DEBUG] Set initial value for field String[] picocli.CommandLine$HelpCommand.commands of type class [Ljava.lang.String; to [Ljava.lang.String;@270421f5.

[picocli DEBUG] Applying default values for command '<main class> help'
[picocli DEBUG] defaultValue not defined for field boolean picocli.CommandLine$HelpCommand.helpRequested
[picocli DEBUG] defaultValue not defined for field String[] picocli.CommandLine$HelpCommand.commands
[picocli DEBUG] Applying default values for command '<main class>'
commands for kdo cli
Usage>> command switches
help>> help
help for search command>> help search
Commands:
  help    Displays help information about the specified command
  search  search users by username or mail and retrive users data

[remkop]

Thank you!

I see what the cause is: the TERM environment variable has value Cygwin and this is not recognized by picocli.
I will fix this soon.

Can you provide details on the terminal software name and version?

[sysmat]

I'm using Windows Terminal Version: 1.3.2651.0 with the different host terminal

• Powershell

Name             : ConsoleHost
Version          : 5.1.19041.1
InstanceId       : 77c51b75-1189-4579-b72d-8499cbaa160a
UI               : System.Management.Automation.Internal.Host.InternalHostUserInterface
CurrentCulture   : sl-SI
CurrentUICulture : en-US
PrivateData      : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
DebuggerEnabled  : True
IsRunspacePushed : False
Runspace         : System.Management.Automation.Runspaces.LocalRunspace

• gitbash

cygwin
cygcheck (msys) 2.6.0
System Checker for Msys

[remkop]

By the way, can you also provide -Dpicocli.trace=DEBUG output for PowerShell? The cause may be different.

[sysmat]

• powershell:

❯ java '-Dpicocli.trace=DEBUG' -jar kdo.jar
[picocli DEBUG] Creating CommandSpec for si.arnes.kdo.cli.TopLavelCommands@3f8f9dd6 with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Creating CommandSpec for class picocli.CommandLine$HelpCommand with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Adding subcommand 'help' to '<main class>'
[picocli DEBUG] Creating CommandSpec for class si.arnes.kdo.cli.SearchCmd with factory picocli.CommandLine$DefaultFactory
[picocli DEBUG] Adding subcommand 'search' to '<main class>'
[picocli INFO] Picocli version: 4.5.1, JVM: 1.8.0_201 (Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.201-b09), OS: Windows 10 10.0 amd64
[picocli INFO] Parsing 0 command line args []
[picocli DEBUG] Parser configuration: optionsCaseInsensitive=false, subcommandsCaseInsensitive=false, abbreviatedOptionsAllowed=false, abbreviatedSubcommandsAllowed=false, aritySatisfiedByAttachedOptionParam=false, atFileCommentChar=#, caseInsensitiveEnumValuesAllowed=false, collectErrors=false, endOfOptionsDelimiter=--, expandAtFiles=true, limitSplit=false, overwrittenOptionsAllowed=false, posixClusteredShortOptionsAllowed=true, separator=null, splitQuotedStrings=false, stopAtPositional=false, stopAtUnmatched=false, toggleBooleanFlags=false, trimQuotes=false, unmatchedArgumentsAllowed=false, unmatchedOptionsAllowedAsOptionParameters=true, unmatchedOptionsArePositionalParams=false, useSimplifiedAtFiles=false
[picocli DEBUG] (ANSI is disabled by default: systemproperty[picocli.ansi]=null, isatty=true, TERM=null, OSTYPE=null, isWindows=true, JansiConsoleInstalled=false, ANSICON=null, ConEmuANSI=null, NO_COLOR=null, CLICOLOR=null, CLICOLOR_FORCE=null)
[picocli DEBUG] Initializing command 'null' (user object: si.arnes.kdo.cli.TopLavelCommands@3f8f9dd6): 0 options, 0 positional parameters, 0 required, 0 groups, 2 subcommands.
[picocli DEBUG] Applying default values for command '<main class>'
Missing required subcommand
commands for kdo cli

[remkop]

Thank you!

Looks like on PowerShell, picocli cannot detect that ANSI escape codes are supported.
So you would need to either use Jansi:

import org.fusesource.jansi.AnsiConsole;
...
public static void main(String[] args) {
    AnsiConsole.systemInstall(); // enable colors on Windows
    new CommandLine(new TopLavelCommands()).execute(args);
    AnsiConsole.systemUninstall(); // cleanup when done
}

...or ask your users to set one of the environment variables that picocli uses to determine if ANSI escape codes are supported.

I recommend Jansi, or picocli-jansi-graalvm.
picocli-jansi-graalvm allows you to only use Jansi on Windows-only, and fixes some Jansi bugs for GraalVM native images.

It is used like this:

import picocli.jansi.graalvm.AnsiConsole; // not org.fusesource.jansi.AnsiConsole
...
try (AnsiConsole ansi = AnsiConsole.windowsInstall()) { // enable colors on Windows
    new CommandLine(new MyApp()).execute(args);
}                                                       // Closeable does cleanup when done

[remkop]

@sysmat I finally got around to putting in a fix for MSYS2 (auto-enable ANSI when env var TERM contains cygwin).

Can you confirm that this solves the issue in the MSYS2-based Windows Terminal shell?

To verify, check out picocli master locally, and build it with publishToMavenLocal. That should publish picocli-4.5.2-SNAPSHOT to your local .m2 Maven cache.

git clone https://github.com/remkop/picocli.git
cd picocli
gradlew publishToMavenLocal

You can then try this in a project that uses the info.picocli:picocli:4.5.2-SNAPSHOT dependency. Feedback very welcome!

[remkop]

@sysmat Can you think of a way to detect from the Java process whether it was launched from PowerShell or from some other shell like CMD? That would help further improve picocli's ANSI heuristics.

If we cannot improve the heuristics, then the best thing that picocli-based applications can do is to always use Jansi (at least when running on Windows).

Thoughts?