Skip to content

Commit 27656d7

Browse files
d1820d1820
authored
Vs2026 (#45)
* Switch to Shouldly; Add CodeDocumentor2026 project Replaced FluentAssertions with Shouldly across test files. Updated test-related NuGet packages and added Shouldly. Introduced a new Visual Studio extension project, CodeDocumentor2026. Updated the solution file to include the new project. Removed a namespace declaration from ProtoTesterBracketNamespace.cs. * Refactor namespaces and update services Refactor namespaces to include an additional `Analyzers` segment, affecting multiple files. Update `ServiceLocator` to use a new `SettingService` with `IEventLogger` dependency, and move `SettingService` to `CodeDocumentor.Common.Services`. Modify project files to reflect structural changes, removing the old `SettingService.cs` and adding new command files. Add new command handlers for Visual Studio extension, integrated via `CodeDocumentor2026Package.vsct`. Update unit tests to align with namespace changes. Add a new VSCT file to define command layouts. Include miscellaneous improvements like new using directives and code cleanup. * Refactor and simplify code fix providers Updated `TestFixture.cs` to use `CodeDocumentor.Common.Services` and added `Moq` for mocking `IEventLogger`. Refactored `Initialize` method to use dependency injection for `SettingService`. Removed `GetFixAllProvider` from `BaseCodeFixProvider.cs` and adjusted debug logic to include an `#else` block for document processing. Simplified `FileCodeFixProvider.cs` by removing unused `using` directives, the `Title` constant, and `FixableDiagnosticIds`. Streamlined `RegisterCodeFixesAsync` to delegate to `RegisterFileCodeFixesAsync`. Overall, these changes enhance code maintainability by reducing redundancy and improving service initialization. * Refactor and enhance CodeDocumentor extension Refactor the codebase to improve modularity and maintainability by moving classes and methods to the `CodeDocumentor.Common` namespace. Introduce `CommentBuilderService` to centralize comment-building logic, enhancing separation of concerns and reusability. Add a new `Logger` class for structured logging and an `OptionPageGrid` class for managing configuration options within the Visual Studio extension. Update project files to include new dependencies and metadata, and remove outdated scripts, aligning with modern development practices. Enhance branding with the addition of a new logo. * checkpoint * Enhance build and update resources Enabled assembly signing in `CodeDocumentor2026.csproj` and added necessary references for improved build configuration. Reorganized project items, including the addition of `CodeDocumentor2026Package.cs` and `VSPackage.resx`, to streamline initialization and service registration processes. Updated `CodeDocumentor2026Package.vsct` to define new GUIDs and command IDs, and ensured consistent logging in `Logger.cs`. Changed `PackageGuidString` in `VsixOptions.cs` and updated `source.extension.vsixmanifest` with a new dependency. Likely updated `CodeDocumentor2026Package.ico` to enhance the extension's visual branding. * checkpoint * checkpoint * Refactor command handling logic Consolidated `CodeDocumentorFileCommand` and `CodeDocumentorFolderCommand` into a unified `CodeDocumentorContextCommand` class. Updated `CodeDocumentor2026.csproj` to reflect these changes by removing old references and adding the new one. Modified `CodeDocumentor2026Package.cs` to initialize the new context command. This refactoring reduces redundancy and simplifies maintenance by combining similar logic into a single class, while maintaining detailed logging for debugging. * checkpoint * check * checkpoint * check * checkpoint * Enhance XML doc handling and add new commands Added `GetDocumentationLineCount` to `ICommentBuilderService` for counting non-empty XML doc lines. Updated `CommentBuilderService.cs` to implement this method and added necessary using directives. Modified `CodeDocumentor2026Package.vsct` to adjust menu priorities and button text, introducing a new command ID for whole file documentation. Enhanced `CodeDocumentorEditorCommand.cs` to support whole file documentation, refactored node finding logic, and extracted document update logic. Updated `TextSelectionExecutor.cs` with a new parameter for improved text handling. Added `GlobalSuppressions.cs` for code analysis management and `TextSelectionExtensions.cs` for cursor positioning. * Update menu priorities and add Quick Actions support Updated the priority of context menu groups in `CodeDocumentor2026Package.vsct` to `0x0100` for better menu organization. Added a new button for the editor context menu to provide a "Code Documentor This" option. Adjusted the priority of the "Code Documentor File" button. Introduced commented-out Quick Actions and Refactorings menu groups and buttons for future XML documentation features. Added new constants and command service entries in `CodeDocumentorEditorCommand.cs` for Quick Actions, enhancing command execution logic to support these new features. * check * Refactor settings for CodeDocumentor 2026 Introduce `Settings2026` class implementing `IBaseSettings`, replacing `Settings` and `ISettings` across the codebase. Update `GetSettingsFilePath` to handle "2026" settings. Refactor `ICommentBuilderService` and `CommentBuilderService` to use `IBaseSettings`. Update `CodeDocumentor2026Package` and `OptionPageGrid` for compatibility with new settings. Move `Logger` to `CodeDocumentor2026` namespace. Add `Settings2026.cs` with methods for managing 2026-specific settings. Improve code readability by removing unnecessary whitespace in command classes. * clean * bug fixes * Added documentation * readme update * update
1 parent aba10be commit 27656d7

File tree

116 files changed

+3670
-1096
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+3670
-1096
lines changed

‎CodeDocumentor.Analyzers/Analyzers/BaseAnalyzerSettings.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
using CodeDocumentor.Analyzers.Locators;
21
using CodeDocumentor.Common;
32
using CodeDocumentor.Common.Helpers;
43
using CodeDocumentor.Common.Interfaces;
4+
using CodeDocumentor.Common.Locators;
55
using Microsoft.CodeAnalysis;
66

7-
namespace CodeDocumentor.Analyzers
7+
namespace CodeDocumentor.Analyzers.Analyzers
88
{
99
public class BaseAnalyzerSettings
1010
{

‎CodeDocumentor.Analyzers/Analyzers/Classes/ClassAnalyzer.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
using System.Collections.Immutable;
22
using CodeDocumentor.Analyzers.Builders;
3-
using CodeDocumentor.Analyzers.Helper;
4-
using CodeDocumentor.Analyzers.Locators;
3+
using CodeDocumentor.Common.Helper;
4+
using CodeDocumentor.Common.Locators;
55
using Microsoft.CodeAnalysis;
66
using Microsoft.CodeAnalysis.CSharp;
77
using Microsoft.CodeAnalysis.CSharp.Syntax;
88
using Microsoft.CodeAnalysis.Diagnostics;
99

10-
namespace CodeDocumentor.Analyzers.Classes
10+
namespace CodeDocumentor.Analyzers.Analyzers.Classes
1111
{
1212
/// <summary>
1313
/// The class analyzer.

‎CodeDocumentor.Analyzers/Analyzers/Classes/ClassAnalyzerSettings.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using CodeDocumentor.Common.Interfaces;
33
using Microsoft.CodeAnalysis;
44

5-
namespace CodeDocumentor.Analyzers
5+
namespace CodeDocumentor.Analyzers.Analyzers.Classes
66
{
77
public class ClassAnalyzerSettings : BaseAnalyzerSettings
88
{

‎CodeDocumentor.Analyzers/Analyzers/Classes/NonPublicClassAnalyzer.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
using System.Collections.Immutable;
22
using CodeDocumentor.Analyzers.Builders;
3-
using CodeDocumentor.Analyzers.Helper;
4-
using CodeDocumentor.Analyzers.Locators;
3+
using CodeDocumentor.Common.Helper;
4+
using CodeDocumentor.Common.Locators;
55
using Microsoft.CodeAnalysis;
66
using Microsoft.CodeAnalysis.CSharp;
77
using Microsoft.CodeAnalysis.CSharp.Syntax;
88
using Microsoft.CodeAnalysis.Diagnostics;
99

10-
namespace CodeDocumentor.Analyzers.Classes
10+
namespace CodeDocumentor.Analyzers.Analyzers.Classes
1111
{
1212
/// <summary>
1313
/// The class analyzer.

‎CodeDocumentor.Analyzers/Analyzers/Constructors/ConstructorAnalyzer.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
using System.Collections.Immutable;
22
using CodeDocumentor.Analyzers.Builders;
3-
using CodeDocumentor.Analyzers.Helper;
4-
using CodeDocumentor.Analyzers.Locators;
3+
using CodeDocumentor.Common.Helper;
4+
using CodeDocumentor.Common.Locators;
55
using Microsoft.CodeAnalysis;
66
using Microsoft.CodeAnalysis.CSharp;
77
using Microsoft.CodeAnalysis.CSharp.Syntax;
88
using Microsoft.CodeAnalysis.Diagnostics;
99

10-
namespace CodeDocumentor.Analyzers.Constructors
10+
namespace CodeDocumentor.Analyzers.Analyzers.Constructors
1111
{
1212
/// <summary>
1313
/// The constructor analyzer.

‎CodeDocumentor.Analyzers/Analyzers/Constructors/ConstructorAnalyzerSettings.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using CodeDocumentor.Common.Interfaces;
33
using Microsoft.CodeAnalysis;
44

5-
namespace CodeDocumentor.Analyzers
5+
namespace CodeDocumentor.Analyzers.Analyzers.Constructors
66
{
77
public class ConstructorAnalyzerSettings : BaseAnalyzerSettings
88
{

‎CodeDocumentor.Analyzers/Analyzers/Constructors/NonPublicConstructorAnalyzer.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
using System.Collections.Immutable;
22
using CodeDocumentor.Analyzers.Builders;
3-
using CodeDocumentor.Analyzers.Helper;
4-
using CodeDocumentor.Analyzers.Locators;
3+
using CodeDocumentor.Common.Helper;
4+
using CodeDocumentor.Common.Locators;
55
using Microsoft.CodeAnalysis;
66
using Microsoft.CodeAnalysis.CSharp;
77
using Microsoft.CodeAnalysis.CSharp.Syntax;
88
using Microsoft.CodeAnalysis.Diagnostics;
99

10-
namespace CodeDocumentor.Analyzers.Constructors
10+
namespace CodeDocumentor.Analyzers.Analyzers.Constructors
1111
{
1212
[DiagnosticAnalyzer(LanguageNames.CSharp)]
1313
public class NonPublicConstructorAnalyzer : DiagnosticAnalyzer

‎CodeDocumentor.Analyzers/Analyzers/Enums/EnumAnalyzer.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
using System.Collections.Immutable;
22
using CodeDocumentor.Analyzers.Builders;
3-
using CodeDocumentor.Analyzers.Locators;
3+
using CodeDocumentor.Common.Locators;
44
using Microsoft.CodeAnalysis;
55
using Microsoft.CodeAnalysis.CSharp;
66
using Microsoft.CodeAnalysis.CSharp.Syntax;
77
using Microsoft.CodeAnalysis.Diagnostics;
88

9-
namespace CodeDocumentor.Analyzers.Enums
9+
namespace CodeDocumentor.Analyzers.Analyzers.Enums
1010
{
1111
/// <summary>
1212
/// The enum analyzer.

‎CodeDocumentor.Analyzers/Analyzers/Enums/EnumAnalyzerSettings.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using CodeDocumentor.Common.Interfaces;
33
using Microsoft.CodeAnalysis;
44

5-
namespace CodeDocumentor.Analyzers
5+
namespace CodeDocumentor.Analyzers.Analyzers.Enums
66
{
77
public class EnumAnalyzerSettings : BaseAnalyzerSettings
88
{

‎CodeDocumentor.Analyzers/Analyzers/Fields/FieldAnalyzer.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
using System.Collections.Immutable;
22
using System.Linq;
33
using CodeDocumentor.Analyzers.Builders;
4-
using CodeDocumentor.Analyzers.Helper;
5-
using CodeDocumentor.Analyzers.Locators;
4+
using CodeDocumentor.Common.Helper;
5+
using CodeDocumentor.Common.Locators;
66
using Microsoft.CodeAnalysis;
77
using Microsoft.CodeAnalysis.CSharp;
88
using Microsoft.CodeAnalysis.CSharp.Syntax;
99
using Microsoft.CodeAnalysis.Diagnostics;
1010

11-
namespace CodeDocumentor.Analyzers.Fields
11+
namespace CodeDocumentor.Analyzers.Analyzers.Fields
1212
{
1313
/// <summary>
1414
/// The field analyzer.

0 commit comments

Comments
 (0)