Feburary updates to support command that executes as soon as the solution loaded. Bug fix to handle double documentation comments added due to changes on how documentation is loaded.

Author: sgiffinlcd

src/CodeFactoryVisualStudio/CodeFactory.DotNet/CodeFactory.DotNet.csproj

@@ -189,7 +189,6 @@
  <Compile Include="WellKnownLanguageType.cs" />
  </ItemGroup>
  <ItemGroup>
- <None Include="CodeFactoryRuntimeSigner.snk" />
  <None Include="CodeFactorySigner.snk" />
  <None Include="packages.config" />
  </ItemGroup>

src/CodeFactoryVisualStudio/CodeFactory.Formatting.CSharp/DocumentationExtensions.cs

@@ -50,7 +50,8 @@ public static string CSharpFormatDocumentationLine(this string source)
  if (string.IsNullOrEmpty(source)) return null;
  var trimmed = source.Trim();
  if (trimmed.Contains("<member")) return null;
- return trimmed.Contains("</member") ? null : $"///{trimmed}";
+ if (trimmed.Contains("</member")) return null;
+ return trimmed.Contains("///") ? trimmed : $"///{trimmed}";
  }
  }
 }

src/CodeFactoryVisualStudio/CodeFactory.Logging/CodeFactory.Logging.csproj

@@ -78,7 +78,6 @@
  <Compile Include="Properties\AssemblyInfo.cs" />
  </ItemGroup>
  <ItemGroup>
- <None Include="CodeFactoryRuntimeSigner.snk" />
  <None Include="CodeFactorySigner.snk" />
  </ItemGroup>
  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/CodeFactory.VisualStudio.csproj

@@ -76,7 +76,10 @@
  <Compile Include="AssemblyCFEnvironment.cs" />
  <Compile Include="AssemblyCFSdkVersion.cs" />
  <Compile Include="CSharpSourceExtensions.cs" />
+ <Compile Include="IDE\ISolutionLoadCommand.cs" />
+ <Compile Include="IDE\SolutionLoadCommandBase.cs" />
  <Compile Include="IVsEnvironmentActions.cs" />
+ <Compile Include="IVsEnvironmentCommand.cs" />
  <Compile Include="IVsProjectFramework.cs" />
  <Compile Include="PathHelper.cs" />
  <Compile Include="FileHelper.cs" />
@@ -140,6 +143,7 @@
  <DependentUpon>VisualStudioMessages.resx</DependentUpon>
  </Compile>
  <Compile Include="VisualStudioModelType.cs" />
+ <Compile Include="VsEnvironmentCommandBase.cs" />
  <Compile Include="VsCommandBase.cs" />
  <Compile Include="VsCommandType.cs" />
  <Compile Include="VsCSharpSource.cs" />

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/IDE/ISolutionLoadCommand.cs

@@ -0,0 +1,15 @@
+//*****************************************************************************
+//* Code Factory SDK
+//* Copyright (c) 2023 CodeFactory, LLC
+//*****************************************************************************
+
+namespace CodeFactory.VisualStudio.IDE
+{
+ /// <summary>
+ /// Code factory command that triggers once the solution has been loaded. Will only be called once. 
+ /// </summary>
+ public interface ISolutionLoadCommand : IVsEnvironmentCommand<VsSolution>
+ {
+ //Intentionally blank
+ }
+}

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/IDE/SolutionLoadCommandBase.cs

@@ -0,0 +1,22 @@
+//*****************************************************************************
+//* Code Factory SDK
+//* Copyright (c) 2023 CodeFactory, LLC
+//*****************************************************************************
+
+using CodeFactory.Logging;
+
+namespace CodeFactory.VisualStudio.IDE
+{
+ /// <summary>
+ /// Base implementation of the solution explorer command <see cref="ISolutionLoadCommand"/>
+ /// </summary>
+ public abstract class SolutionLoadCommandBase: VsEnviromentCommandBase<VsSolution>,ISolutionLoadCommand
+ {
+
+ /// <inheritdoc />
+ protected SolutionLoadCommandBase(ILogger logger, IVsActions vsActions,string commandTitle, string commandDescription) : base(logger,vsActions,VsCommandType.IDESolutionLoad,commandTitle,commandDescription)
+ {
+ //Intentionally blank
+ }
+ }
+}

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/IVsEnvironmentCommand.cs

