release 1.0.9 fix get vars exception when convert from null + fix comments + integrated xml code spec for intellisense

Author: franck-gaspoz

OrbitalShell-CLI/OrbitalShell-CLI.csproj

@@ -17,8 +17,8 @@
     <Product>Orbital Shell</Product>
     <Description>This is the Orbital Shell CLI binaries for any plateform (having dotnet) and also self-contained apps for common runtimes environments (win-x64,linux-x64,linux-musl-x64,linux-arm,linux-arm64). Orbital Shell is a command shell based inspired by bash and POSIX recommendations, coded in C# .Net Core.</Description>
     <Copyright>(c) 2020 Licence MIT</Copyright>
-    <Version>1.0.8</Version>
-    <InformationalVersion>1.0.8</InformationalVersion>
+    <Version>1.0.9</Version>
+    <InformationalVersion>1.0.9</InformationalVersion>
 
     <PackageReleaseNotes>initial stable release (milestone 1)</PackageReleaseNotes>
     <ApplicationIcon>assets\robotazteque.ico</ApplicationIcon>
@@ -54,6 +54,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <Optimize>false</Optimize>
     <DocumentationFile>bin/Debug/net5.0/orbsh.xml</DocumentationFile>
+    <NoWarn>1701;1702;1591;1572;1573</NoWarn>
   </PropertyGroup>
 
 

OrbitalShell-CLI/Program.cs

@@ -1,6 +1,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
+using OrbitalShell.Component.Shell;
 
 namespace OrbitalShell
 {
@@ -18,7 +19,8 @@ static int Main(string[] args)
             var scope = App.Host.Services.CreateScope();
             si.ScopedServiceProvider = scope.ServiceProvider;
 
-            var returnCode = Shell.Startup(scope.ServiceProvider,args);
+            var shellStartup = scope.ServiceProvider.GetRequiredService<IShellStartup>();
+            var returnCode = shellStartup.Startup(args);
 
             App.Host.RunAsync().Wait();
 

OrbitalShell-CLI/Scripts/publish-kernel-packages.sh

@@ -9,10 +9,14 @@ echo "(b=darkgreen,f=black) build/publish orbital shell kernel packages (rdc)"
 echo "(b=darkgreen,f=black)                                             "
 echo
 proj
-dotnet build OrbitalShell.sln -c Debug
+#dotnet build OrbitalShell.sln -c Release
 
-nuget-push OrbitalShell-ConsoleApp/bin/Debug/OrbitalShell-ConsoleApp.$version $key
-nuget-push OrbitalShell-Kernel/bin/Debug/OrbitalShell-Kernel.$version $key
-nuget-push OrbitalShell-Kernel-Commands/bin/Debug/OrbitalShell-Kernel-Commands.$version $key
+#nuget-push OrbitalShell-ConsoleApp/bin/Debug/OrbitalShell-ConsoleApp.$version $key
+#nuget-push OrbitalShell-Kernel/bin/Debug/OrbitalShell-Kernel.$version $key
+#nuget-push OrbitalShell-Kernel-Commands/bin/Debug/OrbitalShell-Kernel-Commands.$version $key
+
+nuget-push OrbitalShell-ConsoleApp/bin/Release/OrbitalShell-ConsoleApp.$version $key
+nuget-push OrbitalShell-Kernel/bin/Release/OrbitalShell-Kernel.$version $key
+nuget-push OrbitalShell-Kernel-Commands/bin/Release/OrbitalShell-Kernel-Commands.$version $key
 
 echo "(b=darkgreen,f=yellow) Done. (rdc)"

OrbitalShell-CLI/ServicesInitializer.cs

@@ -57,6 +57,8 @@ public void InitializeServices(IHostBuilder hostBuilder)
                                     serviceProvider.GetRequiredService<ICommandLineProcessor>());
                                 return clr;
                             })
+                    .AddScoped
+                        <IShellStartup,ShellStartup>()
                     );
         }
     }

OrbitalShell-CLI/Shell.cs

