Merge pull request #8 from pascalberger/feature/alias-category

Update alias categories
This commit is contained in:
C. Augusto Proiete 2021-05-16 03:36:00 -03:00 committed by GitHub
commit b43b2a19e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -7,7 +7,7 @@ namespace Cake.ArgumentHelpers {
/// <summary> /// <summary>
/// Contains Aliases for helping work with combinations of Argument and Environment variables. /// Contains Aliases for helping work with combinations of Argument and Environment variables.
/// </summary> /// </summary>
[CakeAliasCategory("Argument")] [CakeAliasCategory("Arguments")]
[CakeAliasCategory("Environment")] [CakeAliasCategory("Environment")]
public static class ArgumentOrEnvironmentVariableAlias { public static class ArgumentOrEnvironmentVariableAlias {
/// <summary> /// <summary>
@ -17,8 +17,7 @@ namespace Cake.ArgumentHelpers {
/// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param> /// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument or environment variable")]
[CakeAliasCategory("Environment")]
public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, bool defaultValue) { public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, bool defaultValue) {
return ArgumentAliases.Argument(context, name, EnvironmentAliases.EnvironmentVariable(context, (environmentNamePrefix ?? "") + name) ?? defaultValue.ToString()).Equals("true", StringComparison.OrdinalIgnoreCase); return ArgumentAliases.Argument(context, name, EnvironmentAliases.EnvironmentVariable(context, (environmentNamePrefix ?? "") + name) ?? defaultValue.ToString()).Equals("true", StringComparison.OrdinalIgnoreCase);
} }
@ -29,8 +28,7 @@ namespace Cake.ArgumentHelpers {
/// <param name="name">The argument name to attempt to find in either the command line parameters or environment variables.</param> /// <param name="name">The argument name to attempt to find in either the command line parameters or environment variables.</param>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument or environment variable")]
[CakeAliasCategory("Environment")]
public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, bool defaultValue) { public static bool ArgumentOrEnvironmentVariable(this ICakeContext context, string name, bool defaultValue) {
return context.ArgumentOrEnvironmentVariable(name, null, defaultValue); return context.ArgumentOrEnvironmentVariable(name, null, defaultValue);
} }
@ -42,8 +40,7 @@ namespace Cake.ArgumentHelpers {
/// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param> /// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument or environment variable")]
[CakeAliasCategory("Environment")]
public static string ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, string defaultValue) { public static string ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix, string defaultValue) {
return ArgumentAliases.Argument<string>(context, name, EnvironmentAliases.EnvironmentVariable(context, environmentNamePrefix + name)) ?? defaultValue; return ArgumentAliases.Argument<string>(context, name, EnvironmentAliases.EnvironmentVariable(context, environmentNamePrefix + name)) ?? defaultValue;
} }
@ -55,8 +52,7 @@ namespace Cake.ArgumentHelpers {
/// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param> /// <param name="environmentNamePrefix">An optional prefix used to qualify the same variable name when present in EnvironmentVariable form (e.g., "MySetting" command-line argument vs. "MyTool_MySetting" environment variable).</param>
/// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns> /// <returns>Value found or default, first checked in command-line argument, then environment variable.</returns>
[CakeMethodAlias] [CakeMethodAlias]
[CakeAliasCategory("Argument")] [CakeAliasCategory("Argument or environment variable")]
[CakeAliasCategory("Environment")]
public static string ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix) public static string ArgumentOrEnvironmentVariable(this ICakeContext context, string name, string environmentNamePrefix)
{ {
return ArgumentOrEnvironmentVariable(context, name, environmentNamePrefix, null); return ArgumentOrEnvironmentVariable(context, name, environmentNamePrefix, null);