v1.1.0 (#5)

GillesTourreau · web-flow · commit cae6338a3263 · 2023-11-12T00:25:35.000+01:00
- Add Razor component template with code behind, including the header with the company (fix #3). - Fix the name of the file when using a "razor.cs" suffix (fix #4). - Use the company specified in the `stylecop.json` file if specified (fix #2).
diff --git a/README.md b/README.md
@@ -41,13 +41,18 @@ will be:
 It is not easy to have manage and have different templates for each customers.
 
 To fix this issue and allow to work with different companies with the same Visual Studio instance, these
-templates will ask you the name of the company to put on the header.
+templates, will read the `stylecop.json` file in your project and extract the company name.
+See the [Configuring StyleCop Analyzers](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md)
+for more information.
+
+If no `stylecop.json` file exists, a wizard will be displayed to ask you the name of the company to put on the header.
 
 ![Ask Company](docs/AskCompany.png)
 
 ### Companies settings file
 
-The company name is asked only once for each solution.
+If there is no `stylecop.json` file associated to the project, the company name is asked 
+only once for each solution stored in your computer.
 The association between the company and the solutions are saved in the following mapping file:
 
 ```
@@ -70,6 +75,8 @@ The [PosInformatique.VisualStudio.Templates.sln](PosInformatique.VisualStudio.Te
   - [Exception.cs](./src/VisualStudio.Templates.Files/Exception.cs): C# exception class
   - [ExceptionUnitTest.cs](./src/VisualStudio.Templates.Files/ExceptionUnitTest.cs): C# exception unit test class
   - [Interface.cs](./src/VisualStudio.Templates.Files/Interface.cs): C# interface
+  - [RazorComponent.razor](./src/VisualStudio.Templates.Files/RazorComponent.razor): Razor component (a separate code behind C# class is included)
+    - [RazorComponent.razor.cs](./src/VisualStudio.Templates.Files/RazorComponent.razor.cs): Razor component code behind (in C#).
   - [XUnitTest.cs](./src/VisualStudio.Templates.Files/XUnitTest.cs): C# XUnit test class
 
 ![Templates](docs/Templates.png)
diff --git a/build/azure-pipelines-release.yaml b/build/azure-pipelines-release.yaml
@@ -2,7 +2,7 @@ parameters:
 - name: Version
   displayName: The version of the Visual Studio Templates
   type: string
-  default: 1.0.0.0
+  default: 1.1.0.0
 
 trigger: none
 
diff --git a/docs/Templates.png b/docs/Templates.png
diff --git a/src/VisualStudio.Templates.Files/Class.cs b/src/VisualStudio.Templates.Files/Class.cs
@@ -1,5 +1,5 @@
 ﻿//-----------------------------------------------------------------------
-// <copyright file="$safeitemname$.cs" company="$company$">
+// <copyright file="$rootname$" company="$company$">
 //     Copyright (c) $company$. All rights reserved.
 // </copyright>
 //-----------------------------------------------------------------------
diff --git a/src/VisualStudio.Templates.Files/Exception.cs b/src/VisualStudio.Templates.Files/Exception.cs
@@ -1,5 +1,5 @@
 ﻿//-----------------------------------------------------------------------
-// <copyright file="$safeitemname$.cs" company="$company$">
+// <copyright file="$rootname$" company="$company$">
 //     Copyright (c) $company$. All rights reserved.
 // </copyright>
 //-----------------------------------------------------------------------
diff --git a/src/VisualStudio.Templates.Files/ExceptionUnitTest.cs b/src/VisualStudio.Templates.Files/ExceptionUnitTest.cs
@@ -1,5 +1,5 @@
 ﻿//-----------------------------------------------------------------------
-// <copyright file="$safeitemname$.cs" company="$company$">
+// <copyright file="$rootname$" company="$company$">
 //     Copyright (c) $company$. All rights reserved.
 // </copyright>
 //-----------------------------------------------------------------------
diff --git a/src/VisualStudio.Templates.Files/Interface.cs b/src/VisualStudio.Templates.Files/Interface.cs
@@ -1,5 +1,5 @@
 ﻿//-----------------------------------------------------------------------
-// <copyright file="$safeitemname$.cs" company="$company$">
+// <copyright file="$rootname$" company="$company$">
 //     Copyright (c) $company$. All rights reserved.
 // </copyright>
 //-----------------------------------------------------------------------
diff --git a/src/VisualStudio.Templates.Files/RazorComponent.razor b/src/VisualStudio.Templates.Files/RazorComponent.razor
@@ -0,0 +1 @@
+﻿@namespace $rootnamespace$
diff --git a/src/VisualStudio.Templates.Files/RazorComponent.razor.cs b/src/VisualStudio.Templates.Files/RazorComponent.razor.cs
@@ -0,0 +1,15 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="$rootname$" company="$company$">
+//     Copyright (c) $company$. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace $rootnamespace$
+{
+    public partial class $safeitemname$
+    {
+		public $safeitemname$()
+        {
+        }
+    }
+}
diff --git a/src/VisualStudio.Templates.Files/RazorComponent.vstemplate b/src/VisualStudio.Templates.Files/RazorComponent.vstemplate
@@ -0,0 +1,20 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
+  <TemplateData>
+    <DefaultName>Component.razor</DefaultName>
+    <Name>P.O.S Informatique Razor Component (with code behind)</Name>
+    <Description>P.O.S Informatique Razor Component (with code behind).</Description>
+    <ProjectType>CSharp</ProjectType>
+    <SortOrder>150</SortOrder>
+    <Icon Package="{AAB75614-2F8F-4DA6-B0A6-763C6DBB2969}" ID="13" />
+    <TemplateGroupID>AspNetCore</TemplateGroupID>
+  </TemplateData>
+  <TemplateContent>
+    <ProjectItem SubType="" TargetFileName="$fileinputname$.razor" ReplaceParameters="true">RazorComponent.razor</ProjectItem>
+    <ProjectItem SubType="" TargetFileName="$fileinputname$.razor.cs" ReplaceParameters="true">RazorComponent.razor.cs</ProjectItem>
+  </TemplateContent>
+  <WizardExtension>
+    <Assembly>PosInformatique.VisualStudio.Templates, Version=0.0.0.0, Culture=Neutral, PublicKeyToken=889b4f35d1c32a46</Assembly>
+    <FullClassName>PosInformatique.VisualStudio.Templates.CompanySelectionWizard</FullClassName>
+  </WizardExtension>
+</VSTemplate>
diff --git a/src/VisualStudio.Templates.Files/VisualStudio.Templates.Files.csproj b/src/VisualStudio.Templates.Files/VisualStudio.Templates.Files.csproj
@@ -51,51 +51,40 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="Class.cs" />
     <None Include="Exception.cs" />
+    <None Include="ExceptionUnitTest.cs" />
     <None Include="Interface.cs" />
+    <None Include="RazorComponent.razor" />
+    <None Include="RazorComponent.razor.cs" />
     <None Include="XUnitTest.cs" />
-    <None Include="Class.cs" />
-    <None Include="ExceptionUnitTest.cs" />
   </ItemGroup>
   <ItemGroup>
     <VSTemplate Include="Class.vstemplate" OutputSubPath="P.O.S Informatique" />
     <VSTemplate Include="Exception.vstemplate" OutputSubPath="P.O.S Informatique" />
+    <VSTemplate Include="ExceptionUnitTest.vstemplate" OutputSubPath="P.O.S Informatique" />
     <VSTemplate Include="Interface.vstemplate" OutputSubPath="P.O.S Informatique" />
+    <VSTemplate Include="RazorComponent.vstemplate" OutputSubPath="P.O.S Informatique" />
     <VSTemplate Include="XUnitTest.vstemplate" OutputSubPath="P.O.S Informatique" />
-    <VSTemplate Include="ExceptionUnitTest.vstemplate" OutputSubPath="P.O.S Informatique" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="$(VSToolsPath)\VSSDK\Microsoft.VsSDK.targets" Condition="'$(VSToolsPath)' != ''" />
   <Target Name="BeforeBuild">
-
     <!-- Update the version of Wizard to use -->
     <PropertyGroup>
       <_VSTemplateNamespaces>
         <Namespace Prefix="vs" Uri="http://schemas.microsoft.com/developer/vstemplate/2005" />
       </_VSTemplateNamespaces>
     </PropertyGroup>
-    
-    <XmlPoke
-				XmlInputPath="%(VSTemplate.Identity)"
-				Value="PosInformatique.VisualStudio.Templates, Version=$(Version), Culture=Neutral, PublicKeyToken=889b4f35d1c32a46"
-				Query="/vs:VSTemplate/vs:WizardExtension/vs:Assembly"
-				Namespaces="$(_VSTemplateNamespaces)"/>
-
+    <XmlPoke XmlInputPath="%(VSTemplate.Identity)" Value="PosInformatique.VisualStudio.Templates, Version=$(Version), Culture=Neutral, PublicKeyToken=889b4f35d1c32a46" Query="/vs:VSTemplate/vs:WizardExtension/vs:Assembly" Namespaces="$(_VSTemplateNamespaces)" />
   </Target>
   <Target Name="AfterBuild">
-
     <!-- Restore the version of Wizard to 0.0.0.0 -->
     <PropertyGroup>
       <_VSTemplateNamespaces>
         <Namespace Prefix="vs" Uri="http://schemas.microsoft.com/developer/vstemplate/2005" />
       </_VSTemplateNamespaces>
     </PropertyGroup>
-
-    <XmlPoke
-				XmlInputPath="%(VSTemplate.Identity)"
-				Value="PosInformatique.VisualStudio.Templates, Version=0.0.0.0, Culture=Neutral, PublicKeyToken=889b4f35d1c32a46"
-				Query="/vs:VSTemplate/vs:WizardExtension/vs:Assembly"
-				Namespaces="$(_VSTemplateNamespaces)"/>
-
+    <XmlPoke XmlInputPath="%(VSTemplate.Identity)" Value="PosInformatique.VisualStudio.Templates, Version=0.0.0.0, Culture=Neutral, PublicKeyToken=889b4f35d1c32a46" Query="/vs:VSTemplate/vs:WizardExtension/vs:Assembly" Namespaces="$(_VSTemplateNamespaces)" />
   </Target>
 </Project>
diff --git a/src/VisualStudio.Templates.Files/XUnitTest.cs b/src/VisualStudio.Templates.Files/XUnitTest.cs
@@ -1,10 +1,10 @@
 ﻿//-----------------------------------------------------------------------
-// <copyright file="$safeitemname$.cs" company="$company$">
+// <copyright file="$rootname$" company="$company$">
 //     Copyright (c) $company$. All rights reserved.
 // </copyright>
 //-----------------------------------------------------------------------
 
-namespace $rootnamespace$.Tests
+namespace $rootnamespace$
 {
     public class $safeitemname$
     {
diff --git a/src/VisualStudio.Templates/CompanySelectionWizard.cs b/src/VisualStudio.Templates/CompanySelectionWizard.cs
@@ -12,6 +12,8 @@ namespace PosInformatique.VisualStudio.Templates
     using EnvDTE;
     using Microsoft.VisualStudio.TemplateWizard;
     using Microsoft.VisualStudio.Shell;
+    using Microsoft.VisualStudio.Shell.Interop;
+    using System.IO;
 
     public class CompanySelectionWizard : IWizard
     {
@@ -25,8 +27,7 @@ public void ProjectFinishedGenerating(Project project)
         {
         }
 
-        public void ProjectItemFinishedGenerating(ProjectItem
-            projectItem)
+        public void ProjectItemFinishedGenerating(ProjectItem projectItem)
         {
         }
 
@@ -40,7 +41,60 @@ public void RunStarted(object automationObject,
         {
             ThreadHelper.ThrowIfNotOnUIThread();
 
-            var dte = (DTE)Package.GetGlobalService(typeof(DTE));
+            string company = null;
+
+            // Check if StyleCop settings file already exists
+            var projectInteropWrapper = new ProjectInteropWrapper((IVsProject4)customParams[1]);
+
+            var styleCopSettingsFilePath = projectInteropWrapper.GetDocumentFilePath("stylecop.json");
+
+            if (styleCopSettingsFilePath != null)
+            {
+                using (var fileStream = File.OpenRead(styleCopSettingsFilePath))
+                {
+                    var styleCopConfiguration = StyleCopConfiguration.LoadFrom(fileStream);
+
+                    if (styleCopConfiguration != null)
+                    {
+                        company = styleCopConfiguration.Settings.DocumentationRules.CompanyName;
+                    }
+                }
+            }
+
+            // If company is null ask the company to the developer
+            if (company == null)
+            {
+                company = AskCompany((DTE)automationObject);
+            }
+
+            if (company != null)
+            {
+                replacementsDictionary.Add("$company$", company);
+
+                // For the unit tests, add a setting without "Test" suffix
+                var safeItemName = replacementsDictionary["$safeitemname$"];
+                var classNameUnderTest = safeItemName;
+
+                if (safeItemName.EndsWith("Test"))
+                {
+                    classNameUnderTest = safeItemName.Substring(0, safeItemName.Length - "Test".Length);
+                }
+
+                replacementsDictionary.Add("$classnameundertest$", classNameUnderTest);
+
+                this.shouldAddProjectItem = true;
+            }
+        }
+
+        public bool ShouldAddProjectItem(string filePath)
+        {
+            return this.shouldAddProjectItem;
+        }
+
+        private static string AskCompany(DTE dte)
+        {
+            ThreadHelper.ThrowIfNotOnUIThread();
+
             var solutionFilePath = dte.Solution.FileName;
 
             var repository = new AppDataRoamingCompanyRepository();
@@ -53,44 +107,25 @@ public void RunStarted(object automationObject,
                 .ToArray();
 
             // Finds the company associated to the solution.
-            string company;
             var solutionFound = solutions.FirstOrDefault(s => s.Path.Equals(solutionFilePath, StringComparison.CurrentCultureIgnoreCase));
 
             if (solutionFound != null)
             {
-                company = solutionFound.Company;
-
-                this.shouldAddProjectItem = true;
+                return solutionFound.Company;
             }
             else
             {
-                company = CompanySelectionForm.ShowDialog(companies, "P.O.S Informatique", dte.MainWindow.HWnd);
+                var company = CompanySelectionForm.ShowDialog(companies, "P.O.S Informatique", dte.MainWindow.HWnd);
 
                 if (company != null)
                 {
                     repository.Save(new Solution(dte.Solution.FileName, company));
 
-                    this.shouldAddProjectItem = true;
+                    return company;
                 }
             }
 
-            replacementsDictionary.Add("$company$", company);
-
-            // For the unit tests, add a setting without "Test" suffix
-            var safeItemName = replacementsDictionary["$safeitemname$"];
-            var classNameUnderTest = safeItemName;
-
-            if (safeItemName.EndsWith("Test"))
-            {
-                classNameUnderTest = safeItemName.Substring(0, safeItemName.Length - "Test".Length);
-            }
-
-            replacementsDictionary.Add("$classnameundertest$", classNameUnderTest);
-        }
-
-        public bool ShouldAddProjectItem(string filePath)
-        {
-            return this.shouldAddProjectItem;
+            return null;
         }
     }
 }
diff --git a/src/VisualStudio.Templates/StyleCop/StyleCopConfiguration.cs b/src/VisualStudio.Templates/StyleCop/StyleCopConfiguration.cs
@@ -0,0 +1,40 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="StyleCopConfiguration.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.VisualStudio.Templates
+{
+    using System.IO;
+    using System.Text.Json;
+    using System.Text.Json.Serialization;
+
+    internal class StyleCopConfiguration
+    {
+        public StyleCopConfiguration(StyleCopConfigurationSettings settings)
+        {
+            this.Settings = settings;
+        }
+
+        [JsonPropertyName("settings")]
+        public StyleCopConfigurationSettings Settings { get; }
+
+        public static StyleCopConfiguration LoadFrom(Stream stream)
+        {
+            var options = new JsonSerializerOptions
+            {
+                ReadCommentHandling = JsonCommentHandling.Skip,
+            };
+
+            try
+            {
+                return JsonSerializer.Deserialize<StyleCopConfiguration>(stream, options);
+            }
+            catch (JsonException)
+            {
+                return null;
+            }
+        }
+    }
+}
diff --git a/src/VisualStudio.Templates/StyleCop/StyleCopConfigurationDocumentationRules.cs b/src/VisualStudio.Templates/StyleCop/StyleCopConfigurationDocumentationRules.cs
@@ -0,0 +1,21 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="StyleCopConfigurationDocumentationRules.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.VisualStudio.Templates
+{
+    using System.Text.Json.Serialization;
+
+    public class StyleCopConfigurationDocumentationRules
+    {
+        public StyleCopConfigurationDocumentationRules(string companyName)
+        {
+            this.CompanyName = companyName;
+        }
+
+        [JsonPropertyName("companyName")]
+        public string CompanyName { get; }
+    }
+}
diff --git a/src/VisualStudio.Templates/StyleCop/StyleCopConfigurationSettings.cs b/src/VisualStudio.Templates/StyleCop/StyleCopConfigurationSettings.cs
@@ -0,0 +1,21 @@
+﻿//-----------------------------------------------------------------------
+// <copyright file="StyleCopConfigurationSettings.cs" company="P.O.S Informatique">
+//     Copyright (c) P.O.S Informatique. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace PosInformatique.VisualStudio.Templates
+{
+    using System.Text.Json.Serialization;
+
+    public class StyleCopConfigurationSettings
+    {
+        public StyleCopConfigurationSettings(StyleCopConfigurationDocumentationRules documentationRules)
+        {
+            this.DocumentationRules = documentationRules;
+        }
+
+        [JsonPropertyName("documentationRules")]
+        public StyleCopConfigurationDocumentationRules DocumentationRules { get; }
+    }
+}
diff --git a/src/VisualStudio.Templates/VisualStudio.Templates.csproj b/src/VisualStudio.Templates/VisualStudio.Templates.csproj
diff --git a/src/VisualStudio.Templates/VisualStudio/ProjectInteropWrapper.cs b/src/VisualStudio.Templates/VisualStudio/ProjectInteropWrapper.cs
diff --git a/src/VisualStudio.Templates/source.extension.vsixmanifest b/src/VisualStudio.Templates/source.extension.vsixmanifest