@@ -0,0 +1,47 @@
+using OrbitalShell.Component.CommandLine.Reader;
+using OrbitalShell.Component.CommandLine.Processor;
+using OrbitalShell.Component.Console;
+using OrbitalShell.Component.Shell;
+using System;
+
+namespace OrbitalShell
+{
+    public class ShellStartup : IShellStartup
+    {
+        IConsole _cons;
+        ICommandLineProcessor _clp;
+        ICommandLineReader _clr;
+
+        public ShellStartup(
+            IServiceProvider serviceProvider,
+            IConsole console,
+            ICommandLineProcessor commandLineProcessor,
+            ICommandLineReader commandLineReader
+            )
+        {
+            _cons = console;
+            _clp = commandLineProcessor;
+            _clr = commandLineReader;
+        }
+
+        public int Startup(
+            string[] args)
+        {
+            _clp.SetArgs(args);
+
+            // prepare console
+
+            _cons.Out.Echo(ANSI.RIS);
+            _cons.Out.ClearScreen();
+
+            // invoke a shell initializer associated to the clp
+
+            var shellInitializer = new ShellInitializer(_clp);
+            shellInitializer.Run(_clp.CommandEvaluationContext);
+
+            // starts an interactive shell
+
+            return _clr.ReadCommandLine();
+        }
+    }
+}

OrbitalShell-CLI/ShellStartup.cs

@@ -10,8 +10,8 @@ namespace OrbitalShell
 
     /// <summary>
     /// console app bootstrap
-    /// <remarks>
     /// </summary>
+    /// <remarks>
     /// begin DI init
     /// </remarks>
     public static class App

OrbitalShell-ConsoleApp/App.cs

@@ -380,9 +380,9 @@ public static (SGR_4BitsColors color, bool bright) ParseSGR_4BitsColor(string s)
         /// 8- 15:  high intensity colors (as in ESC [ 90–97 m, see SGR_4BitsColors bright)<br/>
         /// 16-231:  6 × 6 × 6 cube (216 colors): 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)<br/>
         /// 232-255:  grayscale from black to white in 24 steps</para>
-        /// <para>format is {n},0<=n<=255</para>
+        /// <para>format is {n},0&lt;=n&lt;=255</para>
         /// </summary>
