fix stylecop errors and make additions required for different package…

… flavors in appxmanifest
microsoft · Jul 31, 2024 · e7bc4e1 · e7bc4e1
1 parent ce7aa4c
commit e7bc4e1
Show file tree

Hide file tree

Showing 16 changed files with 185 additions and 115 deletions.
diff --git a/extensions/GitExtension/FileExplorerGitIntegration/Models/GitConfiguration.cs b/extensions/GitExtension/FileExplorerGitIntegration/Models/GitConfiguration.cs
@@ -12,15 +12,15 @@ public class GitConfiguration : IDisposable
 {
     public GitExecutableConfigOptions GitExecutableConfigOptions { get; set; }
 
-    private readonly FileService fileService;
+    private readonly FileService _fileService;
 
     private string GitExeInstallPath { get; set; } = string.Empty;
 
-    private readonly object fileLock = new();
+    private readonly object _fileLock = new();
 
-    private readonly ILogger log = Log.ForContext<GitDetect>();
+    private readonly ILogger _log = Log.ForContext<GitDetect>();
 
-    private readonly string tempConfigurationFileName = "TemporaryGitConfiguration.json";
+    private readonly string _tempConfigurationFileName = "TemporaryGitConfiguration.json";
 
     public GitConfiguration(string? path)
     {
@@ -39,22 +39,22 @@ public GitConfiguration(string? path)
             GitExecutableConfigFolderPath = folderPath,
         };
 
-        fileService = new FileService();
+        _fileService = new FileService();
         EnsureConfigFileCreation();
     }
 
     public string ReadInstallPath()
     {
-        lock (fileLock)
+        lock (_fileLock)
         {
-            GitExeInstallPath = fileService.Read<string>(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName);
+            GitExeInstallPath = _fileService.Read<string>(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName);
             return GitExeInstallPath;
         }
     }
 
     public void EnsureConfigFileCreation()
     {
-        lock (fileLock)
+        lock (_fileLock)
         {
             if (!Directory.Exists(GitExecutableConfigOptions.GitExecutableConfigFolderPath))
             {
@@ -64,8 +64,8 @@ public void EnsureConfigFileCreation()
             var configFileFullPath = Path.Combine(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName);
             if (!File.Exists(configFileFullPath))
             {
-                fileService.Save(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName, string.Empty);
-                log.Information("The git configuration file did not exists and has just been created");
+                _fileService.Save(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName, string.Empty);
+                _log.Information("The git configuration file did not exists and has just been created");
             }
         }
     }
@@ -77,14 +77,14 @@ public bool IsGitExeInstallPathSet()
 
     public bool StoreGitExeInstallPath(string path)
     {
-        lock (fileLock)
+        lock (_fileLock)
         {
-            log.Information("Setting Git Exe Install Path");
+            _log.Information("Setting Git Exe Install Path");
             GitExeInstallPath = path;
 
-            fileService.Save(GitExecutableConfigOptions.GitExecutableConfigFolderPath, tempConfigurationFileName, GitExeInstallPath);
-            File.Replace(Path.Combine(GitExecutableConfigOptions.GitExecutableConfigFolderPath, tempConfigurationFileName), Path.Combine(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName), null);
-            log.Information("Git Exe Install Path stored successfully");
+            _fileService.Save(GitExecutableConfigOptions.GitExecutableConfigFolderPath, _tempConfigurationFileName, GitExeInstallPath);
+            File.Replace(Path.Combine(GitExecutableConfigOptions.GitExecutableConfigFolderPath, _tempConfigurationFileName), Path.Combine(GitExecutableConfigOptions.GitExecutableConfigFolderPath, GitExecutableConfigOptions.GitExecutableConfigFileName), null);
+            _log.Information("Git Exe Install Path stored successfully");
             return true;
         }
     }

diff --git a/extensions/GitExtension/FileExplorerGitIntegration/Models/GitDetect.cs b/extensions/GitExtension/FileExplorerGitIntegration/Models/GitDetect.cs
@@ -11,7 +11,7 @@ public class GitDetect
 {
     public GitConfiguration GitConfiguration { get; set; }
 
-    private readonly ILogger log = Log.ForContext<GitDetect>();
+    private readonly ILogger _log = Log.ForContext<GitDetect>();
 
     public GitDetect()
     {
@@ -74,13 +74,13 @@ private string[] FindSubdirectories(string installLocation)
             }
             else
             {
-                log.Warning("Install location does not exist: {InstallLocation}", installLocation);
+                _log.Warning("Install location does not exist: {InstallLocation}", installLocation);
                 return Array.Empty<string>();
             }
         }
         catch (Exception ex)
         {
-            log.Warning(ex, "Failed to find subdirectories in install location: {InstallLocation}", installLocation);
+            _log.Warning(ex, "Failed to find subdirectories in install location: {InstallLocation}", installLocation);
             return Array.Empty<string>();
         }
     }
