Merge pull request #2 from yuv4ik/usability_improvements

Strict ConvertToNetStandardHandler to support only C# portable libraries
yuv4ik · Mar 24, 2018 · ca321b4 · ca321b4
2 parents d6f293b + 3604014
commit ca321b4
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 28 deletions.
diff --git a/Mutatio/Consts.cs b/Mutatio/Consts.cs
@@ -0,0 +1,8 @@
+using System;
+namespace Mutatio
+{
+    public static class Consts
+    {
+        public const string ProjectUrl = "https://github.com/yuv4ik/mutatio";
+    }
+}
diff --git a/Mutatio/ConvertProjectToNetStandardHandler.cs b/Mutatio/ConvertProjectToNetStandardHandler.cs
@@ -15,7 +15,13 @@ public class ConvertProjectToNetStandardHandler : CommandHandler
 
         protected override void Update(CommandInfo info)
         {
-            info.Enabled = IsWorkspaceOpen() && ProjectIsNotBuildingOrRunning() && UserSelectedItemIsProject() && UserSelectedProjectIsNotNetStandard20();
+            info.Enabled =
+                IsWorkspaceOpen()
+                && ProjectIsNotBuildingOrRunning()
+                && UserSelectedItemIsProject()
+                && UserSelectedProjectIsPortableLibrary()
+                && UserSelectedProjectIsCSharpProject()
+                && UserSelectedProjectIsNotNetStandard20();
         }
 
         protected async override void Run()
@@ -28,12 +34,12 @@ protected async override void Run()
                 {
                     var proj = ProjectOperations.CurrentSelectedItem as DotNetProject;
 
-                    monitor.Log.WriteLine($"Converting {proj.Name}.csproj to NET Standard 2.0 format ..");
+                    monitor.Log.WriteLine($"Converting {proj.Name}{proj.GetProjFileExtension()} to NET Standard 2.0 format ..");
                     monitor.Log.WriteLine();
 
-                    var csProjFilePath = proj.GetCsProjFilePath();
+                    var projFilePath = proj.GetProjFilePath();
 
-                    monitor.Log.WriteLine($"Generating new .csproj");
+                    monitor.Log.WriteLine($"Generating new {proj.GetProjFileExtension()}");
                     monitor.Log.WriteLine();
 
                     var netStandardProjContent = new NetStandardProjFileGenerator(proj).GenerateProjForNetStandard();
@@ -48,11 +54,10 @@ protected async override void Run()
 
                     CleanUpOldFormatFiles(proj);
 
-                    // Create a new .csproj
-                    File.WriteAllText($"{csProjFilePath}", netStandardProjContent, Encoding.UTF8);
+                    // Create a new .xproj
+                    File.WriteAllText($"{projFilePath}", netStandardProjContent, Encoding.UTF8);
 
                     // TODO: Programmatically reload the project instead of re-opening.
-
                     monitor.Log.WriteLine($"Re-opening the project");
                     monitor.Log.WriteLine();
 
@@ -63,7 +68,7 @@ protected async override void Run()
                 }
                 catch (Exception ex)
                 {
-                    monitor.ReportError("Convertion failed. Please create an issue on github.", ex);
+                    monitor.ReportError($"Convertion failed. Please create an issue on github: {Consts.ProjectUrl}", ex);
                 }
                 finally
                 {
@@ -77,21 +82,23 @@ void BackupOldFormatFiles(DotNetProject proj)
             var backupFolderPath = $"{proj.BaseDirectory.FullPath.ParentDirectory}/mutatio_backup";
             // Create backup directory
             FileService.CreateDirectory(backupFolderPath);
-            // Backup current .csproj
-            var csProjFilePath = proj.GetCsProjFilePath();
-            FileService.CopyFile(csProjFilePath, $"{backupFolderPath}/{proj.Name}.csproj");
+            // Backup current .xproj
+            var projFilePath = proj.GetProjFilePath();
+            FileService.CopyFile(projFilePath, $"{backupFolderPath}/{proj.Name}.{proj.GetProjFileExtension()}");
             // Backup packages.config
             var packagesConfigFilePath = proj.GetPackagesFilePath();
             FileService.CopyFile(packagesConfigFilePath, $"{backupFolderPath}/packages.config");
-            // Backup /Properties dir
+
+            // Backup AssemblyInfo.x
             FileService.CopyDirectory(proj.GetPropertiesDirPath(), $"{backupFolderPath}/Properties");
         }
 
         void CleanUpOldFormatFiles(DotNetProject proj)
         {
             FileService.DeleteFile(proj.GetPackagesFilePath());
+            // TODO: In F# there is no /Properties
             FileService.DeleteDirectory(proj.GetPropertiesDirPath());
-            FileService.DeleteFile(proj.GetCsProjFilePath());
+            FileService.DeleteFile(proj.GetProjFilePath());
         }
 
         // Shoud be enabled only when the workspace is opened
