CommandLine.HelpTextExtensions Class Reference

Static Public Member Functions
static bool	IsHelp (this IEnumerable< Error > errs)
	return true when errors contain HelpXXXError
static bool	IsVersion (this IEnumerable< Error > errs)
	return true when errors contain VersionXXXError
static TextWriter	Output (this IEnumerable< Error > errs)
	redirect errs to Console.Error, and to Console.Out for help/version error

Detailed Description

Definition at line 10 of file HelpTextExtensions.cs.

Member Function Documentation

IsHelp()

static bool CommandLine.HelpTextExtensions.IsHelp ( this IEnumerable< Error >  errs )

static

return true when errors contain HelpXXXError

Definition at line 15 of file HelpTextExtensions.cs.

        {
            if (errs.Any(x => x.Tag == ErrorType.HelpRequestedError ||
                              x.Tag == ErrorType.HelpVerbRequestedError
                        ))
            {
                return true;
            }
 
            //when  AutoHelp=false in parser, help is disabled  and Parser raise UnknownOptionError
            return errs.Any(x => (x is UnknownOptionError ee ? ee.Token : "") == "help");
        }

IsVersion()

static bool CommandLine.HelpTextExtensions.IsVersion ( this IEnumerable< Error >  errs )

static

return true when errors contain VersionXXXError

Definition at line 31 of file HelpTextExtensions.cs.

        {
            if (errs.Any(x => x.Tag == ErrorType.VersionRequestedError))
            {
                return true;
            }
 
            //when  AutoVersion=false in parser, Version is disabled  and Parser raise UnknownOptionError
            return errs.Any(x => (x is UnknownOptionError ee ? ee.Token : "") == "version");
        }

Output()

static TextWriter CommandLine.HelpTextExtensions.Output ( this IEnumerable< Error >  errs )

static

redirect errs to Console.Error, and to Console.Out for help/version error

Definition at line 45 of file HelpTextExtensions.cs.

        {
            if (errs.IsHelp() || errs.IsVersion())
            {
                return Console.Out;
            }
 
            return Console.Error;
        }

---

The documentation for this class was generated from the following file:

• deps/commandlineparser/src/CommandLine/HelpTextExtensions.cs