Fixed all 'suppressable to suppressible' misspellings. Added tfm/tfms…

… to the exclusion list.
dotnet · Sep 27, 2023 · 28e5599 · 28e5599
1 parent 6088e2f
commit 28e5599
Show file tree

Hide file tree

Showing 25 changed files with 77 additions and 75 deletions.
diff --git a/exclusion.dic b/exclusion.dic
@@ -8,6 +8,8 @@ nupkg
 nuspec
 sdk
 sdks
+tfm
+tfms
 url
 urls
 xamarin

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ApiCompatServiceProvider.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ApiCompatServiceProvider.cs
@@ -14,17 +14,17 @@ namespace Microsoft.DotNet.ApiCompat
     internal sealed class ApiCompatServiceProvider
     {
         private readonly Lazy<ISuppressionEngine> _suppressionEngine;
-        private readonly Lazy<ISuppressableLog> _compatibilityLogger;
+        private readonly Lazy<ISuppressibleLog> _compatibilityLogger;
         private readonly Lazy<IApiCompatRunner> _apiCompatRunner;
 
-        internal ApiCompatServiceProvider(Func<ISuppressionEngine, ISuppressableLog> logFactory,
+        internal ApiCompatServiceProvider(Func<ISuppressionEngine, ISuppressibleLog> logFactory,
             Func<ISuppressionEngine> suppressionEngineFactory,
-            Func<ISuppressableLog, IRuleFactory> ruleFactory,
+            Func<ISuppressibleLog, IRuleFactory> ruleFactory,
             bool respectInternals,
             string[]? excludeAttributesFiles)
         {
             _suppressionEngine = new Lazy<ISuppressionEngine>(suppressionEngineFactory);
-            _compatibilityLogger = new Lazy<ISuppressableLog>(() => logFactory(SuppressionEngine));
+            _compatibilityLogger = new Lazy<ISuppressibleLog>(() => logFactory(SuppressionEngine));
             _apiCompatRunner = new Lazy<IApiCompatRunner>(() =>
             {
                 CompositeSymbolFilter compositeSymbolFilter = new CompositeSymbolFilter()
@@ -42,15 +42,15 @@ internal ApiCompatServiceProvider(Func<ISuppressionEngine, ISuppressableLog> log
                         new TypedConstantEqualityComparer(symbolEqualityComparer)),
                     respectInternals);
 
-                return new ApiCompatRunner(SuppressableLog,
+                return new ApiCompatRunner(SuppressibleLog,
                     SuppressionEngine,
-                    new ApiComparerFactory(ruleFactory(SuppressableLog), apiComparerSettings),
+                    new ApiComparerFactory(ruleFactory(SuppressibleLog), apiComparerSettings),
                     new AssemblySymbolLoaderFactory(respectInternals));
             });
         }
 
         public ISuppressionEngine SuppressionEngine => _suppressionEngine.Value;
-        public ISuppressableLog SuppressableLog => _compatibilityLogger.Value;
+        public ISuppressibleLog SuppressibleLog => _compatibilityLogger.Value;
         public IApiCompatRunner ApiCompatRunner => _apiCompatRunner.Value;
     }
 }
diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/SuppressionFileHelper.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/SuppressionFileHelper.cs
@@ -22,7 +22,7 @@ public static ISuppressionEngine CreateSuppressionEngine(string[]? suppressionFi
 
         // Write the suppression file to disk and throw if a path isn't provided.
         public static void GenerateSuppressionFile(ISuppressionEngine suppressionEngine,
-            ISuppressableLog log,
+            ISuppressibleLog log,
             bool preserveUnnecessarySuppressions,
             string[]? suppressionFiles,
             string? suppressionOutputFile)
@@ -47,7 +47,7 @@ public static void GenerateSuppressionFile(ISuppressionEngine suppressionEngine,
         }
 
         // Log whether or not we found breaking changes. If we are writing to a suppression file, no need to log anything.
-        public static void LogApiCompatSuccessOrFailure(bool generateSuppressionFile, ISuppressableLog log)
+        public static void LogApiCompatSuccessOrFailure(bool generateSuppressionFile, ISuppressibleLog log)
         {
             if (log.HasLoggedErrorSuppressions)
             {
@@ -63,7 +63,7 @@ public static void LogApiCompatSuccessOrFailure(bool generateSuppressionFile, IS
         }
 
         // Validate whether unnecessary suppressions exist and log those.
-        public static void ValidateUnnecessarySuppressions(ISuppressionEngine suppressionEngine, ISuppressableLog log)
+        public static void ValidateUnnecessarySuppressions(ISuppressionEngine suppressionEngine, ISuppressibleLog log)
         {
             IReadOnlyCollection<Suppression> unnecessarySuppressions = suppressionEngine.GetUnnecessarySuppressions();
             if (unnecessarySuppressions.Count == 0)

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssemblies.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidateAssemblies.cs
@@ -10,7 +10,7 @@ namespace Microsoft.DotNet.ApiCompat
 {
     internal static class ValidateAssemblies
     {
-        public static void Run(Func<ISuppressionEngine, ISuppressableLog> logFactory,
+        public static void Run(Func<ISuppressionEngine, ISuppressibleLog> logFactory,
             bool generateSuppressionFile,
             bool preserveUnnecessarySuppressions,
             bool permitUnnecessarySuppressions,
@@ -86,19 +86,19 @@ public static void Run(Func<ISuppressionEngine, ISuppressableLog> logFactory,
             // Execute the enqueued work item(s).
             apiCompatRunner.ExecuteWorkItems();
 
-            SuppressionFileHelper.LogApiCompatSuccessOrFailure(generateSuppressionFile, serviceProvider.SuppressableLog);
+            SuppressionFileHelper.LogApiCompatSuccessOrFailure(generateSuppressionFile, serviceProvider.SuppressibleLog);
 
             if (generateSuppressionFile)
             {
                 SuppressionFileHelper.GenerateSuppressionFile(serviceProvider.SuppressionEngine,
-                    serviceProvider.SuppressableLog,
+                    serviceProvider.SuppressibleLog,
                     preserveUnnecessarySuppressions,
                     suppressionFiles,
                     suppressionOutputFile);
             }
             else if (!permitUnnecessarySuppressions)
             {
-                SuppressionFileHelper.ValidateUnnecessarySuppressions(serviceProvider.SuppressionEngine, serviceProvider.SuppressableLog);
+                SuppressionFileHelper.ValidateUnnecessarySuppressions(serviceProvider.SuppressionEngine, serviceProvider.SuppressibleLog);
             }
         }
 

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackage.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Shared/ValidatePackage.cs
@@ -11,7 +11,7 @@ namespace Microsoft.DotNet.ApiCompat
 {
     internal static class ValidatePackage
     {
-        public static void Run(Func<ISuppressionEngine, ISuppressableLog> logFactory,
+        public static void Run(Func<ISuppressionEngine, ISuppressibleLog> logFactory,
             bool generateSuppressionFile,
             bool preserveUnnecessarySuppressions,
             bool permitUnnecessarySuppressions,
@@ -51,21 +51,21 @@ public static void Run(Func<ISuppressionEngine, ISuppressableLog> logFactory,
             Package package = Package.Create(packagePath, packageAssemblyReferences);
 
             // Invoke all validators and pass the specific validation options in. Don't execute work items, just enqueue them.
-            CompatibleTfmValidator tfmValidator = new(serviceProvider.SuppressableLog, serviceProvider.ApiCompatRunner);
+            CompatibleTfmValidator tfmValidator = new(serviceProvider.SuppressibleLog, serviceProvider.ApiCompatRunner);
             tfmValidator.Validate(new PackageValidatorOption(package,
                 enableStrictModeForCompatibleTfms,
                 enqueueApiCompatWorkItems: runApiCompat,
                 executeApiCompatWorkItems: false));
 
-            CompatibleFrameworkInPackageValidator compatibleFrameworkInPackageValidator = new(serviceProvider.SuppressableLog, serviceProvider.ApiCompatRunner);
+            CompatibleFrameworkInPackageValidator compatibleFrameworkInPackageValidator = new(serviceProvider.SuppressibleLog, serviceProvider.ApiCompatRunner);
             compatibleFrameworkInPackageValidator.Validate(new PackageValidatorOption(package,
                 enableStrictModeForCompatibleFrameworksInPackage,
                 enqueueApiCompatWorkItems: runApiCompat,
                 executeApiCompatWorkItems: false));
 
             if (!string.IsNullOrEmpty(baselinePackagePath))
             {
-                BaselinePackageValidator baselineValidator = new(serviceProvider.SuppressableLog, serviceProvider.ApiCompatRunner);
+                BaselinePackageValidator baselineValidator = new(serviceProvider.SuppressibleLog, serviceProvider.ApiCompatRunner);
                 baselineValidator.Validate(new PackageValidatorOption(package,
                     enableStrictMode: enableStrictModeForBaselineValidation,
                     enqueueApiCompatWorkItems: runApiCompat,
@@ -78,20 +78,20 @@ public static void Run(Func<ISuppressionEngine, ISuppressableLog> logFactory,
                 // Execute the work items that were enqueued.
                 serviceProvider.ApiCompatRunner.ExecuteWorkItems();
 
-                SuppressionFileHelper.LogApiCompatSuccessOrFailure(generateSuppressionFile, serviceProvider.SuppressableLog);
+                SuppressionFileHelper.LogApiCompatSuccessOrFailure(generateSuppressionFile, serviceProvider.SuppressibleLog);
             }
 
             if (generateSuppressionFile)
             {
                 SuppressionFileHelper.GenerateSuppressionFile(serviceProvider.SuppressionEngine,
-                    serviceProvider.SuppressableLog,
+                    serviceProvider.SuppressibleLog,
                     preserveUnnecessarySuppressions,
                     suppressionFiles,
                     suppressionOutputFile);
             }
             else if (!permitUnnecessarySuppressions)
             {
-                SuppressionFileHelper.ValidateUnnecessarySuppressions(serviceProvider.SuppressionEngine, serviceProvider.SuppressableLog);
+                SuppressionFileHelper.ValidateUnnecessarySuppressions(serviceProvider.SuppressionEngine, serviceProvider.SuppressibleLog);
             }
         }
     }

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Task/SuppressibleMSBuildLog.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Task/SuppressibleMSBuildLog.cs
@@ -9,7 +9,7 @@ namespace Microsoft.DotNet.ApiCompat.Task
     /// <summary>
     /// Class that can log Suppressions in an MSBuild task, by implementing MSBuildLog and ISuppressibleLog.
     /// </summary>
-    internal sealed class SuppressibleMSBuildLog : MSBuildLog, ISuppressableLog
+    internal sealed class SuppressibleMSBuildLog : MSBuildLog, ISuppressibleLog
     {
         private readonly ISuppressionEngine _suppressionEngine;
 

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/Program.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/Program.cs
@@ -196,7 +196,7 @@ static int Main(string[] args)
                 (string, string)[]? leftAssembliesTransformationPattern = parseResult.GetValue(leftAssembliesTransformationPatternOption);
                 (string, string)[]? rightAssembliesTransformationPattern = parseResult.GetValue(rightAssembliesTransformationPatternOption);
 
-                Func<ISuppressionEngine, SuppressableConsoleLog> logFactory = (suppressionEngine) => new(suppressionEngine, verbosity);
+                Func<ISuppressionEngine, SuppressibleConsoleLog> logFactory = (suppressionEngine) => new(suppressionEngine, verbosity);
                 ValidateAssemblies.Run(logFactory,
                     generateSuppressionFile,
                     preserveUnnecessarySuppressions,
@@ -310,7 +310,7 @@ static int Main(string[] args)
                 Dictionary<NuGetFramework, IEnumerable<string>>? packageAssemblyReferences = parseResult.GetValue(packageAssemblyReferencesOption);
                 Dictionary<NuGetFramework, IEnumerable<string>>? baselinePackageAssemblyReferences = parseResult.GetValue(baselinePackageAssemblyReferencesOption);
 
-                Func<ISuppressionEngine, SuppressableConsoleLog> logFactory = (suppressionEngine) => new(suppressionEngine, verbosity);
+                Func<ISuppressionEngine, SuppressibleConsoleLog> logFactory = (suppressionEngine) => new(suppressionEngine, verbosity);
                 ValidatePackage.Run(logFactory,
                     generateSuppressionFile,
                     preserveUnnecessarySuppressions,

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/SuppressibleConsoleLog.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompat.Tool/SuppressibleConsoleLog.cs
@@ -7,16 +7,16 @@
 namespace Microsoft.DotNet.ApiCompat.Tool
 {
     /// <summary>
-    /// Class that can log Suppressions to the Console, by implementing ConsoleLog and ISuppressableLog.
+    /// Class that can log Suppressions to the Console, by implementing ConsoleLog and ISuppressibleLog.
     /// </summary>
-    internal sealed class SuppressableConsoleLog : ConsoleLog, ISuppressableLog
+    internal sealed class SuppressibleConsoleLog : ConsoleLog, ISuppressibleLog
     {
         private readonly ISuppressionEngine _suppressionEngine;
 
         /// <inheritdoc />
         public bool HasLoggedErrorSuppressions { get; private set; }
 
-        public SuppressableConsoleLog(ISuppressionEngine suppressionEngine,
+        public SuppressibleConsoleLog(ISuppressionEngine suppressionEngine,
             MessageImportance messageImportance)
             : base(messageImportance)
         {

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Logging/ISuppressibleLog.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Logging/ISuppressibleLog.cs
@@ -8,7 +8,7 @@ namespace Microsoft.DotNet.ApiCompatibility.Logging
     /// <summary>
     /// Interface to define a logging abstraction for APICompat suppressions shared between Console and MSBuild tasks.
     /// </summary>
-    public interface ISuppressableLog : ILog
+    public interface ISuppressibleLog : ILog
     {
         /// <summary>
         /// Reports whether the logger emitted an error suppression.

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Rules/AssemblyIdentityMustMatch.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Rules/AssemblyIdentityMustMatch.cs
@@ -18,10 +18,10 @@ namespace Microsoft.DotNet.ApiCompatibility.Rules
     /// </summary>
     public class AssemblyIdentityMustMatch : IRule
     {
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly IRuleSettings _settings;
 
-        public AssemblyIdentityMustMatch(ISuppressableLog log,
+        public AssemblyIdentityMustMatch(ISuppressibleLog log,
             IRuleSettings settings,
             IRuleRegistrationContext context)
         {

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Rules/RuleFactory.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Rules/RuleFactory.cs
@@ -10,11 +10,11 @@ namespace Microsoft.DotNet.ApiCompatibility.Rules
     /// </summary>
     public class RuleFactory : IRuleFactory
     {
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly bool _enableRuleAttributesMustMatch;
         private readonly bool _enableRuleCannotChangeParameterName;
 
-        public RuleFactory(ISuppressableLog log,
+        public RuleFactory(ISuppressibleLog log,
             bool enableRuleAttributesMustMatch = false,
             bool enableRuleCannotChangeParameterName = false)
         {

diff --git a/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Runner/ApiCompatRunner.cs b/src/ApiCompat/Microsoft.DotNet.ApiCompatibility/Runner/ApiCompatRunner.cs
@@ -16,15 +16,15 @@ namespace Microsoft.DotNet.ApiCompatibility.Runner
     public class ApiCompatRunner : IApiCompatRunner
     {
         private readonly HashSet<ApiCompatRunnerWorkItem> _workItems = new();
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly ISuppressionEngine _suppressionEngine;
         private readonly IApiComparerFactory _apiComparerFactory;
         private readonly IAssemblySymbolLoaderFactory _assemblySymbolLoaderFactory;
 
         /// <inheritdoc />
         public IReadOnlyCollection<ApiCompatRunnerWorkItem> WorkItems => _workItems;
 
-        public ApiCompatRunner(ISuppressableLog log,
+        public ApiCompatRunner(ISuppressibleLog log,
             ISuppressionEngine suppressionEngine,
             IApiComparerFactory apiComparerFactory,
             IAssemblySymbolLoaderFactory assemblySymbolLoaderFactory)

diff --git a/src/ApiCompat/Microsoft.DotNet.PackageValidation/ApiCompatRunnerExtensions.cs b/src/ApiCompat/Microsoft.DotNet.PackageValidation/ApiCompatRunnerExtensions.cs
@@ -17,7 +17,7 @@ namespace Microsoft.DotNet.PackageValidation
     internal static class ApiCompatRunnerExtensions
     {
         public static void QueueApiCompatFromContentItem(this IApiCompatRunner apiCompatRunner,
-            ISuppressableLog log,
+            ISuppressibleLog log,
             IReadOnlyList<ContentItem> leftContentItems,
             IReadOnlyList<ContentItem> rightContentItems,
             ApiCompatRunnerOptions options,
@@ -55,7 +55,7 @@ public static void QueueApiCompatFromContentItem(this IApiCompatRunner apiCompat
             apiCompatRunner.EnqueueWorkItem(new ApiCompatRunnerWorkItem(left, options, right));
         }
 
-        private static MetadataInformation GetMetadataInformation(ISuppressableLog log,
+        private static MetadataInformation GetMetadataInformation(ISuppressibleLog log,
             Package package,
             ContentItem item,
             string? displayString = null,

diff --git a/src/ApiCompat/Microsoft.DotNet.PackageValidation/Validators/BaselinePackageValidator.cs b/src/ApiCompat/Microsoft.DotNet.PackageValidation/Validators/BaselinePackageValidator.cs
@@ -14,10 +14,10 @@ namespace Microsoft.DotNet.PackageValidation.Validators
     /// </summary>
     public class BaselinePackageValidator : IPackageValidator
     {
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly IApiCompatRunner _apiCompatRunner;
 
-        public BaselinePackageValidator(ISuppressableLog log,
+        public BaselinePackageValidator(ISuppressibleLog log,
             IApiCompatRunner apiCompatRunner)
         {
             _log = log;

diff --git a/...at/Microsoft.DotNet.PackageValidation/Validators/CompatibleFrameworkInPackageValidator.cs b/...at/Microsoft.DotNet.PackageValidation/Validators/CompatibleFrameworkInPackageValidator.cs
@@ -15,10 +15,10 @@ namespace Microsoft.DotNet.PackageValidation.Validators
     /// </summary>
     public class CompatibleFrameworkInPackageValidator : IPackageValidator
     {
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly IApiCompatRunner _apiCompatRunner;
 
-        public CompatibleFrameworkInPackageValidator(ISuppressableLog log,
+        public CompatibleFrameworkInPackageValidator(ISuppressibleLog log,
             IApiCompatRunner apiCompatRunner)
         {
             _log = log;

diff --git a/src/ApiCompat/Microsoft.DotNet.PackageValidation/Validators/CompatibleTFMValidator.cs b/src/ApiCompat/Microsoft.DotNet.PackageValidation/Validators/CompatibleTFMValidator.cs
@@ -15,10 +15,10 @@ namespace Microsoft.DotNet.PackageValidation.Validators
     public class CompatibleTfmValidator : IPackageValidator
     {
         private static readonly Dictionary<NuGetFramework, HashSet<NuGetFramework>> s_packageTfmMapping = InitializeTfmMappings();
-        private readonly ISuppressableLog _log;
+        private readonly ISuppressibleLog _log;
         private readonly IApiCompatRunner _apiCompatRunner;
 
-        public CompatibleTfmValidator(ISuppressableLog log,
+        public CompatibleTfmValidator(ISuppressibleLog log,
             IApiCompatRunner apiCompatRunner)
         {
             _log = log;

diff --git a/...otNet.ApiCompat.IntegrationTests/CompatibleFrameworkInPackageValidatorIntegrationTests.cs b/...otNet.ApiCompat.IntegrationTests/CompatibleFrameworkInPackageValidatorIntegrationTests.cs
@@ -18,9 +18,9 @@ public CompatibleFrameworkInPackageValidatorIntegrationTests(ITestOutputHelper l
         {
         }
 
-        private (SuppressableTestLog, CompatibleFrameworkInPackageValidator) CreateLoggerAndValidator()
+        private (SuppressibleTestLog, CompatibleFrameworkInPackageValidator) CreateLoggerAndValidator()
         {
-            SuppressableTestLog log = new();
+            SuppressibleTestLog log = new();
             CompatibleFrameworkInPackageValidator validator = new(log,
                 new ApiCompatRunner(log,
                     new SuppressionEngine(),
@@ -57,7 +57,7 @@ public void test(string test) { }
             var result = packCommand.Execute();
             Assert.Equal(string.Empty, result.StdErr);
             Package package = Package.Create(packCommand.GetNuGetPackage(), null);
-            (SuppressableTestLog log, CompatibleFrameworkInPackageValidator validator) = CreateLoggerAndValidator();
+            (SuppressibleTestLog log, CompatibleFrameworkInPackageValidator validator) = CreateLoggerAndValidator();
 
             validator.Validate(new PackageValidatorOption(package));
 
@@ -98,7 +98,7 @@ public void test(bool test) { }
             var result = packCommand.Execute();
             Assert.Equal(string.Empty, result.StdErr);
             Package package = Package.Create(packCommand.GetNuGetPackage(), null);
-            (SuppressableTestLog log, CompatibleFrameworkInPackageValidator validator) = CreateLoggerAndValidator();
+            (SuppressibleTestLog log, CompatibleFrameworkInPackageValidator validator) = CreateLoggerAndValidator();
 
             validator.Validate(new PackageValidatorOption(package));
 

diff --git a/...soft.DotNet.ApiCompat.IntegrationTests/Microsoft.DotNet.ApiCompat.IntegrationTests.csproj b/...soft.DotNet.ApiCompat.IntegrationTests/Microsoft.DotNet.ApiCompat.IntegrationTests.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Compile Include="..\Microsoft.DotNet.ApiCompatibility.Tests\SuppressableTestLog.cs" />
+    <Compile Include="..\Microsoft.DotNet.ApiCompatibility.Tests\SuppressibleTestLog.cs" />
   </ItemGroup>
 
   <ItemGroup>
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,8 @@ nupkg @@
     nuspec
     sdk
     sdks
+    tfm
+    tfms
     url
     urls
     xamarin
@@ Expand Down @@