Merge pull request #116 from pascalberger/feature/version-settings-aliases

(GH-115) Add overloads for NpmVersion which accept a settings object

Author: pascalberger

src/Cake.Npm/NpmVersionAliases.cs

@@ -33,11 +33,73 @@ public static string NpmVersion(this ICakeContext context)
             }
 
             AddinInformation.LogVersionInformation(context.Log);
-            var settings = new NpmVersionSettings
+            return context.NpmVersion(new NpmVersionSettings());
+        }
+
+        /// <summary>
+        /// Versions all packages for the project in the current working directory
+        /// using the settings returned by a configurator.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="configurator">The settings configurator.</param>
+        /// <example>
+        /// <code>
+        /// <![CDATA[
+        ///     var versionString = NpmVersion(settings => settings.WithLogLevel(NpmLogLevel.Verbose));
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Version")]
+        public static string NpmVersion(this ICakeContext context, Action<NpmVersionSettings> configurator)
+        {
+            if (context == null)
+            {
+                throw new ArgumentNullException(nameof(context));
+            }
+
+            if (configurator == null)
+            {
+                throw new ArgumentNullException(nameof(configurator));
+            }
+
+            var settings = new NpmVersionSettings();
+            configurator(settings);
+            return context.NpmVersion(settings);
+        }
+
+        /// <summary>
+        /// Versions all packages for the project in the current working directory
+        /// using the specified settings.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="settings">The settings.</param>
+        /// <example>
+        /// <code>
+        /// <![CDATA[
+        ///     var settings = new NpmVersionSettings();
+        ///     settings.WithLogLevel(NpmLogLevel.Verbose);
+        ///     var versionString = NpmVersion(settings);
+        /// ]]>
+        /// </code>
+        /// </example>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Version")]
+        public static string NpmVersion(this ICakeContext context, NpmVersionSettings settings)
+        {
+            if (context == null)
             {
-                RedirectStandardOutput = true
-            };
-            return new NpmVersionTool(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools, context.Log).Version(settings);
+                throw new ArgumentNullException(nameof(context));
+            }
+
+            if (settings == null)
+            {
+                throw new ArgumentNullException(nameof(settings));
+            }
+
+            AddinInformation.LogVersionInformation(context.Log);
+            var tool = new NpmVersionTool(context.FileSystem, context.Environment, context.ProcessRunner, context.Tools, context.Log);
+            return tool.Version(settings);
         }
     }
 }

src/Cake.Npm/Version/NpmVersionSettings.cs

@@ -14,6 +14,8 @@ public class NpmVersionSettings : NpmSettings
         public NpmVersionSettings()
             : base("version")
         {
+            // Since 'NpmVersion' returns a string we should redirect standard output.
+            RedirectStandardOutput = true;
         }
     }
 }