Link to suppression

olstakh · olstakh · commit 3c2b37843224 · 2026-04-08T21:08:53.000-07:00
diff --git a/docs/Rules/XIT0001.md b/docs/Rules/XIT0001.md
@@ -45,4 +45,6 @@ public class MyTests
 or remove class-level test case orderer and delegate it to the assembly-level one provided by the MSBuild property `<UseDependencyAwareTestCaseOrderer>true</UseDependencyAwareTestCaseOrderer>` (which is _ON_ by default). Another option is to inherit from `DependencyAwareTestCaseOrderer` which allows overriding the order of tests that don't affect declared topological order (i.e. tests on the same level of dependency)
 
 ## When to suppress
-Not recommended to suppress. Unless you're sure current orderer respects dependencies (i.e. custom implementation that takes into account `DependsOnCollectionsAttribute`)
+Not recommended to suppress. Unless you're sure current orderer respects dependencies (i.e. custom implementation that takes into account `DependsOnCollectionsAttribute`)
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0002.md b/docs/Rules/XIT0002.md
@@ -38,4 +38,6 @@ Set the assembly-level `[TestCaseOrderer]` to `DependencyAwareTestCaseOrderer` m
 or use provided msbuild property `<UseDependencyAwareTestCaseOrderer>true</UseDependencyAwareTestCaseOrderer>`, which is _ON_ by default
 
 ## When to suppress
-Not recommended to suppress. Unless you're sure current orderer respects dependencies (i.e. custom implementation that takes into account `DependsOnCollectionsAttribute`)
+Not recommended to suppress. Unless you're sure current orderer respects dependencies (i.e. custom implementation that takes into account `DependsOnCollectionsAttribute`)
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0003.md b/docs/Rules/XIT0003.md
@@ -35,3 +35,8 @@ Add an assembly-level or class-level `[TestCaseOrderer]`:
 ```
 
 or use the provided MSBuild property `<UseDependencyAwareTestCaseOrderer>true</UseDependencyAwareTestCaseOrderer>`, which is _ON_ by default
+
+## When to suppress
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0004.md b/docs/Rules/XIT0004.md
@@ -35,4 +35,6 @@ public void Test2() { }
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0006.md b/docs/Rules/XIT0006.md
@@ -37,3 +37,5 @@ Add the assembly-level attribute (or set `UseDependencyAwareTestFramework` to `t
 
 ## When to suppress
 When you run all the necessary tests, or you don't care that running only some tests (via `--filter` in CLI or by selecting specific tests in Text Explorer) will not execute their dependencies that were not in the selected set of tests
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0007.md b/docs/Rules/XIT0007.md
@@ -35,4 +35,6 @@ public class MyCustomFramework : DependencyAwareFramework
 Alternatively, if you don't need a custom framework, remove the `[assembly: TestFramework(...)]` attribute and use the provided MSBuild property `<UseDependencyAwareTestFramework>true</UseDependencyAwareTestFramework>` (which is _ON_ by default) or `<UseDependencySkippingFramework>true</UseDependencySkippingFramework>` for the skipping variant.
 
 ## When to suppress
