Merge pull request #36 from Lombiq/issue/OSOE-179

OSOE-179: Updating Analyzers to latest
Lombiq · Oct 16, 2023 · 2c88e71 · 2c88e71
2 parents 8fdf69d + 61ea80c
commit 2c88e71
Show file tree

Hide file tree

Showing 10 changed files with 50 additions and 31 deletions.
diff --git a/Lombiq.Vsix.Orchard/Commands/InjectDependencyCommand.cs b/Lombiq.Vsix.Orchard/Commands/InjectDependencyCommand.cs
@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.ComponentModel.Design;
 using System.Diagnostics.CodeAnalysis;
+using System.Threading;
 using System.Windows.Forms;
 using Task = System.Threading.Tasks.Task;
 
@@ -22,6 +23,8 @@ internal sealed class InjectDependencyCommand
         private readonly IEnumerable<IFieldNameFromDependencyGenerator> _fieldNameGenerators;
         private readonly IEnumerable<IDependencyNameProvider> _dependencyNameProviders;
 
+        private CancellationToken _cancellationToken;
+
         public static InjectDependencyCommand Instance { get; private set; }
 
         private InjectDependencyCommand(
@@ -42,9 +45,12 @@ await package.GetServiceAsync<IDependencyInjector>().ConfigureAwait(true),
                 await package.GetServicesAsync<IFieldNameFromDependencyGenerator>().ConfigureAwait(true),
                 await package.GetServicesAsync<IDependencyNameProvider>().ConfigureAwait(true));
 
