maint: Introduce formatting and analyzers (#36)

* Use dotnet format to lint locally and in CI * Results of running dotnet format * Add code analysis workflow * <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild> and <EnableNETAnalyzers>true</EnableNETAnalyzers> * Give full commit hash instead of v1 for code-analysis action * Install .NET before running code analysis * Rip out unmaintained analysis Action * Do not error on CS0618; error on all other warnings
octokit · Jan 31, 2024 · 24f96a2 · 24f96a2
1 parent 820a5e8
commit 24f96a2
Show file tree

Hide file tree

Showing 12 changed files with 123 additions and 103 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,6 +21,9 @@ jobs:
         with:
           dotnet-version: '8.x.x'
 
+      - name: Format
+        run: dotnet format --verify-no-changes
+
       - name: Build and strong name sign
         run: dotnet build --no-incremental /p:SignAssembly=true /p:AssemblyOriginatorKeyFile=../key.snk
 

diff --git a/Tests/Client/ClientFactoryTest.cs b/Tests/Client/ClientFactoryTest.cs
@@ -1,22 +1,22 @@
-using Xunit;
 using GitHub.Octokit.Client;
+using Xunit;
 
 public class ClientFactoryTests
 {
 
-  [Fact]
-  public void Creates_Client_With_Default_Timeout()
-  {
-    var clientFactory = ClientFactory.Create();
-    Assert.Equal(TimeSpan.FromSeconds(100), clientFactory.Timeout);
-  }
+    [Fact]
+    public void Creates_Client_With_Default_Timeout()
+    {
+        var clientFactory = ClientFactory.Create();
+        Assert.Equal(TimeSpan.FromSeconds(100), clientFactory.Timeout);
+    }
 
-  [Fact]
-  public void Creates_Client_Persists_Set_Timeout()
-  {
-    var clientFactory = ClientFactory.Create();
-    clientFactory.Timeout = TimeSpan.FromSeconds(5);
-    Assert.Equal(TimeSpan.FromSeconds(5), clientFactory.Timeout);
-  }
+    [Fact]
+    public void Creates_Client_Persists_Set_Timeout()
+    {
+        var clientFactory = ClientFactory.Create();
+        clientFactory.Timeout = TimeSpan.FromSeconds(5);
+        Assert.Equal(TimeSpan.FromSeconds(5), clientFactory.Timeout);
+    }
 
-}
+}
diff --git a/Tests/Client/RequestAdaptorTest.cs b/Tests/Client/RequestAdaptorTest.cs
@@ -1,32 +1,32 @@
-using Xunit;
-using GitHub.Octokit.Client;
 using GitHub.Octokit.Authentication;
+using GitHub.Octokit.Client;
 using NSubstitute;
+using Xunit;
 
 public class RequestAdapterTests
 {
 
-  [Fact]
-  public void Creates_RequestAdaptor_With_Defaults()
-  {
-    var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"));
-    Assert.NotNull(requestAdapter);
-  }
+    [Fact]
+    public void Creates_RequestAdaptor_With_Defaults()
+    {
+        var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"));
+        Assert.NotNull(requestAdapter);
+    }
 
-  [Fact]
-  public void Creates_RequestAdaptor_With_GenericHttpClient()
-  {
-    var httpClient = Substitute.For<HttpClient>();
-    var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"), httpClient);
-    Assert.NotNull(requestAdapter);
-  }
+    [Fact]
+    public void Creates_RequestAdaptor_With_GenericHttpClient()
+    {
+        var httpClient = Substitute.For<HttpClient>();
+        var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"), httpClient);
+        Assert.NotNull(requestAdapter);
+    }
 
-  [Fact]
-  public void Creates_RequestAdaptor_With_ClientFactory()
-  {
-    var clientFactory = ClientFactory.Create();
-    var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"), clientFactory);
-    Assert.NotNull(requestAdapter);
-  }
+    [Fact]
+    public void Creates_RequestAdaptor_With_ClientFactory()
+    {
+        var clientFactory = ClientFactory.Create();
+        var requestAdapter = RequestAdapter.Create(new TokenAuthenticationProvider("Octokit.Gen", "JRRTOLKIEN"), clientFactory);
+        Assert.NotNull(requestAdapter);
+    }
 
-}
+}
diff --git a/Tests/Tests.csproj b/Tests/Tests.csproj
@@ -14,6 +14,12 @@
   <PropertyGroup>
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <!-- The below NoWarn is due to Kiota generating code marked as Obsolete.
+      This is expected, but we still want to error on other warnings from analyzers. -->
+    <NoWarn>$(NoWarn);CS0618</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/script/format.sh b/script/format.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+# GitHub Actions performs formatting in .github/workflows/build.yml.
+# This script may be used to update files before pushing to a PR check.
+dotnet format
diff --git a/src/Authentication/TokenAuthenticationProvider.cs b/src/Authentication/TokenAuthenticationProvider.cs
@@ -22,7 +22,7 @@ public class TokenAuthenticationProvider : IAuthenticationProvider
     /// Gets or sets the client identifier.
     /// </summary>
     public string ClientId { get; set; }
