Update code style, refactor code, enable nullability by default.

Author: jiripolasek

.editorconfig

@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.9.34310.174
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EditorBar", "src\EditorBar\EditorBar.csproj", "{097E6F5A-F198-49F5-B4CC-28128E82FE43}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JPSoftworks.EditorBar", "src\EditorBar\JPSoftworks.EditorBar.csproj", "{097E6F5A-F198-49F5-B4CC-28128E82FE43}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{7FAD5B22-8341-4C9B-ACE6-4BE9AAD2D3EF}"
 	ProjectSection(SolutionItems) = preProject

EditorBar.sln

@@ -1,4 +1,10 @@
-using System.ComponentModel.Composition;
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
+
+using System.ComponentModel.Composition;
 using JPSoftworks.EditorBar.Options;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Editor;
@@ -8,15 +14,15 @@ namespace JPSoftworks.EditorBar;
 
 [Export(typeof(IWpfTextViewMarginProvider))]
 [Name("EditorBar-Bottom")]
-[Order(After = "Wpf Horizontal Scrollbar")]
+[Order(After = PredefinedMarginNames.HorizontalScrollBar)]
 [MarginContainer(PredefinedMarginNames.Bottom)]
-[ContentType("text")]
+[ContentType(StandardContentTypeNames.Text)]
 [TextViewRole(PredefinedTextViewRoles.Editable)]
 public class BottomEditorBarFactory : IWpfTextViewMarginProvider
 {
     private bool _isBottom;
     private IWpfTextView? _textView;
-    private IWpfTextViewMargin _currentMargin;
+    private IWpfTextViewMargin? _currentMargin;
 
     public BottomEditorBarFactory()
     {
@@ -50,7 +56,7 @@ private static void RefreshTextView(IWpfTextView textView)
     }
 
 
-    public IWpfTextViewMargin CreateMargin(IWpfTextViewHost wpfTextViewHost, IWpfTextViewMargin marginContainer)
+    public IWpfTextViewMargin? CreateMargin(IWpfTextViewHost wpfTextViewHost, IWpfTextViewMargin marginContainer)
     {
         _isBottom = GeneralPage.Instance.BarPosition == BarPosition.Bottom;
         _textView = wpfTextViewHost.TextView;

src/EditorBar/BottomEditorBarFactory.cs

@@ -1,27 +1,24 @@
-#nullable enable
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
 
-using System;
-using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
-using System.Linq;
-using System.Threading.Tasks;
 using System.Windows;
-using System.Windows.Controls;
 using Community.VisualStudio.Toolkit;
-using EnvDTE;
 using JPSoftworks.EditorBar.Options;
 using Microsoft.VisualStudio.Shell;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Editor;
-using Project = EnvDTE.Project;
 
 namespace JPSoftworks.EditorBar;
 
 /// <summary>
 ///     Interaction logic for EditorBarControl.xaml
 /// </summary>
-public partial class EditorBarControl : UserControl, IWpfTextViewMargin
+public partial class EditorBarControl : IWpfTextViewMargin
 {
     private readonly IWpfTextView? _textView;
 
@@ -35,14 +32,14 @@ public EditorBarControl(IWpfTextView textView)
 
         InitializeComponent();
 
-        Loaded += async (_, _) => await UpdateAsync();
-        GeneralPage.Saved += async _ => await UpdateAsync();
-        VS.Events.ProjectItemsEvents.AfterRenameProjectItems += async _ => await UpdateAsync();
-        VS.Events.ProjectItemsEvents.AfterAddProjectItems += async _ => await UpdateAsync();
-        VS.Events.ProjectItemsEvents.AfterRemoveProjectItems += async _ => await UpdateAsync();
-        VS.Events.DocumentEvents.Saved += async _ => await UpdateAsync();
-        VS.Events.SolutionEvents.OnAfterRenameProject += async _ => await UpdateAsync();
-        VS.Events.SolutionEvents.OnAfterOpenSolution += async _ => await UpdateAsync();
+        Loaded += (_, _) => UpdateAsync().FireAndForget();
+        GeneralPage.Saved += _ => UpdateAsync().FireAndForget();
+        VS.Events.ProjectItemsEvents.AfterRenameProjectItems += _ => UpdateAsync().FireAndForget();
+        VS.Events.ProjectItemsEvents.AfterAddProjectItems += _ => UpdateAsync().FireAndForget();
+        VS.Events.ProjectItemsEvents.AfterRemoveProjectItems += _ => UpdateAsync().FireAndForget();
+        VS.Events.DocumentEvents.Saved += _ => UpdateAsync().FireAndForget();
+        VS.Events.SolutionEvents.OnAfterRenameProject += _ => UpdateAsync().FireAndForget();
+        VS.Events.SolutionEvents.OnAfterOpenSolution += _ => UpdateAsync().FireAndForget();
     }
 
     public void Dispose()
@@ -81,11 +78,11 @@ private async Task UpdateAsync()
         document.FileActionOccurred -= DocumentOnFileActionOccurred;
         document.FileActionOccurred += DocumentOnFileActionOccurred;
         UpdateFilePathLabel(document);
-        var project = await GetProjectFromDocumentAsync(document);
+        var project = await VisualStudioHelper.GetProjectFromDocumentAsync(document);
         ProjectNameLabel.Content = project == null ? "(no project)" : project.Name;
         if (project != null)
         {
-            var parents = await GetSolutionFolderPathAsync(await ConvertToSolutionItemAsync(project));
+            var parents = await VisualStudioHelper.GetSolutionFolderPathAsync(await VisualStudioHelper.ConvertToSolutionItemAsync(project));
             SolutionFoldersList.ItemsSource = parents;
         }
         else
@@ -95,7 +92,7 @@ private async Task UpdateAsync()
             if (project2 != null)
             {
                 ProjectNameLabel.Content = project2.Name;
-                var parents = await GetSolutionFolderPathAsync(project2);
+                var parents = await VisualStudioHelper.GetSolutionFolderPathAsync(project2);
                 SolutionFoldersList.ItemsSource = parents;
             }
         }
@@ -110,7 +107,7 @@ private void UpdateFilePathLabel(ITextDocument document)
         {
             var slnPath = currentSolution.FullPath;
             var slnDir = Path.GetDirectoryName(slnPath);
-            RelativePath = GetRelativePath(FilePath, slnDir);
+            RelativePath = slnDir == null ? FilePath : GetRelativePath(FilePath, slnDir);
         }
         else
         {
@@ -132,57 +129,11 @@ private string GetRelativePath(string documentFilePath, string slnDir)
         return documentFilePath.Substring(slnDir.Length);
     }
 
-    private async Task<SolutionItem> ConvertToSolutionItemAsync(Project dteProject)
-    {
-        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
-        var all = await VS.Solutions.GetAllProjectsAsync(ProjectStateFilter.All);
-        return all.FirstOrDefault(t => t.FullPath == dteProject.FullName);
-    }
-
-
-    private async Task<Project?> GetProjectFromDocumentAsync(ITextDocument document)
-    {
-        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
-
-        var dte = (DTE)Package.GetGlobalService(typeof(DTE));
-        var projects = dte.Solution.Projects.OfType<Project>().ToList();
-        var projectFile = projects.FirstOrDefault(t => string.Equals(t.FullName, document.FilePath, StringComparison.OrdinalIgnoreCase));
-        if (projectFile != null)
-        {
-            return projectFile;
-        }
-
-        var projectItem = dte?.Solution.FindProjectItem(document.FilePath);
-        return projectItem?.ContainingProject;
-    }
-
-    private async Task<List<string>> GetSolutionFolderPathAsync(SolutionItem? project)
-    {
-        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
-
-        var folderPath = new List<string>();
-        if (project == null)
-        {
-            return folderPath;
-        }
-
-        var parent = project.FindParent(SolutionItemType.SolutionFolder);
-        while (parent != null)
-        {
-            folderPath.Add(parent.Name);
-            parent = parent.FindParent(SolutionItemType.SolutionFolder);
-        }
-
-        // Reverse to get the order from solution to project
-        folderPath.Reverse();
-        return folderPath;
-    }
-
 
     private async void DocumentOnFileActionOccurred(object sender, TextDocumentFileActionEventArgs e)
     {
         FilePath = e.FilePath;
-        await UpdateAsync();
+        UpdateAsync().FireAndForget();
     }
 
     private ITextDocument? GetCurrentDocument()
@@ -204,7 +155,7 @@ private void OpenFolderClicked(object sender, RoutedEventArgs e)
             var directoryName = Path.GetDirectoryName(fileName);
             if (!string.IsNullOrWhiteSpace(directoryName) && Directory.Exists(directoryName))
             {
-                System.Diagnostics.Process.Start(new ProcessStartInfo("explorer.exe", "/select, " + fileName) { UseShellExecute = true });
+                Process.Start(new ProcessStartInfo("explorer.exe", "/select, " + fileName) { UseShellExecute = true });
             }
         }
     }

