add code examples to YarnRunner methods' xml

cake-contrib · Nov 5, 2016 · d3870d9 · d3870d9
1 parent abb7c3c
commit d3870d9
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cake.yarn",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "",
   "main": "index.js",
   "scripts": {

diff --git a/src/Cake.Yarn/Cake.Yarn.nuspec b/src/Cake.Yarn/Cake.Yarn.nuspec
@@ -11,7 +11,7 @@
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>A set of aliases for Cake to help with running Yarn (node package manager from Facebook) commands</description>
     <tags>Cake Script Build Yarn</tags>
-    <version>0.1.0</version>
+    <version>0.1.1</version>
   </metadata>
   <files>
     <file src="..\..\artifacts\build\Cake.Yarn.xml" target="lib\net45" />

diff --git a/src/Cake.Yarn/Properties/AssemblyInfo.cs b/src/Cake.Yarn/Properties/AssemblyInfo.cs
@@ -14,6 +14,6 @@
 [assembly: AssemblyCulture("")]
 [assembly: ComVisible(false)]
 [assembly: InternalsVisibleTo("Cake.Yarn.Tests")]
-[assembly: AssemblyVersion("0.1.0")]
-[assembly: AssemblyFileVersion("0.1.0")]
-[assembly: AssemblyInformationalVersion("0.1.0")]
+[assembly: AssemblyVersion("0.1.1")]
+[assembly: AssemblyFileVersion("0.1.1")]
+[assembly: AssemblyInformationalVersion("0.1.1")]
diff --git a/src/Cake.Yarn/YarnRunner.cs b/src/Cake.Yarn/YarnRunner.cs
@@ -59,6 +59,28 @@ public IYarnRunnerCommands FromPath(DirectoryPath path)
         /// execute 'yarn install' with options
         /// </summary>
         /// <param name="configure">options when running 'yarn install'</param>
+        /// <example>
+        /// <para>Run 'yarn install'</para>
+        /// <code>
+        /// <![CDATA[
+        /// Task("Yarn-FromPath")
+        ///     .Does(() =>
+        /// {
+        ///     Yarn.FromPath("./dir-with-packagejson").Install();
+        /// });
+        /// ]]>
+        /// </code>
+        /// <para>Run 'yarn install'</para>
+        /// <code>
+        /// <![CDATA[
+        /// Task("Yarn-Install")
+        ///     .Does(() =>
+        /// {
+        ///     Yarn.Install();
+        /// });
+        /// ]]>
+        /// </code>
+        /// </example>
         public IYarnRunnerCommands Install(Action<YarnInstallSettings> configure = null)
         {
             var settings = new YarnInstallSettings();
@@ -80,10 +102,33 @@ private static ProcessArgumentBuilder GetYarnInstallArguments(YarnInstallSetting
         #endregion
 
         #region yarn add
+
         /// <summary>
         /// execute 'yarn add' with options
         /// </summary>
         /// <param name="configure">options when running 'yarn install'</param>
+        /// <example>
+        /// <para>Run 'yarn add gulp'</para>
+        /// <code>
+        /// <![CDATA[
+        /// Task("Yarn-Add-Gulp")
+        ///     .Does(() =>
+        /// {
+        ///     Yarn.Add(settings => settings.Package("gulp"));
+        /// });
+        /// ]]>
+        /// </code>
+        /// <para>Run 'yarn global add gulp'</para>
+        /// <code>
+        /// <![CDATA[
+        /// Task("Yarn-Add-Gulp")
+        ///     .Does(() =>
+        /// {
+        ///     Yarn.Add(settings => settings.Package("gulp").Globally());
+        /// });
+        /// ]]>
+        /// </code>
+        /// </example>
         public IYarnRunnerCommands Add(Action<YarnAddSettings> configure = null)
         {
             var settings = new YarnAddSettings();
@@ -115,6 +160,18 @@ private static ProcessArgumentBuilder GetYarnAddArguments(YarnAddSettings settin
         /// </summary>
         /// <param name="scriptName">name of the </param>
         /// <param name="configure"></param>
+        /// <example>
+        /// <para>Run 'yarn run hello'</para>
+        /// <code>
+        /// <![CDATA[
+        /// Task("Yarn-Run")
+        ///     .Does(() =>
+        /// {
+        ///     Yarn.Run("hello");
+        /// });
+        /// ]]>
+        /// </code>
+        /// </example>
         public IYarnRunnerCommands RunScript(string scriptName, Action<YarnRunSettings> configure = null)
         {
             var settings = new YarnRunSettings(scriptName);

diff --git a/src/Cake.Yarn/YarnRunnerAliases.cs b/src/Cake.Yarn/YarnRunnerAliases.cs
@@ -45,7 +45,7 @@ public static class YarnRunnerAliases
         /// Task("Yarn-Add-Gulp")
         ///     .Does(() =>
         /// {
-        ///     Yarn.Add(settings => settings.Package("package"));
+        ///     Yarn.Add(settings => settings.Package("gulp"));
         /// });
         /// ]]>
         /// </code>
@@ -56,7 +56,7 @@ public static class YarnRunnerAliases
         /// Task("Yarn-Add-Gulp")
         ///     .Does(() =>
         /// {
-        ///     Yarn.Add(settings => settings.Package("package").Globally());
+        ///     Yarn.Add(settings => settings.Package("gulp").Globally());
         /// });
         /// ]]>
         /// </code>

diff --git a/usage/package.json b/usage/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cake.yarn",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "changing working directory for tool",
   "main": "index.js",
   "scripts": {