added HelpCommand meta

filipw · filipw · commit 8e7d6521b277 · 2014-12-21T15:24:40.000+01:00
diff --git a/src/ScriptCs.Contracts/IReplCommand.cs b/src/ScriptCs.Contracts/IReplCommand.cs
@@ -2,6 +2,8 @@
 {
     public interface IReplCommand
     {
+        string Description { get; }
+
         string CommandName { get; }
 
         object Execute(IScriptExecutor repl, object[] args);
diff --git a/src/ScriptCs.Core/ReplCommands/CdCommand.cs b/src/ScriptCs.Core/ReplCommands/CdCommand.cs
@@ -5,6 +5,11 @@ namespace ScriptCs.ReplCommands
 {
     public class CdCommand : IReplCommand
     {
+        public string Description
+        {
+            get { return "Changes the working directory to the path provided."; }
+        }
+
         public string CommandName
         {
             get { return "cd"; }
diff --git a/src/ScriptCs.Core/ReplCommands/ClearCommand.cs b/src/ScriptCs.Core/ReplCommands/ClearCommand.cs
@@ -6,6 +6,11 @@ public class ClearCommand : IReplCommand
     {
         private readonly IConsole _console;
 
+        public string Description
+        {
+            get { return "Clears the console window."; }
+        }
+
         public ClearCommand(IConsole console)
         {
             Guard.AgainstNullArgument("console", console);
diff --git a/src/ScriptCs.Core/ReplCommands/CwdCommand.cs b/src/ScriptCs.Core/ReplCommands/CwdCommand.cs
@@ -14,6 +14,11 @@ public CwdCommand(IConsole console)
             _console = console;
         }
 
+        public string Description
+        {
+            get { return "Displays the current working directory."; }
+        }
+
         public string CommandName
         {
             get { return "cwd"; }
diff --git a/src/ScriptCs.Core/ReplCommands/HelpCommand.cs b/src/ScriptCs.Core/ReplCommands/HelpCommand.cs
@@ -1,4 +1,5 @@
-﻿using ScriptCs.Contracts;
+﻿using System.Linq;
+using ScriptCs.Contracts;
 
 namespace ScriptCs.ReplCommands
 {
@@ -11,6 +12,11 @@ public HelpCommand(IConsole console)
             _console = console;
         }
 
+        public string Description
+        {
+            get { return "Shows this help."; }
+        }
+
         public string CommandName
         {
             get { return "help"; }
@@ -22,9 +28,9 @@ public object Execute(IScriptExecutor repl, object[] args)
             if (typedRepl != null)
             {
                 _console.WriteLine("The following commands are available in the REPL:");
-                foreach (var command in typedRepl.Commands)
+                foreach (var command in typedRepl.Commands.OrderBy(x => x.CommandName))
                 {
-                    _console.WriteLine(string.Format(":{0}", command.CommandName));
+                    _console.WriteLine(string.Format(":{0,-15}{1,10}", command.CommandName, command.Description));
                 }
             }
 
diff --git a/src/ScriptCs.Core/ReplCommands/InstallCommand.cs b/src/ScriptCs.Core/ReplCommands/InstallCommand.cs
@@ -30,6 +30,11 @@ public InstallCommand(
             _installationProvider = installationProvider;
         }
 
+        public string Description
+        {
+            get { return "Installs a Nuget package. I.e. :install <package> <version>"; }
+        }
+
         public string CommandName
         {
             get { return "install"; }
diff --git a/src/ScriptCs.Core/ReplCommands/ReferencesCommand.cs b/src/ScriptCs.Core/ReplCommands/ReferencesCommand.cs
@@ -10,6 +10,11 @@ public string CommandName
             get { return "references"; }
         }
 
+        public string Description
+        {
+            get { return "Displays a list of assemblies referenced from the REPL context."; }
+        }
+
         public object Execute(IScriptExecutor repl, object[] args)
         {
             if (repl.References != null)
diff --git a/src/ScriptCs.Core/ReplCommands/ResetCommand.cs b/src/ScriptCs.Core/ReplCommands/ResetCommand.cs
@@ -4,6 +4,11 @@ namespace ScriptCs.ReplCommands
 {
     public class ResetCommand : IReplCommand
     {
+        public string Description
+        {
+            get { return "Resets the REPL state. All local variables and member definitions are cleared."; }
+        }
+
         public string CommandName
         {
             get { return "reset"; }
diff --git a/src/ScriptCs.Core/ReplCommands/UsingsCommand.cs b/src/ScriptCs.Core/ReplCommands/UsingsCommand.cs
@@ -4,6 +4,11 @@ namespace ScriptCs.ReplCommands
 {
     public class UsingsCommand : IReplCommand
     {
+        public string Description
+        {
+            get { return "Displays a list of namespaces imported into REPL context."; }
+        }
+
         public string CommandName
         {
             get { return "usings"; }
diff --git a/src/ScriptCs.Core/ReplCommands/VarsCommand.cs b/src/ScriptCs.Core/ReplCommands/VarsCommand.cs
@@ -9,6 +9,11 @@ public string CommandName
             get { return "vars"; }
         }
 
+        public string Description
+        {
+            get { return "Displays a list of variables defined within the REPL, along with their types and values."; }
+        }
+
         public object Execute(IScriptExecutor repl, object[] args)
         {
             var replEngine = repl.ScriptEngine as IReplEngine;

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`{`
`3`	`3`	`public interface IReplCommand`
`4`	`4`	`{`
	`5`	`+ string Description { get; }`
	`6`	`+`
`5`	`7`	`string CommandName { get; }`
`6`	`8`
`7`	`9`	`object Execute(IScriptExecutor repl, object[] args);`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,11 @@ namespace ScriptCs.ReplCommands`
`5`	`5`	`{`
`6`	`6`	`public class CdCommand : IReplCommand`
`7`	`7`	`{`
	`8`	`+ public string Description`
	`9`	`+ {`
	`10`	`+ get { return "Changes the working directory to the path provided."; }`
	`11`	`+ }`
	`12`	`+`
`8`	`13`	`public string CommandName`
`9`	`14`	`{`
`10`	`15`	`get { return "cd"; }`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,11 @@ public class ClearCommand : IReplCommand`
`6`	`6`	`{`
`7`	`7`	`private readonly IConsole _console;`
`8`	`8`
	`9`	`+ public string Description`
	`10`	`+ {`
	`11`	`+ get { return "Clears the console window."; }`
	`12`	`+ }`
	`13`	`+`
`9`	`14`	`public ClearCommand(IConsole console)`
`10`	`15`	`{`
`11`	`16`	`Guard.AgainstNullArgument("console", console);`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,11 @@ public CwdCommand(IConsole console)`
`14`	`14`	`_console = console;`
`15`	`15`	`}`
`16`	`16`
	`17`	`+ public string Description`
	`18`	`+ {`
	`19`	`+ get { return "Displays the current working directory."; }`
	`20`	`+ }`
	`21`	`+`
`17`	`22`	`public string CommandName`
`18`	`23`	`{`
`19`	`24`	`get { return "cwd"; }`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using ScriptCs.Contracts;`
	`1`	`+using System.Linq;`
	`2`	`+using ScriptCs.Contracts;`
`2`	`3`
`3`	`4`	`namespace ScriptCs.ReplCommands`
`4`	`5`	`{`
`@@ -11,6 +12,11 @@ public HelpCommand(IConsole console)`
`11`	`12`	`_console = console;`
`12`	`13`	`}`
`13`	`14`
	`15`	`+ public string Description`
	`16`	`+ {`
	`17`	`+ get { return "Shows this help."; }`
	`18`	`+ }`
	`19`	`+`
`14`	`20`	`public string CommandName`
`15`	`21`	`{`
`16`	`22`	`get { return "help"; }`
`@@ -22,9 +28,9 @@ public object Execute(IScriptExecutor repl, object[] args)`
`22`	`28`	`if (typedRepl != null)`
`23`	`29`	`{`
`24`	`30`	`_console.WriteLine("The following commands are available in the REPL:");`
`25`		`- foreach (var command in typedRepl.Commands)`
	`31`	`+ foreach (var command in typedRepl.Commands.OrderBy(x => x.CommandName))`
`26`	`32`	`{`
`27`		`- _console.WriteLine(string.Format(":{0}", command.CommandName));`
	`33`	`+ _console.WriteLine(string.Format(":{0,-15}{1,10}", command.CommandName, command.Description));`
`28`	`34`	`}`
`29`	`35`	`}`
`30`	`36`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@ public InstallCommand(`
`30`	`30`	`_installationProvider = installationProvider;`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ public string Description`
	`34`	`+ {`
	`35`	`+ get { return "Installs a Nuget package. I.e. :install <package> <version>"; }`
	`36`	`+ }`
	`37`	`+`
`33`	`38`	`public string CommandName`
`34`	`39`	`{`
`35`	`40`	`get { return "install"; }`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,11 @@ public string CommandName`
`10`	`10`	`get { return "references"; }`
`11`	`11`	`}`
`12`	`12`
	`13`	`+ public string Description`
	`14`	`+ {`
	`15`	`+ get { return "Displays a list of assemblies referenced from the REPL context."; }`
	`16`	`+ }`
	`17`	`+`
`13`	`18`	`public object Execute(IScriptExecutor repl, object[] args)`
`14`	`19`	`{`
`15`	`20`	`if (repl.References != null)`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,11 @@ namespace ScriptCs.ReplCommands`
`4`	`4`	`{`
`5`	`5`	`public class ResetCommand : IReplCommand`
`6`	`6`	`{`
	`7`	`+ public string Description`
	`8`	`+ {`
	`9`	`+ get { return "Resets the REPL state. All local variables and member definitions are cleared."; }`
	`10`	`+ }`
	`11`	`+`
`7`	`12`	`public string CommandName`
`8`	`13`	`{`
`9`	`14`	`get { return "reset"; }`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,11 @@ namespace ScriptCs.ReplCommands`
`4`	`4`	`{`
`5`	`5`	`public class UsingsCommand : IReplCommand`
`6`	`6`	`{`
	`7`	`+ public string Description`
	`8`	`+ {`
	`9`	`+ get { return "Displays a list of namespaces imported into REPL context."; }`
	`10`	`+ }`
	`11`	`+`
`7`	`12`	`public string CommandName`
`8`	`13`	`{`
`9`	`14`	`get { return "usings"; }`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,11 @@ public string CommandName`
`9`	`9`	`get { return "vars"; }`
`10`	`10`	`}`
`11`	`11`
	`12`	`+ public string Description`
	`13`	`+ {`
	`14`	`+ get { return "Displays a list of variables defined within the REPL, along with their types and values."; }`
	`15`	`+ }`
	`16`	`+`
`12`	`17`	`public object Execute(IScriptExecutor repl, object[] args)`
`13`	`18`	`{`
`14`	`19`	`var replEngine = repl.ScriptEngine as IReplEngine;`