-        /// <param name="s">{n},0<=n<=255</param>
+        /// <param name="s">{n},0&lt;=n&lt;=255</param>
         /// <returns>ansi seq</returns>
         public static string SGRF8(object o)
         {
@@ -412,9 +412,9 @@ public static string SGRF8(object o)
         /// <summary>
         /// set foreground color - 24 bits 'true color' (for 16 or 24 bits palette graphic cards)
         /// <para>parameters are red,green,blue luminosity from 0 to 255</para>
-        /// <para>format is: {r}:{g}:{b} 0<=r<=255 0<=g<=255 0<=b<=255</para>
+        /// <para>format is: {r}:{g}:{b} 0&lt;=r&lt;=255 0&lt;=g&lt;=255 0&lt;=b&lt;=255</para>
         /// </summary>
-        /// <param name="s">{r}:{g}:{b} 0<=r<=255 0<=g<=255 0<=b<=255</param>
+        /// <param name="s">{r}:{g}:{b} 0&lt;=r&lt;=255 0&lt;=g&lt;=255 0&lt;=b&lt;=255</param>
         /// <returns>ansi seq</returns>
         public static string SGRF24(object o)
         {
@@ -465,7 +465,7 @@ public static string SGRB(object o)
         /// set background color - 8 bits palette (256 colors)
         /// <para>0-  7:  standard colors (as in ESC [ 30–37 m, see SGR_4BitsColors)<br/>
         /// 8- 15:  high intensity colors (as in ESC [ 90–97 m, see SGR_4BitsColors bright)<br/>
-        /// 16-231:  6 × 6 × 6 cube (216 colors): 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)<br/>
+        /// 16-231:  6 × 6 × 6 cube (216 colors): 16 + 36 × r + 6 × g + b (0 &lt;= r, g, b ≤ 5)<br/>
         /// 232-255:  grayscale from black to white in 24 steps</para>
         /// </summary>
         /// <param name="n">palette color index</param>
@@ -478,9 +478,9 @@ public static string SGRB(object o)
         /// 8- 15:  high intensity colors (as in ESC [ 90–97 m, see SGR_4BitsColors bright)<br/>
         /// 16-231:  6 × 6 × 6 cube (216 colors): 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)<br/>
         /// 232-255:  grayscale from black to white in 24 steps</para>
-        /// <para>format is {n},0<=n<=255</para>
+        /// <para>format is {n},0&lt;=n&lt;=255</para>
         /// </summary>
-        /// <param name="s">{n},0<=n<=255</param>
+        /// <param name="s">{n},0&lt;=n&lt;=255</param>
         /// <returns>ansi seq</returns>
         public static string SGRB8(object o)
         {
@@ -510,9 +510,9 @@ public static string SGRB8(object o)
         /// <summary>
         /// set background color - 24 bits 'true color' (for 16 or 24 bits palette graphic cards)
         /// <para>parameters are red,green,blue luminosity from 0 to 255</para>
-        /// <para>format is: {r}:{g}:{b} 0<=r<=255 0<=g<=255 0<=b<=255</para>
+        /// <para>format is: {r}:{g}:{b} 0&lt;=r&lt;=255 0&lt;=g&lt;=255 0&lt;=b&lt;=255</para>
         /// </summary>
-        /// <param name="s">{r}:{g}:{b} 0<=r<=255 0<=g<=255 0<=b<=255</param>
+        /// <param name="s">{r}:{g}:{b} 0&lt;=r&lt;=255 0&lt;=g&lt;=255 0&lt;=b&lt;=255</param>
         /// <returns>ansi seq</returns>
         public static string SGRB24(object o)
         {

OrbitalShell-ConsoleApp/Component/Console/ANSI.cs

@@ -93,7 +93,7 @@ public static int Parse8BitColor(IConsole console, object c)
         /// <summary>
         /// parse a 24 bit color
         /// </summary>
-        /// <param name="c">string of format: r:g:b where 0<=r,g,b<=255</param>
+        /// <param name="c">string of format: r:g:b where 0&lt;=r,g,b &lt;255</param>
         /// <returns></returns>
         public static (int r,int g,int b) Parse24BitColor(IConsole console, object c)
         {

OrbitalShell-ConsoleApp/Component/Console/TextColor.cs

@@ -345,10 +345,8 @@ public enum EchoDirectives
         /// </summary>
         SGR_RapidBlink,
 
-
         /// <summary>
-        /// 
-        /// </su
+        /// Reverse video
         /// </summary>
         SGR_ReverseVideo,
 
@@ -393,32 +391,32 @@ public enum EchoDirectives
         SGR_NormalIntensity,
 
         /// <summary>
-        /// Set foreground color - 3/4 bits palette mode : SGRF=0<=n<=7[,bright]
+        /// Set foreground color - 3/4 bits palette mode : SGRF=0&lt;=n&lt;=7[,bright]
         /// </summary>
         SGRF,
 
         /// <summary>
-        /// set foreground color - 8 bits palette (256 colors) : SGRF8=0<=n<=255
+        /// set foreground color - 8 bits palette (256 colors) : SGRF8=0&lt;=n&lt;=255
         /// </summary>
         SGRF8,
 
         /// <summary>
-        /// set foreground color - 24 bits 'true color' : SGRF24=0<=n<=255,0<=n<=255,0<=n<=255 (r,g,b)
+        /// set foreground color - 24 bits 'true color' : SGRF24=0&lt;=n&lt;=255,0&lt;=n&lt;=255,0&lt;=n&lt;=255 (r,g,b)
         /// </summary>
         SGRF24,
 
         /// <summary>
-        /// Set background color - 3/4 bits palette mode : SGRF=0<=n<=7[,bright]
+        /// Set background color - 3/4 bits palette mode : SGRF=0&lt;=n&lt;=7[,bright]
         /// </summary>
         SGRB,
 
         /// <summary>
-        /// set background color - 8 bits palette (256 colors) : SGRF8=0<=n<=255
+        /// set background color - 8 bits palette (256 colors) : SGRF8=0&lt;=n&lt;=255
         /// </summary>
         SGRB8,
 
         /// <summary>
-        /// set background color - 24 bits 'true color' : SGRF24=0<=n<=255,0<=n<=255,0<=n<=255 (r,g,b)
+        /// set background color - 24 bits 'true color' : SGRF24=0&lt;=n&lt;=255,0&lt;=n&lt;=255,0&lt;=n&lt;=255 (r,g,b)
         /// </summary>
         SGRB24,
 
@@ -457,12 +455,12 @@ public enum EchoDirectives
         f,
 
         /// <summary>
-        /// set foreground from 8 bits palette : f8=0<=n<=255
+        /// set foreground from 8 bits palette : f8=0&lt;=n&lt;=255
         /// </summary>
         f8,
 
         /// <summary>
-        /// set foreground from 24 bits color : f24=r:g:b with 0<=r,g,b<=255
+        /// set foreground from 24 bits color : f24=r:g:b with 0&lt;=r,g,b&lt;=255
         /// </summary>
         f24,
 
@@ -472,12 +470,12 @@ public enum EchoDirectives
         b,
 
         /// <summary>
-        /// set background from 8 bits palette : b8=0<=n<=255
+        /// set background from 8 bits palette : b8=0&lt;=n&lt;=255
         /// </summary>
         b8,
 
         /// <summary>
-        /// set background from 24 bits color : b24=r:g:b with 0<=r,g,b<=255
+        /// set background from 24 bits color : b24=r:g:b with 0&lt;=r,g,b&lt;=255
         /// </summary>
         b24,