@@ -106,7 +113,9 @@ bool ProjectIsNotBuildingOrRunning()
                          && IdeApp.ProjectOperations.CurrentRunOperation.IsCompleted;
         }
 
-        bool UserSelectedItemIsProject() => ProjectOperations.CurrentSelectedItem is DotNetProject;
-        bool UserSelectedProjectIsNotNetStandard20() => !(ProjectOperations.CurrentSelectedItem as DotNetProject).TargetFramework.Name.Equals(".NETStandard 2.0", System.StringComparison.OrdinalIgnoreCase);
+        bool UserSelectedItemIsProject() => ProjectOperations.CurrentSelectedItem is DotNetProject;
+        bool UserSelectedProjectIsCSharpProject() => (ProjectOperations.CurrentSelectedItem as DotNetProject).IsCSharpProject();
+        bool UserSelectedProjectIsNotNetStandard20() => !(ProjectOperations.CurrentSelectedItem as DotNetProject).TargetFramework.Name.Equals(".NETStandard 2.0", StringComparison.OrdinalIgnoreCase);
+        bool UserSelectedProjectIsPortableLibrary() => (ProjectOperations.CurrentSelectedItem as DotNetProject).IsPortableLibrary;
     }
 }
diff --git a/Mutatio/Extensions/DotNetProjectExtenions.cs b/Mutatio/Extensions/DotNetProjectExtenions.cs
@@ -1,11 +1,31 @@
-using MonoDevelop.Projects;
+using System;
+using MonoDevelop.Projects;
 
 namespace Mutatio.Extensions
 {
     public static class DotNetProjectExtenions
     {
-        public static string GetCsProjFilePath(this DotNetProject proj) => $"{proj.BaseDirectory.FullPath}/{proj.Name}.csproj";
         public static string GetPackagesFilePath(this DotNetProject proj) => $"{proj.BaseDirectory.FullPath}/packages.config";
         public static string GetPropertiesDirPath(this DotNetProject proj) => $"{proj.BaseDirectory.FullPath}/Properties";
+
+        public static string GetProjFilePath(this DotNetProject proj) => proj.FileName.FullPath;
+        public static string GetProjFileExtension(this DotNetProject proj) => proj.FileName.Extension;
+
+        public static string GetAssemblyInfoFilePath(this DotNetProject proj)
+        {
+            switch(proj.LanguageName)
+            {
+                case "C#":
+                    return $"{proj.BaseDirectory.FullPath}/Properties/AssemblyInfo.cs";
+                case "F#":
+                    return $"{proj.BaseDirectory.FullPath}/AssemblyInfo.fs";
+                case "VBNET":
+                    return $"{proj.BaseDirectory.FullPath}/AssemblyInfo.vb";
+                default:
+                    throw new NotSupportedException($"{proj.LanguageName} is currently unsupported. Please create an issue on github: {Consts.ProjectUrl}");
+            }
+        }
+
+        public static bool IsCSharpProject(this DotNetProject proj) => proj.LanguageName.Equals("c#", StringComparison.OrdinalIgnoreCase);
     }
 }