src/EditorBar/EditorBarControl.xaml.cs

@@ -1,9 +1,13 @@
-using System;
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
+
 using System.Runtime.InteropServices;
 using System.Threading;
 using JPSoftworks.EditorBar.Options;
 using Microsoft.VisualStudio.Shell;
-using Task = System.Threading.Tasks.Task;
 
 namespace JPSoftworks.EditorBar;
 
@@ -35,8 +39,6 @@ public sealed class EditorBarPackage : AsyncPackage
     /// </summary>
     public const string PackageGuidString = "ef5d9a25-5e0d-4428-8762-56d4dc816eeb";
 
-    #region Package Members
-
     /// <summary>
     /// Initialization of the package; this method is called right after the package is sited, so this is the place
     /// where you can put all the initialization code that rely on services provided by VisualStudio.
@@ -50,6 +52,4 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
         // Do any initialization that requires the UI thread after switching to the UI thread.
         await this.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
     }
-
-    #endregion
 }

src/EditorBar/EditorBarPackage.cs

@@ -0,0 +1,10 @@
+// ------------------------------------------------------------
+// 
+// Copyright (c) Jiøí Polášek. All rights reserved.
+// 
+// ------------------------------------------------------------
+
+global using System;
+global using System.Collections.Generic;
+global using System.Linq;
+global using System.Threading.Tasks;

