Apply StyleCop.Analyzers and fix issues

Some issues are suppressed to fix later.
GitTools · Oct 9, 2016 · 49d61ca · 49d61ca
1 parent e8c31a9
commit 49d61ca
Show file tree

Hide file tree

Showing 39 changed files with 292 additions and 107 deletions.
diff --git a/.gitignore b/.gitignore
@@ -107,7 +107,6 @@ sql
 TestResults
 *.Cache
 ClientBin
-stylecop.*
 ~$*
 *.dbmdl
 Generated_Code #added for RIA/Silverlight projects

diff --git a/src/GitLink/Exceptions/GitLinkException.cs b/src/GitLink/Exceptions/GitLinkException.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="GitLinkException.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using System;

diff --git a/src/GitLink/Extensions/BinaryReaderExtensions.cs b/src/GitLink/Extensions/BinaryReaderExtensions.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="BinaryReaderExtensions.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using System;

diff --git a/src/GitLink/Extensions/PdbExtensions.cs b/src/GitLink/Extensions/PdbExtensions.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="PdbExtensions.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using System;
@@ -39,7 +38,7 @@ public static IReadOnlyDictionary<string, byte[]> GetFilesAndChecksums(this PdbF
         {
             Argument.IsNotNull(() => pdbFile);
 
-            //const int LastInterestingByte = 47;
+            // const int LastInterestingByte = 47;
             const string FileIndicator = "/src/files/";
 
             var values = pdbFile.Info.NameToPdbName.Values;

diff --git a/src/GitLink/Extensions/RepositoryExtensions.cs b/src/GitLink/Extensions/RepositoryExtensions.cs
@@ -1,4 +1,8 @@
-namespace GitLink
+// <copyright file="RepositoryExtensions.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
+// </copyright>
+
+namespace GitLink
 {
     using System;
     using System.Collections.Generic;

diff --git a/src/GitLink/Extensions/StringExtensions.cs b/src/GitLink/Extensions/StringExtensions.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="StringExtensions.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using Catel;

diff --git a/src/GitLink/GitLink.csproj b/src/GitLink/GitLink.csproj
@@ -23,8 +23,9 @@
     <WarningLevel>4</WarningLevel>
     <Prefer32Bit>false</Prefer32Bit>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <DocumentationFile>
-    </DocumentationFile>
+    <DocumentationFile>..\..\bin\Debug\GitLink\GitLink.XML</DocumentationFile>
+    <CodeAnalysisRuleSet>GitLink.ruleset</CodeAnalysisRuleSet>
+    <NoWarn>CS1591</NoWarn>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -35,8 +36,9 @@
     <WarningLevel>4</WarningLevel>
     <Prefer32Bit>false</Prefer32Bit>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <DocumentationFile>
-    </DocumentationFile>
+    <DocumentationFile>..\..\bin\Release\GitLink\GitLink.XML</DocumentationFile>
+    <CodeAnalysisRuleSet>GitLink.ruleset</CodeAnalysisRuleSet>
+    <NoWarn>CS1591</NoWarn>
   </PropertyGroup>
   <PropertyGroup>
     <StartupObject>GitLink.Program</StartupObject>
@@ -88,19 +90,23 @@
     <Compile Include="Providers\VisualStudioTeamServicesProvider.cs" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="GitLink.ruleset" />
     <None Include="pdbstr.exe">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Include="winsdk.redist.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <Content Include="Logo.ico" />
+    <None Include="project.json" />
   </ItemGroup>
   <ItemGroup>
-    <None Include="project.json" />
+    <Content Include="Logo.ico" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Icons\" />
   </ItemGroup>
+  <ItemGroup>
+    <AdditionalFiles Include="stylecop.json" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>
diff --git a/src/GitLink/GitLink.ruleset b/src/GitLink/GitLink.ruleset
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Microsoft Managed Recommended Rules" Description="These rules focus on the most critical problems in your code, including potential security holes, application crashes, and other important logic and design errors. It is recommended to include this rule set in any custom rule set you create for your projects." ToolsVersion="10.0">
+  <Localization ResourceAssembly="Microsoft.VisualStudio.CodeAnalysis.RuleSets.Strings.dll" ResourceBaseName="Microsoft.VisualStudio.CodeAnalysis.RuleSets.Strings.Localized">
+    <Name Resource="MinimumRecommendedRules_Name" />
+    <Description Resource="MinimumRecommendedRules_Description" />
+  </Localization>
+  <Rules AnalyzerId="Microsoft.Analyzers.ManagedCodeAnalysis" RuleNamespace="Microsoft.Rules.Managed">
+    <Rule Id="CA1001" Action="Warning" />
+    <Rule Id="CA1009" Action="Warning" />
+    <Rule Id="CA1016" Action="Warning" />
+    <Rule Id="CA1033" Action="Warning" />
+    <Rule Id="CA1049" Action="Warning" />
+    <Rule Id="CA1060" Action="Warning" />
+    <Rule Id="CA1061" Action="Warning" />
+    <Rule Id="CA1063" Action="Warning" />
+    <Rule Id="CA1065" Action="Warning" />
+    <Rule Id="CA1301" Action="Warning" />
+    <Rule Id="CA1400" Action="Warning" />
+    <Rule Id="CA1401" Action="Warning" />
+    <Rule Id="CA1403" Action="Warning" />
+    <Rule Id="CA1404" Action="Warning" />
+    <Rule Id="CA1405" Action="Warning" />
+    <Rule Id="CA1410" Action="Warning" />
+    <Rule Id="CA1415" Action="Warning" />
+    <Rule Id="CA1821" Action="Warning" />
+    <Rule Id="CA1900" Action="Warning" />
+    <Rule Id="CA1901" Action="Warning" />
+    <Rule Id="CA2002" Action="Warning" />
+    <Rule Id="CA2100" Action="Warning" />
+    <Rule Id="CA2101" Action="Warning" />
+    <Rule Id="CA2108" Action="Warning" />
+    <Rule Id="CA2111" Action="Warning" />
+    <Rule Id="CA2112" Action="Warning" />
+    <Rule Id="CA2114" Action="Warning" />
+    <Rule Id="CA2116" Action="Warning" />
+    <Rule Id="CA2117" Action="Warning" />
+    <Rule Id="CA2122" Action="Warning" />
+    <Rule Id="CA2123" Action="Warning" />
+    <Rule Id="CA2124" Action="Warning" />
+    <Rule Id="CA2126" Action="Warning" />
+    <Rule Id="CA2131" Action="Warning" />
+    <Rule Id="CA2132" Action="Warning" />
+    <Rule Id="CA2133" Action="Warning" />
+    <Rule Id="CA2134" Action="Warning" />
+    <Rule Id="CA2137" Action="Warning" />
+    <Rule Id="CA2138" Action="Warning" />
+    <Rule Id="CA2140" Action="Warning" />
+    <Rule Id="CA2141" Action="Warning" />
+    <Rule Id="CA2146" Action="Warning" />
+    <Rule Id="CA2147" Action="Warning" />
+    <Rule Id="CA2149" Action="Warning" />
+    <Rule Id="CA2200" Action="Warning" />
+    <Rule Id="CA2202" Action="Warning" />
+    <Rule Id="CA2207" Action="Warning" />
+    <Rule Id="CA2212" Action="Warning" />
+    <Rule Id="CA2213" Action="Warning" />
+    <Rule Id="CA2214" Action="Warning" />
+    <Rule Id="CA2216" Action="Warning" />
+    <Rule Id="CA2220" Action="Warning" />
+    <Rule Id="CA2229" Action="Warning" />
+    <Rule Id="CA2231" Action="Warning" />
+    <Rule Id="CA2232" Action="Warning" />
+    <Rule Id="CA2235" Action="Warning" />
+    <Rule Id="CA2236" Action="Warning" />
+    <Rule Id="CA2237" Action="Warning" />
+    <Rule Id="CA2238" Action="Warning" />
+    <Rule Id="CA2240" Action="Warning" />
+    <Rule Id="CA2241" Action="Warning" />
+    <Rule Id="CA2242" Action="Warning" />
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+    <Rule Id="SA1101" Action="Hidden" />
+    <Rule Id="SA1507" Action="Hidden" />
+    <Rule Id="SA1202" Action="Hidden" />
+    <Rule Id="SA1201" Action="Hidden" />
+    <Rule Id="SA1124" Action="Hidden" />
+    <Rule Id="SA1309" Action="Hidden" />
+    <Rule Id="SA1600" Action="Hidden" />
+    <Rule Id="SA1121" Action="Hidden" />
+    <Rule Id="SA1214" Action="Hidden" />
+    <Rule Id="SA1203" Action="Hidden" />
+  </Rules>
+</RuleSet>
diff --git a/src/GitLink/Helpers/PdbStrHelper.cs b/src/GitLink/Helpers/PdbStrHelper.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="PdbStrHelper.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using System.Diagnostics;

diff --git a/src/GitLink/LinkMethod.cs b/src/GitLink/LinkMethod.cs
@@ -1,6 +1,6 @@
 // --------------------------------------------------------------------------------------------------------------------
-// <copyright file="Linker.cs" company="Andrew Arnott">
-//   Copyright (c) 2016 Andrew Arnott. All rights reserved.
+// <copyright file="LinkMethod.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 

diff --git a/src/GitLink/LinkOptions.cs b/src/GitLink/LinkOptions.cs
@@ -1,4 +1,8 @@
-namespace GitLink
+// <copyright file="LinkOptions.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
+// </copyright>
+
+namespace GitLink
 {
     using System;
     using System.Collections.Generic;

diff --git a/src/GitLink/Linker.cs b/src/GitLink/Linker.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
-// <copyright file="Linker.cs" company="Andrew Arnott">
-//   Copyright (c) 2016 Andrew Arnott. All rights reserved.
+// <copyright file="Linker.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink
 {
     using System;

diff --git a/src/GitLink/Logging/OutputLogListener.cs b/src/GitLink/Logging/OutputLogListener.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="OutputLogListener.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink.Logging
 {
     using System;

diff --git a/src/GitLink/Pdb/Crypto.cs b/src/GitLink/Pdb/Crypto.cs
@@ -1,10 +1,9 @@
 // --------------------------------------------------------------------------------------------------------------------
 // <copyright file="Crypto.cs" company="CatenaLogic">
-//   Copyright (c) 2014 - 2014 CatenaLogic. All rights reserved.
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
 // </copyright>
 // --------------------------------------------------------------------------------------------------------------------
 
-
 namespace GitLink.Pdb
 {
     using System;

diff --git a/src/GitLink/Pdb/PdbFile.cs b/src/GitLink/Pdb/PdbFile.cs
@@ -1,4 +1,8 @@
-namespace GitLink.Pdb
+// <copyright file="PdbFile.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
+// </copyright>
+
+namespace GitLink.Pdb
 {
     using System;
     using System.Collections.Generic;
@@ -31,7 +35,7 @@ public PdbFile(string path)
             Argument.IsNotNullOrWhitespace(() => path);
 
             Path = path;
- 
+
             _fs = File.Open(path, FileMode.Open, FileAccess.ReadWrite, FileShare.ReadWrite);
             _br = new BinaryReader(_fs, Encoding.UTF8, true);
             _bw = new BinaryWriter(_fs, Encoding.UTF8, true);
@@ -88,6 +92,7 @@ private void CheckPdbHeader()
         private void ReadPdbHeader()
         {
             // TODO: Create PdbHeader struct
+            //// code here
 
             _pageByteCount = _br.ReadInt32(); // 0x20
             PagesFree = _br.ReadInt32(); // 0x24 TODO not sure meaning
@@ -102,14 +107,20 @@ private void CheckPdb()
             var length = _fs.Length;
             if (length % _pageByteCount != 0)
             {
-                throw Log.ErrorAndCreateException<GitLinkException>("pdb length {0} bytes per page <> 0, {1}, {2}", length, _pageByteCount,
+                throw Log.ErrorAndCreateException<GitLinkException>(
+                    "pdb length {0} bytes per page <> 0, {1}, {2}",
+                    length,
+                    _pageByteCount,
                     PageCount);
             }
 
             if (length / _pageByteCount != PageCount)
             {
-                throw Log.ErrorAndCreateException<GitLinkException>("pdb length does not match page count, length: {0}, bytes per page: {1}, page count: {2}",
-                        length, _pageByteCount, PageCount);
+                throw Log.ErrorAndCreateException<GitLinkException>(
+                    "pdb length does not match page count, length: {0}, bytes per page: {1}, page count: {2}",
+                    length,
+                    _pageByteCount,
+                    PageCount);
             }
         }
 
@@ -215,7 +226,7 @@ private byte[] ReadStreamBytes(PdbStream stream)
                 }
 
                 var j = pages.Length - 1;
-                ReadPage(bytes, pages[j], j * _pageByteCount, (stream.ByteCount - j * _pageByteCount));
+                ReadPage(bytes, pages[j], j * _pageByteCount, stream.ByteCount - (j * _pageByteCount));
             }
 
             return bytes;
@@ -240,7 +251,8 @@ private PdbInfo InternalInfo()
             var root = GetRoot();
             if (root.Streams.Count <= 1)
             {
-                throw Log.ErrorAndCreateException<GitLinkException>("Expected at least 2 streams inside the pdb root, but only found '{0}', cannot read pdb info",
+                throw Log.ErrorAndCreateException<GitLinkException>(
+                    "Expected at least 2 streams inside the pdb root, but only found '{0}', cannot read pdb info",
                     root.Streams.Count);
             }
 
@@ -295,7 +307,7 @@ private PdbInfo InternalInfo()
                     }
 
                     var tailByteCount = GetRoot().Streams[1].ByteCount - br.BaseStream.Position;
-                    info.Tail = br.ReadBytes((int) tailByteCount);
+                    info.Tail = br.ReadBytes((int)tailByteCount);
 
                     foreach (var tuple in positions)
                     {