diff --git a/Mutatio/Mutatio.csproj b/Mutatio/Mutatio.csproj
@@ -4,6 +4,7 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="MonoDevelop.Addins" Version="0.4.4" />
+    <PackageReference Include="System.ValueTuple" Version="4.4.0" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Extensions\" />

diff --git a/Mutatio/NetStandardProjFileGenerator.cs b/Mutatio/NetStandardProjFileGenerator.cs
@@ -7,7 +7,7 @@ namespace Mutatio
 {
     public class NetStandardProjFileGenerator
     {
-        string netStandard20CsProjFormat => @"<Project Sdk=""Microsoft.NET.Sdk"">
+        string netStandard20ProjFormat => @"<Project Sdk=""Microsoft.NET.Sdk"">
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
   </PropertyGroup>
@@ -32,9 +32,9 @@ public string GenerateProjForNetStandard()
 
             var packagesText = new StringBuilder(packages.Count());
             foreach (var package in packages)
-                packagesText.AppendLine($"<PackageReference Include=\"{package.Item1}\" Version=\"{package.Item2}\"/>");
+                packagesText.AppendLine($"<PackageReference Include=\"{package.name}\" Version=\"{package.version}\"/>");
 
-            return string.Format(netStandard20CsProjFormat, packagesText);
+            return string.Format(netStandard20ProjFormat, packagesText);
         }
     }
 }
diff --git a/Mutatio/PackagesFileParser.cs b/Mutatio/PackagesFileParser.cs
@@ -1,16 +1,15 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Xml.Linq;
 
 namespace Mutatio
 {
     public class PackagesFileParser
     {
-        public IEnumerable<Tuple<string, string>> GetPackages(string filePath)
+        public IEnumerable<(string name, string version)> GetPackages(string filePath)
         {
             var doc = XDocument.Load(filePath);
-            return doc.Elements("packages").Descendants().Select(p => new Tuple<string, string>(p.Attribute("id").Value, p.Attribute("version").Value));
+            return doc.Elements("packages").Descendants().Select(p => (p.Attribute("id").Value, p.Attribute("version").Value));
         }
     }
 }
diff --git a/Mutatio/Properties/AddinInfo.cs b/Mutatio/Properties/AddinInfo.cs
@@ -1,14 +1,15 @@
 using Mono.Addins;
 using Mono.Addins.Description;
+using Mutatio;
 
 [assembly: Addin(
     "Mutatio",
     Namespace = "Mutatio",
-    Version = "1.0"
+    Version = "1.0.1"
 )]
 
 [assembly: AddinName("Mutatio")]
 [assembly: AddinCategory("IDE extensions")]
-[assembly: AddinDescription("Converts PCL to .NET Standard 2.0 automatically.")]
+[assembly: AddinDescription("Automatically convert projects from PCL to .NET Standard 2.0.")]
 [assembly: AddinAuthor("Evgeny Zborovsky")]
-[assembly: AddinUrl("https://github.com/yuv4ik/mutatio")]
+[assembly: AddinUrl(Consts.ProjectUrl)]
diff --git a/README.md b/README.md
@@ -15,11 +15,16 @@ Visual Studio for Mac add-in/extension for converting old PCLs to .NET Standard
 4. Choose the `.mpack` file you downloaded in step 1
 5. When prompted, select Install
 
+## Limitations
+
+```Currently only C# projects supported.```<br/>
+Due to behavior differences `F#` support is currently postponed, however, contributors are welcome!
+
 ## Usage
 
 `Mutatio` can convert newly created or existing projects. Please keep in mind that there might be `NuGet` packages that does not support .NET Standard 2.0, in this case you may see `NuGet` related exceptions.
 
-In order to convert a project, right click on it and select `Convert to NET Standard 2.0`.
+In order to convert a project, right click on it and select `Convert to NET Standard 2.0`.<br/>For more details please check my [blog](https://smellyc0de.wordpress.com/2018/03/23/automatically-converting-pcl-to-net-standard-2-0-project/).
 
 ## Details
 

diff --git a/Versions/Mutatio.Mutatio_1.0.1.mpack b/Versions/Mutatio.Mutatio_1.0.1.mpack