src/EditorBar/GlobalUsings.cs

@@ -7,15 +7,19 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
     <LangVersion>default</LangVersion>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|arm64'">
     <LangVersion>default</LangVersion>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|x86'">
     <LangVersion>default</LangVersion>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Release|arm64'">
     <LangVersion>default</LangVersion>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
@@ -51,6 +55,7 @@
     <LangVersion>default</LangVersion>
     <CreateVsixContainer>True</CreateVsixContainer>
     <CopyVsixExtensionFiles>False</CopyVsixExtensionFiles>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -60,16 +65,21 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <LangVersion>default</LangVersion>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="BottomEditorBarFactory.cs" />
     <Compile Include="EditorBarControl.xaml.cs">
       <DependentUpon>EditorBarControl.xaml</DependentUpon>
     </Compile>
+    <Compile Include="GlobalUsings.cs" />
+    <Compile Include="Options\BarPosition.cs" />
+    <Compile Include="Options\OptionsProvider.cs" />
     <Compile Include="TopEditorBarFactory.cs" />
     <Compile Include="Options\GeneralPage.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="EditorBarPackage.cs" />
+    <Compile Include="VisualStudioHelper.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="source.extension.vsixmanifest">
@@ -105,6 +115,10 @@
   </ItemGroup>
   <ItemGroup />
   <ItemGroup>
+    <Content Include="..\..\LICENSE.txt">
+      <Link>Resources\LICENSE.txt</Link>
+      <IncludeInVSIX>true</IncludeInVSIX>
+    </Content>
     <Content Include="Resources\Icon.png">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
       <IncludeInVSIX>true</IncludeInVSIX>

src/EditorBar/EditorBar.csproj …c/EditorBar/JPSoftworks.EditorBar.csprojsrc/EditorBar/EditorBar.csproj renamed to src/EditorBar/JPSoftworks.EditorBar.csproj src/EditorBar/EditorBar.csproj renamed to src/EditorBar/JPSoftworks.EditorBar.csproj

@@ -0,0 +1,13 @@
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
+
+namespace JPSoftworks.EditorBar.Options;
+
+public enum BarPosition
+{
+    Top = 0,
+    Bottom = 1
+}

src/EditorBar/Options/BarPosition.cs

@@ -1,19 +1,14 @@
-using System;
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
+
 using System.ComponentModel;
-using System.Runtime.InteropServices;
-using System.Threading.Tasks;
 using Community.VisualStudio.Toolkit;
 
 namespace JPSoftworks.EditorBar.Options;
 
-internal partial class OptionsProvider
-{
-    // Register the options with this attribute on your package class:
-    // [ProvideOptionPage(typeof(OptionsProvider.GeneralPageOptions), "EditorBar.Options", "GeneralPage", 0, 0, true, SupportsProfiles = true)]
-    [ComVisible(true)]
-    public class GeneralPageOptions : BaseOptionPage<GeneralPage> { }
-}
-
 public class GeneralPage : BaseOptionModel<GeneralPage>
 {
     [Category("Apperance")]
@@ -22,7 +17,7 @@ public class GeneralPage : BaseOptionModel<GeneralPage>
     [DefaultValue(Options.BarPosition.Top)]
     [TypeConverter(typeof(EnumConverter))]
     public BarPosition BarPosition { get; set; } = BarPosition.Top;
-        
+
     [Category("Apperance")]
     [DisplayName("Show relative path")]
     [Description("Show path relative to the solution root")]
@@ -34,10 +29,4 @@ public override Task SaveAsync()
         Console.WriteLine("Saving...");
         return base.SaveAsync();
     }
-}
-
-public enum BarPosition
-{
-    Top = 0,
-    Bottom = 1
 }

src/EditorBar/Options/GeneralPage.cs

@@ -0,0 +1,18 @@
+// ------------------------------------------------------------
+//
+// Copyright (c) Jiří Polášek. All rights reserved.
+//
+// ------------------------------------------------------------
+
+using System.Runtime.InteropServices;
+using Community.VisualStudio.Toolkit;
+
+namespace JPSoftworks.EditorBar.Options;
+
+internal partial class OptionsProvider
+{
+    // Register the options with this attribute on your package class:
+    // [ProvideOptionPage(typeof(OptionsProvider.GeneralPageOptions), "EditorBar.Options", "GeneralPage", 0, 0, true, SupportsProfiles = true)]
+    [ComVisible(true)]
+    public class GeneralPageOptions : BaseOptionPage<GeneralPage> { }
+}