-    
+
     /// <summary>
     /// Gets or sets the token.
     /// </summary>

diff --git a/src/Client/ClientFactory.cs b/src/Client/ClientFactory.cs
@@ -10,8 +10,8 @@ namespace GitHub.Octokit.Client;
 /// </summary>
 public static class ClientFactory
 {
-    private static readonly Lazy<List<DelegatingHandler>> s_handlers = 
-        new(() => 
+    private static readonly Lazy<List<DelegatingHandler>> s_handlers =
+        new(() =>
         [
             new APIVersionHandler(),
             new UserAgentHandler(),
@@ -79,7 +79,7 @@ public static HttpClient Create(HttpMessageHandler? finalHandler = null)
     /// <param name="handlers">The collection of <see cref="DelegatingHandler"/> instances to chain.</param>
     /// <returns>The first link in the chain of <see cref="DelegatingHandler"/> instances.</returns>
     public static DelegatingHandler? ChainHandlersCollectionAndGetFirstLink(
-        params DelegatingHandler[] handlers) => 
+        params DelegatingHandler[] handlers) =>
         ChainHandlersCollectionAndGetFirstLink(null, handlers);
 
     /// <summary>

diff --git a/src/Client/RequestAdapter.cs b/src/Client/RequestAdapter.cs
@@ -7,22 +7,22 @@ namespace GitHub.Octokit.Client;
 
 public static class RequestAdapter
 {
-  /// <summary>
-  /// Represents an adapter for making HTTP requests using HttpClient.
-  /// </summary>
-  /// TODO: Implement the missing props and methods
-  public static HttpClientRequestAdapter Create(IAuthenticationProvider authenticationProvider, HttpClient? clientFactory = null)
-  {
-      clientFactory ??= ClientFactory.Create();
+    /// <summary>
+    /// Represents an adapter for making HTTP requests using HttpClient.
+    /// </summary>
+    /// TODO: Implement the missing props and methods
+    public static HttpClientRequestAdapter Create(IAuthenticationProvider authenticationProvider, HttpClient? clientFactory = null)
+    {
+        clientFactory ??= ClientFactory.Create();
 
-      var gitHubRequestAdapter = 
-        new HttpClientRequestAdapter(
-          authenticationProvider,
-          null, // Node Parser
-          null, // Serializer
-          clientFactory, 
-          null);
-      
-      return gitHubRequestAdapter;
-  }
+        var gitHubRequestAdapter =
+          new HttpClientRequestAdapter(
+            authenticationProvider,
+            null, // Node Parser
+            null, // Serializer
+            clientFactory,
+            null);
+
+        return gitHubRequestAdapter;
+    }
 }
diff --git a/src/GitHub.Octokit.SDK.csproj b/src/GitHub.Octokit.SDK.csproj
@@ -1,41 +1,47 @@
-<Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup>
-    <OutputType>Library</OutputType>
-    <TargetFramework>net8.0</TargetFramework>
-    <ImplicitUsings>enable</ImplicitUsings>
-    <Nullable>enable</Nullable>
-    <PackageId>GitHub.Octokit.SDK</PackageId>
-    <Version>0.0.1-alpha</Version>
-    <NuGetVersion>0.0.1-alpha</NuGetVersion>
-    <Title>Octokit</Title>
-    <Description>
-    This is an auto-generated SDK for GitHub's REST API, built on Kiota.
-    </Description>
-    <Authors>GitHub</Authors>
-    <PackageTags>GitHub API Octokit dotnet-core</PackageTags>
-    <RepositoryUrl>https://github.com/octokit/dotnet-sdk</RepositoryUrl>
-		<PackageProjectUrl>https://github.com/octokit/dotnet-sdk</PackageProjectUrl>
-		<PackageIcon>octokit.png</PackageIcon>
-		<PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageReadmeFile>NugetREADME.md</PackageReadmeFile>
-    <Copyright>Copyright (c) GitHub 2023</Copyright>
-  </PropertyGroup>
-
-  <PropertyGroup>
-    <IsTrimmable>true</IsTrimmable>
-    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
-    <EnableSingleFileAnalyzer>true</EnableSingleFileAnalyzer>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <PackageReference Include="Microsoft.Kiota.Abstractions" Version="1.7.2" />
-    <PackageReference Include="Microsoft.Kiota.Http.HttpClientLibrary" Version="1.3.3" />
-    <PackageReference Include="Microsoft.Kiota.Serialization.Form" Version="1.1.1" />
-    <PackageReference Include="Microsoft.Kiota.Serialization.Json" Version="1.1.2" />
-    <PackageReference Include="Microsoft.Kiota.Serialization.Multipart" Version="1.1.1" />
-    <PackageReference Include="Microsoft.Kiota.Serialization.Text" Version="1.1.1" />
-    <PackageReference Include="Microsoft.Kiota.Authentication.Azure" Version="1.1.2" />
-    <None Include="NugetREADME.md" Pack="true" PackagePath="\"/>
-    <None Include="octokit.png" Pack="true" PackagePath="\"/>
-  </ItemGroup>
-</Project>
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Library</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <PackageId>GitHub.Octokit.SDK</PackageId>
+    <Version>0.0.1-alpha</Version>
+    <NuGetVersion>0.0.1-alpha</NuGetVersion>
+    <Title>Octokit</Title>
+    <Description>
+    This is an auto-generated SDK for GitHub's REST API, built on Kiota.
+    </Description>
+    <Authors>GitHub</Authors>
+    <PackageTags>GitHub API Octokit dotnet-core</PackageTags>
+    <RepositoryUrl>https://github.com/octokit/dotnet-sdk</RepositoryUrl>
+		<PackageProjectUrl>https://github.com/octokit/dotnet-sdk</PackageProjectUrl>
+		<PackageIcon>octokit.png</PackageIcon>
+		<PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReadmeFile>NugetREADME.md</PackageReadmeFile>
+    <Copyright>Copyright (c) GitHub 2023</Copyright>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <IsTrimmable>true</IsTrimmable>
+    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
+    <EnableSingleFileAnalyzer>true</EnableSingleFileAnalyzer>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <!-- The below NoWarn is due to Kiota generating code marked as Obsolete.
+      This is expected, but we still want to error on other warnings from analyzers. -->
+    <NoWarn>$(NoWarn);CS0618</NoWarn>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Kiota.Abstractions" Version="1.7.2" />
+    <PackageReference Include="Microsoft.Kiota.Http.HttpClientLibrary" Version="1.3.3" />
+    <PackageReference Include="Microsoft.Kiota.Serialization.Form" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Kiota.Serialization.Json" Version="1.1.2" />
+    <PackageReference Include="Microsoft.Kiota.Serialization.Multipart" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Kiota.Serialization.Text" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Kiota.Authentication.Azure" Version="1.1.2" />
+    <None Include="NugetREADME.md" Pack="true" PackagePath="\"/>
+    <None Include="octokit.png" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+</Project>
diff --git a/src/Middleware/Options/APIVersionOptions.cs b/src/Middleware/Options/APIVersionOptions.cs
@@ -17,4 +17,4 @@ public class APIVersionOptions : IRequestOption
     private static string GetAPIVersion() =>
       //TODO : Get the version from the generator
       "2022-11-28";
-}
+}
diff --git a/src/Middleware/Options/UserAgentOptions.cs b/src/Middleware/Options/UserAgentOptions.cs
@@ -21,4 +21,4 @@ public class UserAgentOptions : IRequestOption
     public string ProductVersion { get; set; } = GetProductVersion();
 
     private static string GetProductVersion() => "0.0.0";
-}
+}
diff --git a/src/Middleware/UserAgentHandler.cs b/src/Middleware/UserAgentHandler.cs
@@ -16,7 +16,7 @@ protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage reques
 
         var userAgentHandlerOption = request.GetRequestOption<UserAgentOptions>() ?? _userAgentOption;
 
-        if(!request.Headers.UserAgent.Any(x => userAgentHandlerOption.ProductName.Equals(x.Product?.Name, StringComparison.OrdinalIgnoreCase)))
+        if (!request.Headers.UserAgent.Any(x => userAgentHandlerOption.ProductName.Equals(x.Product?.Name, StringComparison.OrdinalIgnoreCase)))
         {
             request.Headers.UserAgent.Add(new ProductInfoHeaderValue(userAgentHandlerOption.ProductName, userAgentHandlerOption.ProductVersion));
         }