Merge pull request #60 from T0shik/master

WSL Support

Author: EEParker

.gitignore

@@ -1,6 +1,8 @@
 
 #Ignore thumbnails created by Windows
 Thumbs.db
+#Ignore .idea
+*.idea
 #Ignore files built by Visual Studio
 *.obj
 *.exe

src/VueCliMiddleware/Util/Internals.cs

@@ -166,7 +166,7 @@ private async Task Run()
                 // get all the newlines
                 while ((lineBreakPos = Array.IndexOf(buf, '\n', startPos, chunkLength - startPos)) >= 0 && startPos < chunkLength)
                 {
-                    var length = (lineBreakPos + 1) - startPos;
+                    var length = lineBreakPos - startPos;
                     _linesBuffer.Append(buf, startPos, length);
                     OnCompleteLine(_linesBuffer.ToString());
                     _linesBuffer.Clear();

src/VueCliMiddleware/Util/ScriptRunner.cs

@@ -24,7 +24,7 @@ internal class ScriptRunner
 
         public ScriptRunnerType Runner { get; }
 
-        private string GetExeName()        
+        private string GetExeName()
         {
             switch (Runner)
             {
@@ -64,7 +64,7 @@ public void Kill()
             try { RunnerProcess?.WaitForExit(); } catch { }
         }
 
-        public ScriptRunner(string workingDirectory, string scriptName, string arguments, IDictionary<string, string> envVars, ScriptRunnerType runner)
+        public ScriptRunner(string workingDirectory, string scriptName, string arguments, IDictionary<string, string> envVars, ScriptRunnerType runner, bool wsl)
         {
             if (string.IsNullOrEmpty(workingDirectory))
             {
@@ -83,11 +83,19 @@ public ScriptRunner(string workingDirectory, string scriptName, string arguments
 
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
-                // On Windows, the NPM executable is a .cmd file, so it can't be executed
-                // directly (except with UseShellExecute=true, but that's no good, because
-                // it prevents capturing stdio). So we need to invoke it via "cmd /c".
-                completeArguments = $"/c {exeName} {completeArguments}";
-                exeName = "cmd";
+                if (wsl)
+                {
+                    completeArguments = $"{exeName} {completeArguments}";
+                    exeName = "wsl";
+                }
+                else
+                {
+                    // On Windows, the NPM executable is a .cmd file, so it can't be executed
+                    // directly (except with UseShellExecute=true, but that's no good, because
+                    // it prevents capturing stdio). So we need to invoke it via "cmd /c".
+                    completeArguments = $"/c {exeName} {completeArguments}";
+                    exeName = "cmd";
+                }
             }
 
             var processStartInfo = new ProcessStartInfo(exeName)
@@ -124,8 +132,15 @@ public void AttachToLogger(ILogger logger)
                     // NPM tasks commonly emit ANSI colors, but it wouldn't make sense to forward
                     // those to loggers (because a logger isn't necessarily any kind of terminal)
                     //logger.LogInformation(StripAnsiColors(line).TrimEnd('\n'));
-                    // making this console for debug purpose 
-                    Console.Write(line);
+                    // making this console for debug purpose
+                    if (line.StartsWith("<s>"))
+                    {
+                        Console.Error.WriteLine(line.Substring(3));
+                    }
+                    else
+                    {
+                        Console.Error.WriteLine(line);
+                    }
                 }
             };
 
@@ -135,7 +150,14 @@ public void AttachToLogger(ILogger logger)
                 {
                     //logger.LogError(StripAnsiColors(line).TrimEnd('\n'));
                     // making this console for debug purpose
-                    Console.Error.Write(line);
+                    if (line.StartsWith("<s>"))
+                    {
+                        Console.Error.WriteLine(line.Substring(3));
+                    }
+                    else
+                    {
+                        Console.Error.WriteLine(line);
+                    }
                 }
             };
 

src/VueCliMiddleware/VueDevelopmentServerMiddleware.cs

@@ -18,7 +18,13 @@ internal static class VueCliMiddleware
 
         public static void Attach(
             ISpaBuilder spaBuilder,
-            string scriptName, int port = 8080, bool https = false, ScriptRunnerType runner = ScriptRunnerType.Npm, string regex = DefaultRegex, bool forceKill = false)
+            string scriptName,
+            int port = 8080,
+            bool https = false,
+            ScriptRunnerType runner = ScriptRunnerType.Npm,
+            string regex = DefaultRegex,
+            bool forceKill = false,
+            bool wsl = false)
         {
             var sourcePath = spaBuilder.Options.SourcePath;
             if (string.IsNullOrEmpty(sourcePath))
@@ -34,7 +40,7 @@ public static void Attach(
             // Start vue-cli and attach to middleware pipeline
             var appBuilder = spaBuilder.ApplicationBuilder;
             var logger = LoggerFinder.GetOrCreateLogger(appBuilder, LogCategoryName);
-            var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex, forceKill);
+            var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex, forceKill, wsl);
 
             // Everything we proxy is hardcoded to target localhost because:
             // - the requests are always from the local machine (we're not accepting remote
