Improve method docs and fix template builds

Author: JamJar00

FileTemplater.cs

@@ -3,8 +3,19 @@
 
 namespace DarkRift.Cli
 {
+    /// <summary>
+    ///     Handles templating of generated files.
+    /// </summary>
     class FileTemplater
     {
+        /// <summary>
+        ///     Template the given path file's path and content.
+        /// </summary>
+        /// <param name="filePath">The path of the file.</param>
+        /// <param name="resourceName">The name of the resource being created.</param>
+        /// <param name="darkriftVersion">The version of DarkRift being used.</param>
+        /// <param name="tier">The tier of DarkRift being used.</param>
+        /// <param name="platform">The platform the DarkRift being used was built for.</param>
         public static void TemplateFileAndPath(string filePath, string resourceName, string darkriftVersion, ServerTier tier, ServerPlatform platform)
         {
             string resolvedPath = TemplateString(filePath, resourceName, darkriftVersion, tier, platform);
@@ -24,6 +35,14 @@ public static void TemplateFileAndPath(string filePath, string resourceName, str
                 File.Delete(resolvedPath);
         }
 
+        /// <summary>
+        ///     Template the given string.
+        /// </summary>
+        /// <param name="text">The string to template.</param>
+        /// <param name="resourceName">The name of the resource being created.</param>
+        /// <param name="darkriftVersion">The version of DarkRift being used.</param>
+        /// <param name="tier">The tier of DarkRift being used.</param>
+        /// <param name="platform">The platform the DarkRift being used was built for.</param>
         private static string TemplateString(string text, string resourceName, string darkriftVersion, ServerTier tier, ServerPlatform platform)
         {
             // Keep files containing __k__

Program.cs

@@ -35,7 +35,7 @@ class NewOptions
             public string Version { get; set; }
 
             [Option('p', "pro", Default = false, HelpText = "Use the pro version.")]
-            public bool Tier { get; set; }
+            public bool Pro { get; set; }
 
             [Option('s', "platform", Default = ServerPlatform.Framework, HelpText = "Specify the .NET platform of the server to use.")]
             public ServerPlatform Platform { get; set; }
@@ -104,11 +104,16 @@ private static int New(NewOptions opts)
 
             Console.WriteLine($"Cleaning up extracted artifacts...");
 
+            string version = opts.Version ?? VersionManager.GetLatestDarkRiftVersion();
+
             foreach (string path in Directory.GetFiles(targetDirectory, "*.*", SearchOption.AllDirectories))
-                FileTemplater.TemplateFileAndPath(path, Path.GetFileName(targetDirectory), opts.Version ?? VersionManager.GetLatestDarkRiftVersion(), opts.Tier ? ServerTier.Pro : ServerTier.Free, opts.Platform);
+                FileTemplater.TemplateFileAndPath(path, Path.GetFileName(targetDirectory), version, opts.Pro ? ServerTier.Pro : ServerTier.Free, opts.Platform);
 
             Console.WriteLine(Output.Green($"Created '{Path.GetFileName(targetDirectory)}'"));
 
+            // Make sure that the given DarkRift version is actually downloaded.
+            VersionManager.GetInstallationPath(version, opts.Pro ? ServerTier.Pro : ServerTier.Free, opts.Platform);
+
             return 0;
         }
 
@@ -122,7 +127,7 @@ private static int Run(RunOptions opts)
                 project.Save();
             }
 
-            string path = VersionManager.GetInstallationPath(Version.Parse(project.Runtime.Version), project.Runtime.Tier, project.Runtime.Platform);
+            string path = VersionManager.GetInstallationPath(project.Runtime.Version, project.Runtime.Tier, project.Runtime.Platform);
             if (path == null)
                 return 1;
 
@@ -191,7 +196,7 @@ private static int Get(GetOptions opts)
 
         private static int Pull(PullOptions opts)
         {
-            string path = VersionManager.GetInstallationPath(Version.Parse(opts.Version), opts.Tier ? ServerTier.Pro : ServerTier.Free, opts.Platform);
+            string path = VersionManager.GetInstallationPath(opts.Version, opts.Tier ? ServerTier.Pro : ServerTier.Free, opts.Platform);
 
             if (path == null)
                 return 1;

VersionManager.cs

@@ -28,9 +28,9 @@ class VersionManager
         /// <param name="pro">Whether the pro version should be used.</param>
         /// <param name="netStandard">Whether the .NET Standard build should be used.</param>
         /// <returns>The path to the installation, or null, if it cannot be provided.</returns>
-        public static string GetInstallationPath(Version version, ServerTier tier, ServerPlatform platform)
+        public static string GetInstallationPath(string version, ServerTier tier, ServerPlatform platform)
         {
-            string fullPath = Path.Combine(USER_DR_DIR, "installed", tier.ToString().ToLower(), platform.ToString().ToLower(), version.ToString());
+            string fullPath = Path.Combine(USER_DR_DIR, "installed", tier.ToString().ToLower(), platform.ToString().ToLower(), version);
 
             if (!Directory.Exists(fullPath))
             {

templates/log-writer/__n____c__.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Reference Include="DarkRift" />
-    <Reference Include="DarkRift.Server" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/Free/Framework/2.3.1/Lib/DarkRift.dll" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/Free/Framework/2.3.1/Lib/DarkRift.Server.dll" />
   </ItemGroup>
 </Project>

templates/log-writer/src/LogWriter1__c__.cs

@@ -2,7 +2,7 @@
 
 using DarkRift.Server;
 
-namespace $__n__
+namespace __n__
 {
     /// <summary>
     /// A simple log writer that outputs to standard out.

templates/network-listener/__n____c__.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Reference Include="DarkRift" />
-    <Reference Include="DarkRift.Server" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/Free/Framework/2.3.1/Lib/DarkRift.dll" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/Free/Framework/2.3.1/Lib/DarkRift.Server.dll" />
   </ItemGroup>
 </Project>

templates/network-listener/src/NetworkListener1__c__.cs

@@ -3,7 +3,7 @@
 using DarkRift;
 using DarkRift.Server;
 
-namespace $__n__
+namespace __n__
 {
     /// <summary>
     /// A simple network listener template.

templates/network-listener/src/NetworkServerConnection1__c__.cs

@@ -3,7 +3,7 @@
 using DarkRift;
 using DarkRift.Server;
 
-namespace $__n__
+namespace __n__
 {
     /// <summary>
     /// An unimplemented NetworkServerConnection.

templates/plugin/__n____c__.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Reference Include="DarkRift" />
-    <Reference Include="DarkRift.Server" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/__t__/__p__/__v__/Lib/DarkRift.dll" />
+    <Reference Include="$(UserProfile)/.darkrift/installed/__t__/__p__/__v__/Lib/DarkRift.Server.dll" />
   </ItemGroup>
 </Project>

templates/plugin/src/Plugin1__c__.cs

@@ -3,7 +3,7 @@
 using DarkRift;
 using DarkRift.Server;
 
-namespace $__n__
+namespace __n__
 {
     /// <summary>
     /// A simple command that relays messages to all clients