@@ -97,12 +97,12 @@ private bool CheckForExeInPaths(string[] possiblePaths)
             if (isValid)
             {
                 GitConfiguration.StoreGitExeInstallPath(gitPath);
-                log.Information("Git Exe Install Path found");
+                _log.Information("Git Exe Install Path found");
                 return true;
             }
         }
 
-        log.Debug("Git.exe not found in paths examined");
+        _log.Debug("Git.exe not found in paths examined");
         return false;
     }
 

diff --git a/extensions/GitExtension/FileExplorerGitIntegration/Models/GitExeceutableConfigOptions.cs b/extensions/GitExtension/FileExplorerGitIntegration/Models/GitExeceutableConfigOptions.cs
@@ -15,13 +15,13 @@ public partial class GitExecutableConfigOptions
 
     public string GitExecutableConfigFileName { get; set; } = GitExecutableConfigFileNameDefault;
 
-    private readonly string gitExecutableConfigFolderPathDefault = Path.Combine(Path.GetTempPath(), "FileExplorerGitIntegration");
+    private readonly string _gitExecutableConfigFolderPathDefault = Path.Combine(Path.GetTempPath(), "FileExplorerGitIntegration");
 
-    private string? gitExecutableConfigFolderPath;
+    private string? _gitExecutableConfigFolderPath;
 
     public string GitExecutableConfigFolderPath
     {
-        get => gitExecutableConfigFolderPath is null ? gitExecutableConfigFolderPathDefault : gitExecutableConfigFolderPath;
-        set => gitExecutableConfigFolderPath = string.IsNullOrEmpty(value) ? gitExecutableConfigFolderPathDefault : value;
+        get => _gitExecutableConfigFolderPath is null ? _gitExecutableConfigFolderPathDefault : _gitExecutableConfigFolderPath;
+        set => _gitExecutableConfigFolderPath = string.IsNullOrEmpty(value) ? _gitExecutableConfigFolderPathDefault : value;
     }
 }