-When you run all the necessary tests, or you don't care that running only some tests (via `--filter` in CLI or by selecting specific tests in Text Explorer) will not execute their dependencies that were not in the selected set of tests
+When you run all the necessary tests, or you don't care that running only some tests (via `--filter` in CLI or by selecting specific tests in Text Explorer) will not execute their dependencies that were not in the selected set of tests
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0008.md b/docs/Rules/XIT0008.md
@@ -51,4 +51,6 @@ A code fix is available that performs this replacement automatically.
 Alternatively, set the MSBuild property `<UseDependencySkippingFramework>true</UseDependencySkippingFramework>` in your project file. This enables `DependencySkippingFramework`, which handles collection-level skipping at the runner level for all test attributes, suppressing this rule entirely.
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0009.md b/docs/Rules/XIT0009.md
@@ -34,4 +34,6 @@ public class MyCollectionDefinition { }
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0010.md b/docs/Rules/XIT0010.md
@@ -31,4 +31,6 @@ public class MyCollectionDefinition { }
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug. With `DisableParallelization = false` - order of collections can't be enforced since they'll be running in parallel anyway, even after ordering.
+Not recommended to suppress, unless you're sure it's a bug. With `DisableParallelization = false` - order of collections can't be enforced since they'll be running in parallel anyway, even after ordering.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0011.md b/docs/Rules/XIT0011.md
@@ -31,4 +31,6 @@ Add an assembly-level `[TestCollectionOrderer]` (or set `UseDependencyAwareTestC
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0012.md b/docs/Rules/XIT0012.md
@@ -33,4 +33,6 @@ Set the assembly-level `[TestCollectionOrderer]` to `DependencyAwareTestCollecti
 or use the provided MSBuild property `<UseDependencyAwareTestCollectionOrderer>true</UseDependencyAwareTestCollectionOrderer>`, which is _ON_ by default
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug. If you have custom `TestCollectionOrderer` implemented - it should extend `DependencyAwareTestCollectionOrderer`, in order to order collections that can be ordered without breaking established dependencies. Otherwise the proper order won't be guaranteed.
+Not recommended to suppress, unless you're sure it's a bug. If you have custom `TestCollectionOrderer` implemented - it should extend `DependencyAwareTestCollectionOrderer`, in order to order collections that can be ordered without breaking established dependencies. Otherwise the proper order won't be guaranteed.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0013.md b/docs/Rules/XIT0013.md
@@ -38,3 +38,5 @@ public class MyCollectionDefinition { }
 
 ## When to suppress
 Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0014.md b/docs/Rules/XIT0014.md
@@ -43,4 +43,6 @@ public class DependencyClass
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0015.md b/docs/Rules/XIT0015.md
@@ -30,4 +30,6 @@ public void Test1() { }
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Rules/XIT0016.md b/docs/Rules/XIT0016.md
@@ -30,4 +30,6 @@ public void Test1() { }
 ```
 
 ## When to suppress
-Not recommended to suppress, unless you're sure it's a bug.
+Not recommended to suppress, unless you're sure it's a bug.
+
+See [How to suppress analyzer warnings](../Suppress-warnings.md) for suppression options.
diff --git a/docs/Suppress-warnings.md b/docs/Suppress-warnings.md
@@ -0,0 +1,44 @@
+# How to suppress analyzer warnings
+
+There are several ways to suppress a diagnostic warning produced by `Xunit.v3.IntegrationTesting` analyzers. The examples below use `XIT0001` as a placeholder — replace it with the actual rule ID you want to suppress.
+
+## Via `.editorconfig`
+
+Add a rule to your `.editorconfig` file to change the severity (or disable) a diagnostic for an entire project or folder:
+
+```ini
+[*.cs]
+dotnet_diagnostic.XIT0001.severity = none
+```
+
+Valid severity values are `none`, `silent`, `suggestion`, `warning`, and `error`.
+
+## Via `SuppressMessageAttribute`
+
+Apply `[SuppressMessage]` to suppress the warning on a specific member or type:
+
+```csharp
+using System.Diagnostics.CodeAnalysis;
+
+[SuppressMessage("Usage", "XIT0001", Justification = "Custom orderer handles dependencies")]
+public class MyTests
+{
+    // ...
+}
+```
+
+This attribute can be applied at the method, class, or assembly level.
+
+## Via `#pragma` directives
+
+Use `#pragma warning disable` / `#pragma warning restore` to suppress a warning for a specific section of code:
+
+```csharp
+#pragma warning disable XIT0001
+[TestCaseOrderer(typeof(MyCustomOrderer))]
+public class MyTests
+{
+    // ...
+}
+#pragma warning restore XIT0001
+```