@@ -0,0 +1,27 @@
+//*****************************************************************************
+//* Code Factory SDK
+//* Copyright (c) 2023 CodeFactory, LLC
+//*****************************************************************************
+using System.Threading.Tasks;
+
+namespace CodeFactory.VisualStudio
+{
+
+ /// <summary>
+ /// Base implementation for all code factory commands that are directly executed by the Visual Studio Enviornment.
+ /// </summary>
+ /// <typeparam name="TModel">Target code factory model to be provided for the command.</typeparam>
+ public interface IVsEnvironmentCommand<TModel>: IVsCommandInformation where TModel : class
+ {
+ /// <summary>
+ /// Code factory framework calls this method when the command has been executed. 
+ /// </summary>
+ /// <param name="result">The code factory model that has generated and provided to the command to process.</param>
+ Task ExecuteCommandAsync(TModel result);
+
+ /// <summary>
+ /// Global visual studio commands that can be accessed from this visual studio command.
+ /// </summary>
+ IVsActions VisualStudioActions { get; }
+ }
+}

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/VsCommandType.cs

@@ -1,6 +1,6 @@
 //*****************************************************************************
 //* Code Factory SDK
-//* Copyright (c) 2020 CodeFactory, LLC
+//* Copyright (c) 2023 CodeFactory, LLC
 //*****************************************************************************
 
 namespace CodeFactory.VisualStudio
@@ -45,6 +45,11 @@ public enum VsCommandType
  /// </summary>
  SolutionExplorerCSharpSourceCode = 6,
 
+ /// <summary>
+ /// IDE level command that is fired once the solution has been loaded. Will only be triggered once the solution is loaded.
+ /// </summary>
+ IDESolutionLoad = 7,
+
  /// <summary>
  /// The command type is unknown
  /// </summary>

src/CodeFactoryVisualStudio/CodeFactory.VisualStudio/VsEnvironmentCommandBase.cs

@@ -0,0 +1,84 @@
+//*****************************************************************************
+//* Code Factory SDK
+//* Copyright (c) 2023 CodeFactory, LLC
+//*****************************************************************************
+using System.Threading.Tasks;
+using CodeFactory.Logging;
+
+namespace CodeFactory.VisualStudio
+{
+ /// <summary>
+ /// Base implementation for a environment command that supports integration with the Visual studio IDE environment directly. 
+ /// </summary>
+ /// <typeparam name="TModel">The target visual studio model type to be returned from the visual studio environment command.</typeparam>
+ public abstract class VsEnviromentCommandBase<TModel> : IVsEnvironmentCommand<TModel> where TModel : class
+ {
+ /// <summary>
+ /// Backing field for the property <see cref="CommandTitle"/>
+ /// </summary>
+ protected readonly string _commandTitle;
+
+ /// <summary>
+ /// Backing field for the property <see cref="CommandDescription"/>
+ /// </summary>
+ protected readonly string _commandDescription;
+
+ /// <summary>
+ /// Backing field for the property <see cref="CommandType"/>
+ /// </summary>
+ private readonly VsCommandType _commandType;
+
+ /// <summary>
+ /// Logging method that is used by the command to log to the code factory logging framework.
+ /// </summary>
+ protected readonly ILogger _logger;
+
+ /// <summary>
+ /// Backing field for the property <see cref="VisualStudioActions"/>
+ /// </summary>
+ private readonly IVsActions _visualStudioActions;
+
+ /// <summary>
+ /// Base constructor used it initialize a visual studio command.
+ /// </summary>
+ /// <param name="logger">The code factory logger to be used by the logger.</param>
+ /// <param name="commands">The global visual studio commands that can be used by this visual studio command.</param>
+ /// <param name="commandType">The target type of command being created. </param>
+ /// <param name="commandTitle">The title displayed in visual studio for this command.</param>
+ /// <param name="commandDescription">A brief description of the purpose of this command.</param>
+ protected VsEnviromentCommandBase(ILogger logger, IVsActions commands, VsCommandType commandType,string commandTitle, string commandDescription)
+ {
+ _logger = logger;
+ _commandType = commandType;
+ _visualStudioActions = commands;
+ _commandTitle = commandTitle;
+ _commandDescription = commandDescription;
+ }
+
+ /// <summary>
+ /// Action title that will be displayed within visual studio.
+ /// </summary>
+ public string CommandTitle => _commandTitle;
+
+ /// <summary>
+ /// An optional discription that discribes what this factory command is intended for. 
+ /// </summary>
+ public string CommandDescription => _commandDescription;
+
+ /// <summary>
+ /// The target type of command that is being loaded.
+ /// </summary>
+ public VsCommandType CommandType => _commandType;
+
+ /// <summary>
+ /// Global visual studio commands that can be accessed from this visual studio command.
+ /// </summary>
+ public IVsActions VisualStudioActions => _visualStudioActions;
+
+ /// <summary>
+ /// Code factory framework calls this method when the command has been executed. 
+ /// </summary>
+ /// <param name="result">The code factory model that has generated and provided to the command to process.</param>
+ public abstract Task ExecuteCommandAsync(TModel result);
+ }
+}