diff --git a/extensions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepository.cs b/extensions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepository.cs
@@ -15,7 +15,7 @@ public sealed class GitLocalRepository : ILocalRepository
 {
     private readonly RepositoryCache? _repositoryCache;
 
-    private readonly Serilog.ILogger log = Log.ForContext("SourceContext", nameof(GitLocalRepository));
+    private readonly Serilog.ILogger _log = Log.ForContext("SourceContext", nameof(GitLocalRepository));
 
     public string RootFolder
     {
@@ -63,7 +63,7 @@ IPropertySet ILocalRepository.GetProperties(string[] properties, string relative
 
         if (repository == null)
         {
-            log.Debug("GetProperties: Repository object is null");
+            _log.Debug("GetProperties: Repository object is null");
             return result;
         }
 
@@ -161,7 +161,7 @@ IPropertySet ILocalRepository.GetProperties(string[] properties, string relative
             }
         }
 
-        log.Debug("Returning source control properties from git source control extension");
+        _log.Debug("Returning source control properties from git source control extension");
         return result;
     }
 

diff --git a/...sions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepositoryProviderFactory.cs b/...sions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepositoryProviderFactory.cs
@@ -10,14 +10,20 @@ namespace FileExplorerGitIntegration.Models;
 
 [ComVisible(true)]
 [ClassInterface(ClassInterfaceType.None)]
+#if CANARY_BUILD
+[Guid("A65E46FF-F979-480d-A379-1FDA3EB5F7C5")]
+#elif STABLE_BUILD
+[Guid("8A962CBD-530D-4195-8FE3-F0DF3FDDF128")]
+#else
 [Guid("BDA76685-E749-4f09-8F13-C466D0802DA1")]
+#endif
 public class GitLocalRepositoryProviderFactory : ILocalRepositoryProvider
 {
     private readonly RepositoryCache? _repositoryCache;
 
     public string DisplayName => "GitLocalRepositoryProviderFactory";
 
-    private readonly StringResource stringResource = new("FileExplorerGitIntegration.pri", "Resources");
+    private readonly StringResource _stringResource = new("FileExplorerGitIntegration.pri", "Resources");
     private readonly string _errorResourceKey = "GetRepositoryError";
 
     GetLocalRepositoryResult ILocalRepositoryProvider.GetRepository(string rootPath)
@@ -30,7 +36,7 @@ GetLocalRepositoryResult ILocalRepositoryProvider.GetRepository(string rootPath)
         {
             var log = Log.ForContext("SourceContext", nameof(GitLocalRepositoryProviderFactory));
             log.Error("GitLocalRepositoryProviderFactory", "Failed to create GitLocalRepository", ex);
-            return new GetLocalRepositoryResult(ex, stringResource.GetLocalized(_errorResourceKey), $"Message: {ex.Message} and HRESULT: {ex.HResult}");
+            return new GetLocalRepositoryResult(ex, _stringResource.GetLocalized(_errorResourceKey), $"Message: {ex.Message} and HRESULT: {ex.HResult}");
         }
     }
 

diff --git a/...nsions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepositoryProviderServer.cs b/...nsions/GitExtension/FileExplorerGitIntegration/Models/GitLocalRepositoryProviderServer.cs
@@ -13,8 +13,8 @@ namespace FileExplorerGitIntegration.Models;
 
 public sealed class GitLocalRepositoryProviderServer : IDisposable
 {
-    private readonly HashSet<uint> registrationCookies = new();
-    private readonly Serilog.ILogger log = Log.ForContext("SourceContext", nameof(GitLocalRepositoryProviderServer));
+    private readonly HashSet<uint> _registrationCookies = new();
+    private readonly Serilog.ILogger _log = Log.ForContext("SourceContext", nameof(GitLocalRepositoryProviderServer));
 
     [UnconditionalSuppressMessage(
         "ReflectionAnalysis",
@@ -23,9 +23,9 @@ public sealed class GitLocalRepositoryProviderServer : IDisposable
     public void RegisterGitRepositoryProviderServer<T>(Func<T> createGitRepositoryProviderServer)
         where T : GitLocalRepositoryProviderFactory
     {
-        log.Debug($"Registering class object:");
-        log.Debug($"CLSID: {typeof(T).GUID:B}");
-        log.Debug($"Type: {typeof(T)}");
+        _log.Debug($"Registering class object:");
+        _log.Debug($"CLSID: {typeof(T).GUID:B}");
+        _log.Debug($"Type: {typeof(T)}");
 
         uint cookie;
         var clsid = typeof(T).GUID;
@@ -41,8 +41,8 @@ public void RegisterGitRepositoryProviderServer<T>(Func<T> createGitRepositoryPr
             Marshal.ThrowExceptionForHR(hr);
         }
 
-        registrationCookies.Add(cookie);
-        log.Debug($"Cookie: {cookie}");
+        _registrationCookies.Add(cookie);
+        _log.Debug($"Cookie: {cookie}");
         hr = PInvoke.CoResumeClassObjects();
         if (hr < 0)
         {
@@ -63,10 +63,10 @@ public void Run()
 
     public void Dispose()
     {
-        log.Debug($"Revoking class object registrations:");
-        foreach (var cookie in registrationCookies)
+        _log.Debug($"Revoking class object registrations:");
+        foreach (var cookie in _registrationCookies)
         {
-            log.Debug($"Cookie: {cookie}");
+            _log.Debug($"Cookie: {cookie}");
             var hr = PInvoke.CoRevokeClassObject(cookie);
             Debug.Assert(hr >= 0, $"CoRevokeClassObject failed ({hr:x}). Cookie: {cookie}");
         }

diff --git a/extensions/GitExtension/FileExplorerGitIntegration/Models/RepositoryCache.cs b/extensions/GitExtension/FileExplorerGitIntegration/Models/RepositoryCache.cs
@@ -11,8 +11,8 @@ namespace FileExplorerGitIntegration.Models;
 internal sealed class RepositoryCache : IDisposable
 {
     private readonly ConcurrentDictionary<string, RepositoryWrapper> _repositoryCache = new();
-    private readonly Serilog.ILogger log = Log.ForContext("SourceContext", nameof(RepositoryCache));
-    private bool disposedValue;
+    private readonly Serilog.ILogger _log = Log.ForContext("SourceContext", nameof(RepositoryCache));
+    private bool _disposedValue;
 
     public RepositoryWrapper GetRepository(string rootFolder)
     {
@@ -51,7 +51,7 @@ public RepositoryWrapper GetRepository(string rootFolder)
 
     internal void Dispose(bool disposing)
     {
-        if (!disposedValue)
+        if (!_disposedValue)
         {
             if (disposing)
             {
@@ -62,7 +62,7 @@ internal void Dispose(bool disposing)
             }
 
             _repositoryCache.Clear();
-            disposedValue = true;
+            _disposedValue = true;
         }
     }
 

diff --git a/src/Package-Can.appxmanifest b/src/Package-Can.appxmanifest
@@ -87,6 +87,20 @@
             </com:ExeServer>
           </com:ComServer>
         </com:Extension>
+        <com:Extension Category="windows.comServer">
+          <com:ComServer>
+            <com:ExeServer Executable="DevHome.FileExplorerSourceControlIntegration.exe" Arguments="-RegisterProcessAsComServer" DisplayName="Source Control Core">
+              <com:Class Id="40FE4D6E-C9A0-48b4-A83E-AAA1D002C0D5" DisplayName="Core Extension" />
+            </com:ExeServer>
+          </com:ComServer>
+        </com:Extension>
+        <com:Extension Category="windows.comServer">
+          <com:ComServer>
+            <com:ExeServer Executable="FileExplorerGitIntegration.exe" Arguments="-RegisterProcessAsComServer" DisplayName="LocalRepositoryProvider">
+              <com:Class Id="A65E46FF-F979-480d-A379-1FDA3EB5F7C5" DisplayName="LocalRepositoryProvider" />
+            </com:ExeServer>
+          </com:ComServer>
+        </com:Extension>
         <uap3:Extension Category="windows.appExtension">
           <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID1" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameCoreExt" Description="ms-resource:AppDescriptionCoreExt">
             <uap3:Properties>
@@ -128,6 +142,20 @@
             </uap3:Properties>
           </uap3:AppExtension>
         </uap3:Extension>
+        <uap3:Extension Category="windows.appExtension">
+          <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">
+            <uap3:Properties>
+              <DevHomeProvider>
+                <Activation>
+                  <CreateInstance ClassId="A65E46FF-F979-480d-A379-1FDA3EB5F7C5" />
+                </Activation>
+                <SupportedInterfaces>
+                  <LocalRepository />
+                </SupportedInterfaces>
+              </DevHomeProvider>
+            </uap3:Properties>
+          </uap3:AppExtension>
+        </uap3:Extension>
         <uap3:Extension Category="windows.appExtension">
           <uap3:AppExtension Name="com.microsoft.windows.widgets" DisplayName="ms-resource:WidgetProviderDisplayNameCanary" Id="CoreWidgetProvider" PublicFolder="Public">
             <uap3:Properties>

diff --git a/src/Package-Dev.appxmanifest b/src/Package-Dev.appxmanifest
@@ -87,6 +87,20 @@
             </com:ExeServer>
           </com:ComServer>
         </com:Extension>
+        <com:Extension Category="windows.comServer">
+          <com:ComServer>
+            <com:ExeServer Executable="DevHome.FileExplorerSourceControlIntegration.exe" Arguments="-RegisterProcessAsComServer" DisplayName="Source Control Core">
+              <com:Class Id="40FE4D6E-C9A0-48b4-A83E-AAA1D002C0D5" DisplayName="Core Extension" />
+            </com:ExeServer>
+          </com:ComServer>
+        </com:Extension>
+        <com:Extension Category="windows.comServer">
+          <com:ComServer>
+            <com:ExeServer Executable="FileExplorerGitIntegration.exe" Arguments="-RegisterProcessAsComServer" DisplayName="LocalRepositoryProvider">
+              <com:Class Id="BDA76685-E749-4f09-8F13-C466D0802DA1" DisplayName="LocalRepositoryProvider" />
+            </com:ExeServer>
+          </com:ComServer>
+        </com:Extension>
         <uap3:Extension Category="windows.appExtension">
           <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID1" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameCoreExt" Description="ms-resource:AppDescriptionCoreExt">
             <uap3:Properties>
@@ -128,6 +142,20 @@
             </uap3:Properties>
           </uap3:AppExtension>
         </uap3:Extension>
+        <uap3:Extension Category="windows.appExtension">
+          <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">
+            <uap3:Properties>
+              <DevHomeProvider>
+                <Activation>
+                  <CreateInstance ClassId="BDA76685-E749-4f09-8F13-C466D0802DA1" />
+                </Activation>
+                <SupportedInterfaces>
+                  <LocalRepository />
+                </SupportedInterfaces>
+              </DevHomeProvider>
+            </uap3:Properties>
+          </uap3:AppExtension>
+        </uap3:Extension>
         <uap3:Extension Category="windows.appExtension">
           <uap3:AppExtension Name="com.microsoft.windows.widgets" DisplayName="ms-resource:WidgetProviderDisplayNameDev" Id="CoreWidgetProvider" PublicFolder="Public">
             <uap3:Properties>

diff --git a/src/Package.appxmanifest b/src/Package.appxmanifest
@@ -97,7 +97,7 @@
         <com:Extension Category="windows.comServer">
           <com:ComServer>
             <com:ExeServer Executable="FileExplorerGitIntegration.exe" Arguments="-RegisterProcessAsComServer" DisplayName="LocalRepositoryProvider">
-              <com:Class Id="BDA76685-E749-4f09-8F13-C466D0802DA1" DisplayName="LocalRepositoryProvider" />
+              <com:Class Id="8A962CBD-530D-4195-8FE3-F0DF3FDDF128" DisplayName="LocalRepositoryProvider" />
             </com:ExeServer>
           </com:ComServer>
         </com:Extension>
@@ -143,11 +143,11 @@
           </uap3:AppExtension>
         </uap3:Extension>
         <uap3:Extension Category="windows.appExtension">
-          <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="Git" Description="ms-resource:AppDescriptionGitExt">
+          <uap3:AppExtension Name="com.microsoft.devhome" Id="PG-SP-ID3" PublicFolder="Public" DisplayName="ms-resource:AppDisplayNameGitExt" Description="ms-resource:AppDescriptionGitExt">
             <uap3:Properties>
               <DevHomeProvider>
                 <Activation>
-                  <CreateInstance ClassId="BDA76685-E749-4f09-8F13-C466D0802DA1" />
+                  <CreateInstance ClassId="8A962CBD-530D-4195-8FE3-F0DF3FDDF128" />
                 </Activation>
                 <SupportedInterfaces>
                   <LocalRepository />

diff --git a/src/Strings/en-us/Resources.resw b/src/Strings/en-us/Resources.resw
@@ -318,4 +318,12 @@
     <value>Windows Subsystem for Linux</value>
     <comment>{Locked="Windows", "Linux"} Extension Description</comment>
   </data>
+  <data name="AppDisplayNameGitExt" xml:space="preserve">
+    <value>Git</value>
+    <comment>Git Extension Display Name</comment>
+  </data>
+  <data name="AppDescriptionGitExt" xml:space="preserve">
+    <value>Allows integration of GIt with File Explorer</value>
+    <comment>Git Extension Description</comment>
+  </data>
 </root>