Addressed cleanupcode/inspectcode issues

Bart Koelman · Bart Koelman · commit 554df4b2d358 · 2021-11-27T05:23:35.000+01:00
diff --git a/Build.ps1 b/Build.ps1
@@ -8,7 +8,8 @@ function CheckLastExitCode {
 
 function RunInspectCode {
     $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
-    dotnet jb inspectcode JsonApiDotNetCore.sln --no-build --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
+    # passing --build instead of --no-build to work around https://youtrack.jetbrains.com/issue/RSRP-487054
+    dotnet jb inspectcode JsonApiDotNetCore.sln --build --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
     CheckLastExitCode
 
     [xml]$xml = Get-Content "$outputPath"
diff --git a/src/JsonApiDotNetCore/Controllers/JsonApiEndpoints.cs b/src/JsonApiDotNetCore/Controllers/JsonApiEndpoints.cs
@@ -1,11 +1,13 @@
 using System;
+using JetBrains.Annotations;
 
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
 namespace JsonApiDotNetCore.Controllers
 {
     // IMPORTANT: An internal copy of this type exists in the SourceGenerators project. Keep these in sync when making changes.
+    [PublicAPI]
     [Flags]
     public enum JsonApiEndpoints
     {
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/ControllerActionResults/ToothbrushesController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/ControllerActionResults/ToothbrushesController.cs
@@ -6,6 +6,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.ControllerActionResults
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class ToothbrushesController
+    {
+    }
+
     partial class ToothbrushesController
     {
         internal const int EmptyActionResultId = 11111111;
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/CustomRoutes/CiviliansController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/CustomRoutes/CiviliansController.cs
@@ -4,6 +4,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.CustomRoutes
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class CiviliansController
+    {
+    }
+
     [ApiController]
     [DisableRoutingConvention]
     [Route("world-civilians")]
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/CustomRoutes/TownsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/CustomRoutes/TownsController.cs
@@ -12,6 +12,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.CustomRoutes
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class TownsController
+    {
+    }
+
     [DisableRoutingConvention]
     [Route("world-api/civilization/popular/towns")]
     partial class TownsController
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/HostingInIIS/PaintingsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/HostingInIIS/PaintingsController.cs
@@ -3,6 +3,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.HostingInIIS
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class PaintingsController
+    {
+    }
+
     [DisableRoutingConvention]
     [Route("custom/path/to/paintings-of-the-world")]
     partial class PaintingsController
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/WebProductsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/WebProductsController.cs
@@ -3,6 +3,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.MultiTenancy
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class WebProductsController
+    {
+    }
+
     [DisableRoutingConvention]
     [Route("{countryCode}/products")]
     partial class WebProductsController
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/WebShopsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy/WebShopsController.cs
@@ -3,6 +3,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.MultiTenancy
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class WebShopsController
+    {
+    }
+
     [DisableRoutingConvention]
     [Route("{countryCode}/shops")]
     partial class WebShopsController
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/RestrictedControllers/PillowsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/RestrictedControllers/PillowsController.cs
@@ -2,6 +2,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.RestrictedControllers
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class PillowsController
+    {
+    }
+
     [DisableQueryString("skipCache")]
     partial class PillowsController
     {
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/RestrictedControllers/SofasController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/RestrictedControllers/SofasController.cs
@@ -3,6 +3,11 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.RestrictedControllers
 {
+    // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028
+    public partial class SofasController
+    {
+    }
+
     [DisableQueryString(JsonApiQueryStringParameters.Sort | JsonApiQueryStringParameters.Page)]
     partial class SofasController
     {
diff --git a/test/SourceGeneratorDebugger/Controllers/ArticlesController.cs b/test/SourceGeneratorDebugger/Controllers/ArticlesController.cs
@@ -1,5 +1,8 @@
+using JetBrains.Annotations;
+
 namespace SourceGeneratorDebugger.Controllers
 {
+    [PublicAPI]
     partial class ArticlesController
     {
         public void ExtraMethod()
diff --git a/test/SourceGeneratorDebugger/Controllers/CustomersController.cs b/test/SourceGeneratorDebugger/Controllers/CustomersController.cs
@@ -1,3 +1,4 @@
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -6,6 +7,7 @@
 
 namespace SourceGeneratorDebugger.Controllers
 {
+    [PublicAPI]
     public sealed class CustomersController : JsonApiController<Customer, long>
     {
         public CustomersController(IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory,
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/ArgumentGuard.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/ArgumentGuard.cs
@@ -1,5 +1,6 @@
-// ReSharper disable CheckNamespace
+using JetBrains.Annotations;
 
+// ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 #pragma warning disable AV1008 // Class should not be static
 
@@ -9,6 +10,7 @@ namespace JsonApiDotNetCore
     /// Represents a stripped-down copy of this type in the JsonApiDotNetCore project. It exists solely to fulfill the dependency needs for successfully
     /// compiling the source-generated controllers in this project.
     /// </summary>
+    [PublicAPI]
     internal static class ArgumentGuard
     {
         public static void NotNullNorEmpty(string? value, string name)
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IAddToRelationshipService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IAddToRelationshipService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/ICreateService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/ICreateService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IDeleteService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IDeleteService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetAllService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetAllService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetByIdService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetByIdService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetRelationshipService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetRelationshipService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetSecondaryService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IGetSecondaryService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IIdentifiable.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IIdentifiable.cs
@@ -16,6 +16,7 @@ public interface IIdentifiable
         string? LocalId { get; set; }
     }
 
+    [PublicAPI]
     public interface IIdentifiable<TId> : IIdentifiable
     {
         TId Id { get; set; }
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IRemoveFromRelationshipService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IRemoveFromRelationshipService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/ISetRelationshipService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/ISetRelationshipService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/JsonApiDotNetCore/IUpdateService.cs b/test/SourceGeneratorDebugger/JsonApiDotNetCore/IUpdateService.cs
@@ -1,6 +1,7 @@
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 
+// ReSharper disable UnusedTypeParameter
 // ReSharper disable CheckNamespace
 #pragma warning disable AV1505 // Namespace should match with assembly name
 
diff --git a/test/SourceGeneratorDebugger/Models/Customer.cs b/test/SourceGeneratorDebugger/Models/Customer.cs
@@ -1,8 +1,10 @@
+using JetBrains.Annotations;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 
 namespace SourceGeneratorDebugger.Models
 {
+    [UsedImplicitly(ImplicitUseTargetFlags.Members)]
     public sealed class Customer : Identifiable<long>
     {
         [Attr]
diff --git a/test/SourceGeneratorDebugger/SourceGeneratorDebugger.csproj b/test/SourceGeneratorDebugger/SourceGeneratorDebugger.csproj
@@ -2,7 +2,10 @@
   <PropertyGroup>
     <TargetFramework>$(NetCoreAppVersion)</TargetFramework>
     <OutputType>Exe</OutputType>
+    <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
+    <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GeneratedFiles</CompilerGeneratedFilesOutputPath>
   </PropertyGroup>
+
   <ItemGroup>
     <Compile Include="..\..\src\JsonApiDotNetCore\Controllers\JsonApiEndpoints.cs" Link="JsonApiDotNetCore\JsonApiEndpoints.cs" />
     <Compile Include="..\..\src\JsonApiDotNetCore\Resources\Annotations\ResourceAttribute.cs" Link="JsonApiDotNetCore\ResourceAttribute.cs" />

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,13 @@`
`1`	`1`	`using System;`
	`2`	`+using JetBrains.Annotations;`
`2`	`3`
`3`	`4`	`// ReSharper disable CheckNamespace`
`4`	`5`	`#pragma warning disable AV1505 // Namespace should match with assembly name`
`5`	`6`
`6`	`7`	`namespace JsonApiDotNetCore.Controllers`
`7`	`8`	`{`
`8`	`9`	`// IMPORTANT: An internal copy of this type exists in the SourceGenerators project. Keep these in sync when making changes.`
	`10`	`+ [PublicAPI]`
`9`	`11`	`[Flags]`
`10`	`12`	`public enum JsonApiEndpoints`
`11`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,11 @@`
`6`	`6`
`7`	`7`	`namespace JsonApiDotNetCoreTests.IntegrationTests.ControllerActionResults`
`8`	`8`	`{`
	`9`	`+ // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028`
	`10`	`+ public partial class ToothbrushesController`
	`11`	`+ {`
	`12`	`+ }`
	`13`	`+`
`9`	`14`	`partial class ToothbrushesController`
`10`	`15`	`{`
`11`	`16`	`internal const int EmptyActionResultId = 11111111;`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,11 @@`
`2`	`2`
`3`	`3`	`namespace JsonApiDotNetCoreTests.IntegrationTests.RestrictedControllers`
`4`	`4`	`{`
	`5`	`+ // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028`
	`6`	`+ public partial class PillowsController`
	`7`	`+ {`
	`8`	`+ }`
	`9`	`+`
`5`	`10`	`[DisableQueryString("skipCache")]`
`6`	`11`	`partial class PillowsController`
`7`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,11 @@`
`3`	`3`
`4`	`4`	`namespace JsonApiDotNetCoreTests.IntegrationTests.RestrictedControllers`
`5`	`5`	`{`
	`6`	`+ // Workaround for https://youtrack.jetbrains.com/issue/RSRP-487028`
	`7`	`+ public partial class SofasController`
	`8`	`+ {`
	`9`	`+ }`
	`10`	`+`
`6`	`11`	`[DisableQueryString(JsonApiQueryStringParameters.Sort \| JsonApiQueryStringParameters.Page)]`
`7`	`12`	`partial class SofasController`
`8`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
	`1`	`+using JetBrains.Annotations;`
	`2`	`+`
`1`	`3`	`namespace SourceGeneratorDebugger.Controllers`
`2`	`4`	`{`
	`5`	`+ [PublicAPI]`
`3`	`6`	`partial class ArticlesController`
`4`	`7`	`{`
`5`	`8`	`public void ExtraMethod()`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using JetBrains.Annotations;`
`1`	`2`	`using JsonApiDotNetCore.Configuration;`
`2`	`3`	`using JsonApiDotNetCore.Controllers;`
`3`	`4`	`using JsonApiDotNetCore.Services;`
`@@ -6,6 +7,7 @@`
`6`	`7`
`7`	`8`	`namespace SourceGeneratorDebugger.Controllers`
`8`	`9`	`{`
	`10`	`+ [PublicAPI]`
`9`	`11`	`public sealed class CustomersController : JsonApiController<Customer, long>`
`10`	`12`	`{`
`11`	`13`	`public CustomersController(IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory,`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public interface IIdentifiable`
`16`	`16`	`string? LocalId { get; set; }`
`17`	`17`	`}`
`18`	`18`
	`19`	`+ [PublicAPI]`
`19`	`20`	`public interface IIdentifiable<TId> : IIdentifiable`
`20`	`21`	`{`
`21`	`22`	`TId Id { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
	`1`	`+using JetBrains.Annotations;`
`1`	`2`	`using JsonApiDotNetCore.Resources;`
`2`	`3`	`using JsonApiDotNetCore.Resources.Annotations;`
`3`	`4`
`4`	`5`	`namespace SourceGeneratorDebugger.Models`
`5`	`6`	`{`
	`7`	`+ [UsedImplicitly(ImplicitUseTargetFlags.Members)]`
`6`	`8`	`public sealed class Customer : Identifiable<long>`
`7`	`9`	`{`
`8`	`10`	`[Attr]`