-        public async Task InitializeUIAsync()
+        public async Task InitializeUIAsync(CancellationToken cancellationToken)
         {
-            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+            _cancellationToken = cancellationToken;
+
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
+
             (await _package.GetServiceAsync<IMenuCommandService>().ConfigureAwait(true)).AddCommand(
                 new MenuCommand(
                     MenuItemCallback,
@@ -60,7 +66,7 @@ private void MenuItemCallback(object sender, EventArgs e) =>
 
         private async Task MenuItemCallbackAsync()
         {
-            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(_cancellationToken);
             const string injectDependencyCaption = "Inject Dependency";
             var dte = await _package.GetDteAsync().ConfigureAwait(true);
 

diff --git a/Lombiq.Vsix.Orchard/Commands/OpenErrorLogCommand.cs b/Lombiq.Vsix.Orchard/Commands/OpenErrorLogCommand.cs
@@ -10,6 +10,7 @@
 using System.ComponentModel.Design;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Threading;
 using System.Threading.Tasks;
 using Task = System.Threading.Tasks.Task;
 
@@ -30,6 +31,7 @@ internal sealed class OpenErrorLogCommand : IAsyncDisposable
         private bool _hasSeenErrorLogUpdate;
         private bool _errorIndicatorStateChanged;
         private ILogFileStatus _latestUpdatedLogFileStatus;
+        private CancellationToken _cancellationToken;
 
         private OpenErrorLogCommand(
             AsyncPackage package,
@@ -53,12 +55,14 @@ public static async Task CreateAsync(AsyncPackage package, ILogWatcherSettingsAc
                 await package.GetServicesAsync<ILogFileWatcher>().ConfigureAwait(true),
                 await package.GetServiceAsync<IBlinkStickManager>().ConfigureAwait(true));
 
-            await Instance.InitalizeWatchersAsync().ConfigureAwait(true);
+            await Instance.InitializeWatchersAsync().ConfigureAwait(true);
         }
 
-        public async Task InitializeUIAsync()
+        public async Task InitializeUIAsync(CancellationToken cancellationToken)
         {
-            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+            _cancellationToken = cancellationToken;
+
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
 
             _openErrorLogCommand = new OleMenuCommand(OpenErrorLogCallback, new CommandID(CommandSet, CommandId));
             _openErrorLogCommand.BeforeQueryStatus += OpenErrorLogCommandBeforeQueryStatusCallback;
@@ -82,7 +86,7 @@ public async ValueTask DisposeAsync()
             (await _logWatcherSettingsAccessor.GetSettingsAsync().ConfigureAwait(true)).SettingsUpdated -= LogWatcherSettingsUpdatedCallback;
         }
 
-        private async Task InitalizeWatchersAsync()
+        private async Task InitializeWatchersAsync()
         {
             _hasSeenErrorLogUpdate = true;
             _errorIndicatorStateChanged = true;
@@ -150,36 +154,39 @@ private void LogWatcherSettingsUpdatedCallback(object sender, LogWatcherSettings
 
         private async Task LogWatcherSettingsUpdatedCallbackAsync(LogWatcherSettingsUpdatedEventArgs e)
         {
-            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(_cancellationToken);
             var isEnabled = e.Settings.LogWatcherEnabled;
             var orchardLogWatcherToolbar = ((CommandBars)(await _package.GetDteAsync()
                 .ConfigureAwait(true)).CommandBars)[CommandBarNames.OrchardLogWatcherToolbarName];
             orchardLogWatcherToolbar.Visible = isEnabled;
 
             // Since this method will be called from the UI thread not blocking it with the watcher changes that can
             // potentially take some time.
-            await Task.Run(() =>
-            {
-                // If the settings are repeatedly change then wait for the first one to finish before starting the next.
-                lock (_settingsChangeLock)
+            await Task.Run(
+                () =>
                 {
-                    if (isEnabled)
+                    // If the settings are repeatedly change then wait for the first one to finish before starting the next.
+                    lock (_settingsChangeLock)
                     {
-                        StartLogFileWatching();
+                        if (isEnabled)
+                        {
+                            StartLogFileWatching();
+                        }
+                        else
+                        {
+                            StopLogFileWatching();
+                        }
                     }
-                    else
-                    {
-                        StopLogFileWatching();
-                    }
-                }
-            }).ConfigureAwait(true);
+                },
+                _cancellationToken)
+            .ConfigureAwait(true);
 
             await UpdateOpenErrorLogCommandAccessibilityAndTextAsync().ConfigureAwait(true);
         }
 
         private async Task UpdateOpenErrorLogCommandAccessibilityAndTextAsync(ILogFileStatus logFileStatus = null)
         {
-            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(_cancellationToken);
             var logWatcherSettings = await _logWatcherSettingsAccessor.GetSettingsAsync().ConfigureAwait(true);
 
             if (!(await _package.GetDteAsync().ConfigureAwait(true)).SolutionIsOpen())

diff --git a/Lombiq.Vsix.Orchard/Directory.Build.props b/Lombiq.Vsix.Orchard/Directory.Build.props
@@ -1,3 +1,8 @@
 <Project>
-  <Import Project="../tools/Lombiq.Analyzers/VisualStudioExtension.Build.props" />
+  <!-- Uncomment this to run .NET static code analyzers during rebuilds. -->
+  <!--<PropertyGroup>
+    <RunAnalyzersDuringBuild>true</RunAnalyzersDuringBuild>
+  </PropertyGroup>-->
+
+  <Import Project="../tools/Lombiq.Analyzers/Lombiq.Analyzers.VisualStudioExtension/Build.props" />
 </Project>
diff --git a/Lombiq.Vsix.Orchard/Lombiq.Vsix.Orchard.csproj b/Lombiq.Vsix.Orchard/Lombiq.Vsix.Orchard.csproj
@@ -152,6 +152,7 @@
     <Content Include="Readme.md">
       <IncludeInVSIX>true</IncludeInVSIX>
     </Content>
+    <None Include="Directory.Build.props" />
     <None Include="source.extension.vsixmanifest">
       <SubType>Designer</SubType>
     </None>

diff --git a/Lombiq.Vsix.Orchard/LombiqOrchardVisualStudioExtensionPackage.cs b/Lombiq.Vsix.Orchard/LombiqOrchardVisualStudioExtensionPackage.cs
@@ -65,8 +65,8 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
             await InjectDependencyCommand.CreateAsync(this).ConfigureAwait(true);
             await OpenErrorLogCommand.CreateAsync(this, this).ConfigureAwait(true);
 
-            await InjectDependencyCommand.Instance.InitializeUIAsync().ConfigureAwait(true);
-            await OpenErrorLogCommand.Instance.InitializeUIAsync().ConfigureAwait(true);
+            await InjectDependencyCommand.Instance.InitializeUIAsync(cancellationToken).ConfigureAwait(true);
+            await OpenErrorLogCommand.Instance.InitializeUIAsync(cancellationToken).ConfigureAwait(true);
         }
 
         protected override void Dispose(bool disposing)

diff --git a/Lombiq.Vsix.Orchard/Models/DependencyName.cs b/Lombiq.Vsix.Orchard/Models/DependencyName.cs
@@ -11,8 +11,8 @@ public class DependencyName
 
     public class DependencyNameEqualityComparer : IEqualityComparer<DependencyName>
     {
-        public bool Equals(DependencyName first, DependencyName second) => first.Name == second.Name;
+        public bool Equals(DependencyName x, DependencyName y) => x.Name == y.Name;
 
-        public int GetHashCode(DependencyName dependencyName) => StringComparer.Ordinal.GetHashCode(dependencyName);
+        public int GetHashCode(DependencyName obj) => StringComparer.Ordinal.GetHashCode(obj);
     }
 }
diff --git a/Lombiq.Vsix.Orchard/Models/LogFileStatus.cs b/Lombiq.Vsix.Orchard/Models/LogFileStatus.cs
@@ -46,6 +46,6 @@ public override bool Equals(object obj)
         }
 
         public override int GetHashCode() =>
-            StringComparer.Ordinal.GetHashCode($"{HasContent}/{Exists}/{Path}/{LastUpdatedUtc}");
+            StringComparer.Ordinal.GetHashCode(FormattableString.Invariant($"{HasContent}/{Exists}/{Path}/{LastUpdatedUtc}"));
     }
 }
diff --git a/Lombiq.Vsix.Orchard/Services/DependencyInjector/FieldNameFromDependencyGeneratorBase.cs b/Lombiq.Vsix.Orchard/Services/DependencyInjector/FieldNameFromDependencyGeneratorBase.cs
@@ -61,7 +61,7 @@ protected virtual string GetCamelCased(string value)
             return char.ToLowerInvariant(value[0]) + value.Substring(1);
         }
 
-        private static IEnumerable<char> GetUpperCasedLetters(string value) =>
-            value.Where(letter => char.IsUpper(letter));
+        private static List<char> GetUpperCasedLetters(string value) =>
+            value.Where(letter => char.IsUpper(letter)).ToList();
     }
 }
diff --git a/Lombiq.Vsix.Orchard/Services/LogWatcher/LogFileWatcherBase.cs b/Lombiq.Vsix.Orchard/Services/LogWatcher/LogFileWatcherBase.cs
@@ -174,7 +174,7 @@ protected virtual IEnumerable<string> GetAllMatchingPaths(
             IEnumerable<string> patterns,
             string logFileName)
         {
-            var fullPaths = patterns.Select(pattern => Path.Combine(root, pattern, logFileName).Replace("/", "\\"));
+            var fullPaths = patterns.Select(pattern => Path.Combine(root, pattern, logFileName).Replace('/', '\\'));
 
             return fullPaths.SelectMany(fullPath =>
             {

diff --git a/tools/Lombiq.Analyzers b/tools/Lombiq.Analyzers