@@ -55,7 +61,14 @@ public static void Attach(
         }
 
         private static async Task<int> StartVueCliServerAsync(
-            string sourcePath, string npmScriptName, ILogger logger, int portNumber, ScriptRunnerType runner, string regex, bool forceKill = false)
+            string sourcePath,
+            string npmScriptName,
+            ILogger logger,
+            int portNumber,
+            ScriptRunnerType runner,
+            string regex,
+            bool forceKill = false,
+            bool wsl = false)
         {
             if (portNumber < 80)
             {
@@ -76,7 +89,7 @@ private static async Task<int> StartVueCliServerAsync(
                 { "BROWSER", "none" }, // We don't want vue-cli to open its own extra browser window pointing to the internal dev server port
             };
 
-            var npmScriptRunner = new ScriptRunner(sourcePath, npmScriptName, $"--port {portNumber:0}", envVars, runner: runner);
+            var npmScriptRunner = new ScriptRunner(sourcePath, npmScriptName, $"--port {portNumber:0}", envVars, runner: runner, wsl: wsl);
             AppDomain.CurrentDomain.DomainUnload += (s, e) => npmScriptRunner?.Kill();
             AppDomain.CurrentDomain.ProcessExit += (s, e) => npmScriptRunner?.Kill();
             AppDomain.CurrentDomain.UnhandledException += (s, e) => npmScriptRunner?.Kill();

src/VueCliMiddleware/VueDevelopmentServerMiddlewareExtensions.cs

@@ -25,14 +25,17 @@ public static class VueCliMiddlewareExtensions
         /// <param name="https">Specify vue cli server schema </param>
         /// <param name="runner">Specify the runner, Npm and Yarn are valid options. Yarn support is HIGHLY experimental.</param>
         /// <param name="regex">Specify a custom regex string to search for in the log indicating proxied server is running. VueCli: "running at", QuasarCli: "Compiled successfully"</param>
+        /// <param name="forceKill"></param>
+        /// <param name="wsl"></param>
         public static void UseVueCli(
             this ISpaBuilder spaBuilder,
             string npmScript = "serve",
             int port = 8080,
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
             if (spaBuilder == null)
             {
@@ -46,7 +49,7 @@ public static void UseVueCli(
                 throw new InvalidOperationException($"To use {nameof(UseVueCli)}, you must supply a non-empty value for the {nameof(SpaOptions.SourcePath)} property of {nameof(SpaOptions)} when calling {nameof(SpaApplicationBuilderExtensions.UseSpa)}.");
             }
 
-            VueCliMiddleware.Attach(spaBuilder, npmScript, port, https: https, runner: runner, regex: regex, forceKill: forceKill);
+            VueCliMiddleware.Attach(spaBuilder, npmScript, port, https: https, runner: runner, regex: regex, forceKill: forceKill, wsl: wsl);
         }
 
 
@@ -59,10 +62,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
             if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }
-            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, https, runner, regex, forceKill));
+            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, https, runner, regex, forceKill, wsl));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -74,11 +78,12 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
             if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }
             if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }
-            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, https, runner, regex, forceKill));
+            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, https, runner, regex, forceKill, wsl));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -89,9 +94,10 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
-            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, https, runner, regex, forceKill));
+            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, https, runner, regex, forceKill, wsl));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -102,10 +108,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
             if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }
-            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, https, runner, regex, forceKill));
+            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, https, runner, regex, forceKill, wsl));
         }
 
 
@@ -118,7 +125,8 @@ private static RequestDelegate CreateProxyRequestDelegate(
             bool https = false,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
             string regex = VueCliMiddleware.DefaultRegex,
-            bool forceKill = false)
+            bool forceKill = false,
+            bool wsl = false)
         {
             // based on CreateRequestDelegate() https://github.com/aspnet/AspNetCore/blob/master/src/Middleware/StaticFiles/src/StaticFilesEndpointRouteBuilderExtensions.cs#L194
 
@@ -146,7 +154,7 @@ private static RequestDelegate CreateProxyRequestDelegate(
 
                 if (!string.IsNullOrWhiteSpace(npmScript))
                 {
-                    opt.UseVueCli(npmScript, port, https, runner, regex, forceKill);
+                    opt.UseVueCli(npmScript, port, https, runner, regex, forceKill, wsl);
                 }
             });