Enabled all possible rules; Added linting to snippets;

hiranya911 · hiranya911 · commit 477ecd08fbc0 · 2019-01-21T22:06:42.000-08:00
diff --git a/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseAdmin.IntegrationTests.csproj b/FirebaseAdmin/FirebaseAdmin.IntegrationTests/FirebaseAdmin.IntegrationTests.csproj
@@ -4,7 +4,6 @@
     <TargetFramework>netcoreapp2.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <CodeAnalysisRuleSet>../../stylecop_test.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAdmin.Snippets.csproj b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAdmin.Snippets.csproj
@@ -3,6 +3,8 @@
   <PropertyGroup>
     <TargetFramework>netcoreapp2.0</TargetFramework>
     <IsPackable>false</IsPackable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <CodeAnalysisRuleSet>../../stylecop_test.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
   <ItemGroup>
@@ -11,6 +13,9 @@
 
   <ItemGroup>
     <ProjectReference Include="..\FirebaseAdmin\FirebaseAdmin.csproj" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61">
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
   </ItemGroup>
 
 </Project>
diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAppSnippets.cs b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAppSnippets.cs
@@ -21,9 +21,9 @@
 
 namespace FirebaseAdmin.Snippets
 {
-    class FirebaseAppSnippets
+    internal class FirebaseAppSnippets
     {
-        static void InitSdkWithServiceAccount()
+        internal static void InitSdkWithServiceAccount()
         {
             // [START initialize_sdk_with_service_account]
             FirebaseApp.Create(new AppOptions()
@@ -33,7 +33,7 @@ static void InitSdkWithServiceAccount()
             // [END initialize_sdk_with_service_account]
         }
 
-        static void InitSdkWithApplicationDefault()
+        internal static void InitSdkWithApplicationDefault()
         {
             // [START initialize_sdk_with_application_default]
             FirebaseApp.Create(new AppOptions()
@@ -43,7 +43,7 @@ static void InitSdkWithApplicationDefault()
             // [END initialize_sdk_with_application_default]
         }
 
-        static void InitSdkWithRefreshToken()
+        internal static void InitSdkWithRefreshToken()
         {
             // [START initialize_sdk_with_refresh_token]
             FirebaseApp.Create(new AppOptions()
@@ -53,14 +53,14 @@ static void InitSdkWithRefreshToken()
             // [END initialize_sdk_with_refresh_token]
         }
 
-        static void InitSdkWithDefaultConfig()
+        internal static void InitSdkWithDefaultConfig()
         {
             // [START initialize_sdk_with_default_config]
             FirebaseApp.Create();
             // [END initialize_sdk_with_default_config]
         }
 
-        static void InitDefaultApp()
+        internal static void InitDefaultApp()
         {
             // [START access_services_default]
             // Initialize the default app
@@ -78,7 +78,7 @@ static void InitDefaultApp()
             // [END access_services_default]
         }
 
-        static void InitCustomApp()
+        internal static void InitCustomApp()
         {
             var defaultOptions = new AppOptions()
             {
@@ -107,7 +107,7 @@ static void InitCustomApp()
             // [END access_services_nondefault]
         }
 
-        static void InitWithServiceAccountId()
+        internal static void InitWithServiceAccountId()
         {
             // [START initialize_sdk_with_service_account_id]
             FirebaseApp.Create(new AppOptions()
diff --git a/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs b/FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs
@@ -19,9 +19,9 @@
 
 namespace FirebaseAdmin.Snippets
 {
-    class FirebaseAuthSnippets
+    internal class FirebaseAuthSnippets
     {
-        static async Task CreateCustomTokenAsync()
+        internal static async Task CreateCustomTokenAsync()
         {
             // [START custom_token]
             var uid = "some-uid";
@@ -32,7 +32,7 @@ static async Task CreateCustomTokenAsync()
             Console.WriteLine("Created custom token: {0}", customToken);
         }
 
-        static async Task CreateCustomTokenWithClaimsAsync()
+        internal static async Task CreateCustomTokenWithClaimsAsync()
         {
             // [START custom_token_with_claims]
             var uid = "some-uid";
@@ -48,7 +48,7 @@ static async Task CreateCustomTokenWithClaimsAsync()
             Console.WriteLine("Created custom token: {0}", customToken);
         }
 
-        static async Task VeridyIdTokenAsync(string idToken)
+        internal static async Task VeridyIdTokenAsync(string idToken)
         {
             // [START verify_id_token]
             FirebaseToken decodedToken = await FirebaseAuth.DefaultInstance
diff --git a/FirebaseAdmin/FirebaseAdmin.Tests/FirebaseAdmin.Tests.csproj b/FirebaseAdmin/FirebaseAdmin.Tests/FirebaseAdmin.Tests.csproj
@@ -6,7 +6,6 @@
     <AssemblyOriginatorKeyFile>../../FirebaseAdmin.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <CodeAnalysisRuleSet>../../stylecop_test.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs b/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs
@@ -277,6 +277,9 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(
                 .ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Deletes this <see cref="FirebaseAuth"/> service instance.
+        /// </summary>
         void IFirebaseService.Delete()
         {
             lock (this.authLock)
diff --git a/FirebaseAdmin/FirebaseAdmin/FirebaseAdmin.csproj b/FirebaseAdmin/FirebaseAdmin/FirebaseAdmin.csproj
@@ -30,6 +30,7 @@
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.1-beta.61">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <AdditionalFiles Include="../../stylecop.json" />
   </ItemGroup>
 
 </Project>
diff --git a/FirebaseAdmin/FirebaseAdmin/IFirebaseService.cs b/FirebaseAdmin/FirebaseAdmin/IFirebaseService.cs
@@ -20,6 +20,9 @@ namespace FirebaseAdmin
     /// </summary>
     internal interface IFirebaseService
     {
+        /// <summary>
+        /// Cleans up any state associated with this service making it unsuitable for further use.
+        /// </summary>
         void Delete();
     }
 }
diff --git a/stylecop.json b/stylecop.json
@@ -0,0 +1,8 @@
+{
+    "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
+    "settings": {
+        "documentationRules": {
+            "documentInternalElements": false
+        }
+    }
+}
diff --git a/stylecop.ruleset b/stylecop.ruleset
@@ -6,7 +6,6 @@
   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
     <Rule Id="SA1200" Action="None" /> <!-- Using clauses inside namespaces -->
     <Rule Id="SA1502" Action="None" /> <!-- Single-lined elements -->
-    <Rule Id="SA1600" Action="None" /> <!-- Element should be documented -->
     <Rule Id="SA1633" Action="None" /> <!-- Allow custom file header -->
   </Rules>
 </RuleSet>
diff --git a/stylecop_test.ruleset b/stylecop_test.ruleset
@@ -7,11 +7,14 @@
     <Rule Id="SA1200" Action="None" /> <!-- Using clauses inside namespaces -->
     <Rule Id="SA1402" Action="None" /> <!-- Multiple types in same file -->
     <Rule Id="SA1502" Action="None" /> <!-- Single-lined elements -->
+    <Rule Id="SA1512" Action="None" /> <!-- Whitespace after single-line comment -->
+    <Rule Id="SA1515" Action="None" /> <!-- Whitespace before single-line comment -->
     <Rule Id="CS1591" Action="None" /> <!-- Missing documentation for public type -->
     <Rule Id="SA1600" Action="None" /> <!-- Element should be documented -->
     <Rule Id="SA1611" Action="None" /> <!-- Requires parameter documentation -->
     <Rule Id="SA1615" Action="None" /> <!-- Requires returns documentation -->
     <Rule Id="SA1618" Action="None" /> <!-- Requires type parameter documentation -->
     <Rule Id="SA1633" Action="None" /> <!-- Allow custom file header -->
+    <Rule Id="SA0001" Action="None" /> <!-- Disable XML comment analysis -->
   </Rules>
 </RuleSet>

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@`
`21`	`21`
`22`	`22`	`namespace FirebaseAdmin.Snippets`
`23`	`23`	`{`
`24`		`- class FirebaseAppSnippets`
	`24`	`+ internal class FirebaseAppSnippets`
`25`	`25`	`{`
`26`		`- static void InitSdkWithServiceAccount()`
	`26`	`+ internal static void InitSdkWithServiceAccount()`
`27`	`27`	`{`
`28`	`28`	`// [START initialize_sdk_with_service_account]`
`29`	`29`	`FirebaseApp.Create(new AppOptions()`
`@@ -33,7 +33,7 @@ static void InitSdkWithServiceAccount()`
`33`	`33`	`// [END initialize_sdk_with_service_account]`
`34`	`34`	`}`
`35`	`35`
`36`		`- static void InitSdkWithApplicationDefault()`
	`36`	`+ internal static void InitSdkWithApplicationDefault()`
`37`	`37`	`{`
`38`	`38`	`// [START initialize_sdk_with_application_default]`
`39`	`39`	`FirebaseApp.Create(new AppOptions()`
`@@ -43,7 +43,7 @@ static void InitSdkWithApplicationDefault()`
`43`	`43`	`// [END initialize_sdk_with_application_default]`
`44`	`44`	`}`
`45`	`45`
`46`		`- static void InitSdkWithRefreshToken()`
	`46`	`+ internal static void InitSdkWithRefreshToken()`
`47`	`47`	`{`
`48`	`48`	`// [START initialize_sdk_with_refresh_token]`
`49`	`49`	`FirebaseApp.Create(new AppOptions()`
`@@ -53,14 +53,14 @@ static void InitSdkWithRefreshToken()`
`53`	`53`	`// [END initialize_sdk_with_refresh_token]`
`54`	`54`	`}`
`55`	`55`
`56`		`- static void InitSdkWithDefaultConfig()`
	`56`	`+ internal static void InitSdkWithDefaultConfig()`
`57`	`57`	`{`
`58`	`58`	`// [START initialize_sdk_with_default_config]`
`59`	`59`	`FirebaseApp.Create();`
`60`	`60`	`// [END initialize_sdk_with_default_config]`
`61`	`61`	`}`
`62`	`62`
`63`		`- static void InitDefaultApp()`
	`63`	`+ internal static void InitDefaultApp()`
`64`	`64`	`{`
`65`	`65`	`// [START access_services_default]`
`66`	`66`	`// Initialize the default app`
`@@ -78,7 +78,7 @@ static void InitDefaultApp()`
`78`	`78`	`// [END access_services_default]`
`79`	`79`	`}`
`80`	`80`
`81`		`- static void InitCustomApp()`
	`81`	`+ internal static void InitCustomApp()`
`82`	`82`	`{`
`83`	`83`	`var defaultOptions = new AppOptions()`
`84`	`84`	`{`
`@@ -107,7 +107,7 @@ static void InitCustomApp()`
`107`	`107`	`// [END access_services_nondefault]`
`108`	`108`	`}`
`109`	`109`
`110`		`- static void InitWithServiceAccountId()`
	`110`	`+ internal static void InitWithServiceAccountId()`
`111`	`111`	`{`
`112`	`112`	`// [START initialize_sdk_with_service_account_id]`
`113`	`113`	`FirebaseApp.Create(new AppOptions()`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,9 @@`
`19`	`19`
`20`	`20`	`namespace FirebaseAdmin.Snippets`
`21`	`21`	`{`
`22`		`- class FirebaseAuthSnippets`
	`22`	`+ internal class FirebaseAuthSnippets`
`23`	`23`	`{`
`24`		`- static async Task CreateCustomTokenAsync()`
	`24`	`+ internal static async Task CreateCustomTokenAsync()`
`25`	`25`	`{`
`26`	`26`	`// [START custom_token]`
`27`	`27`	`var uid = "some-uid";`
`@@ -32,7 +32,7 @@ static async Task CreateCustomTokenAsync()`
`32`	`32`	`Console.WriteLine("Created custom token: {0}", customToken);`
`33`	`33`	`}`
`34`	`34`
`35`		`- static async Task CreateCustomTokenWithClaimsAsync()`
	`35`	`+ internal static async Task CreateCustomTokenWithClaimsAsync()`
`36`	`36`	`{`
`37`	`37`	`// [START custom_token_with_claims]`
`38`	`38`	`var uid = "some-uid";`
`@@ -48,7 +48,7 @@ static async Task CreateCustomTokenWithClaimsAsync()`
`48`	`48`	`Console.WriteLine("Created custom token: {0}", customToken);`
`49`	`49`	`}`
`50`	`50`
`51`		`- static async Task VeridyIdTokenAsync(string idToken)`
	`51`	`+ internal static async Task VeridyIdTokenAsync(string idToken)`
`52`	`52`	`{`
`53`	`53`	`// [START verify_id_token]`
`54`	`54`	`FirebaseToken decodedToken = await FirebaseAuth.DefaultInstance`
Original file line number	Diff line number	Diff line change
`@@ -277,6 +277,9 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(`
`277`	`277`	`.ConfigureAwait(false);`
`278`	`278`	`}`
`279`	`279`
	`280`	`+ /// <summary>`
	`281`	`+ /// Deletes this <see cref="FirebaseAuth"/> service instance.`
	`282`	`+ /// </summary>`
`280`	`283`	`void IFirebaseService.Delete()`
`281`	`284`	`{`
`282`	`285`	`lock (this.authLock)`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,9 @@ namespace FirebaseAdmin`
`20`	`20`	`/// </summary>`
`21`	`21`	`internal interface IFirebaseService`
`22`	`22`	`{`
	`23`	`+ /// <summary>`
	`24`	`+ /// Cleans up any state associated with this service making it unsuitable for further use.`
	`25`	`+ /// </summary>`
`23`	`26`	`void Delete();`
`24`	`27`	`}`
`25`	`28`	`}`