Enable, fix, and enforce recommended .NET analyzers

andyleejordan · andyleejordan · commit 9c86505e47e8 · 2023-10-23T14:47:26.000-07:00
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs
@@ -7,13 +7,14 @@
 using System.Linq;
 using System.Reflection;
 using System.Text;
-using NStack;
+
 using OutGridView.Models;
+
 using Terminal.Gui;
 
 namespace OutGridView.Cmdlet
 {
-    internal class ConsoleGui : IDisposable
+    internal sealed class ConsoleGui : IDisposable
     {
         private const string FILTER_LABEL = "Filter";
         // This adjusts the left margin of all controls
@@ -154,7 +155,7 @@ private void ListViewSource_MarkChanged(object s, GridViewDataSource.RowMarkedEv
             _inputSource.GridViewRowList[a.Row.OriginalIndex].IsMarked = a.Row.IsMarked;
         }
 
-        private void Accept()
+        private static void Accept()
         {
             Application.RequestStop();
         }
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs
@@ -4,12 +4,14 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+
 using NStack;
+
 using Terminal.Gui;
 
 namespace OutGridView.Cmdlet
 {
-    internal class GridViewDataSource : IListDataSource
+    internal sealed class GridViewDataSource : IListDataSource
     {
         public List<GridViewRow> GridViewRowList { get; set; }
 
@@ -42,7 +44,7 @@ public void SetMark(int item, bool value)
             MarkChanged?.Invoke(this, args);
         }
 
-        public class RowMarkedEventArgs : EventArgs
+        public sealed class RowMarkedEventArgs : EventArgs
         {
             public GridViewRow Row { get; set; }
             public bool OldValue { get; set; }
@@ -57,7 +59,7 @@ public IList ToList()
         }
 
         // A slightly adapted method from gui.cs: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461
-        private void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width)
+        private static void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width)
         {
             int used = 0;
             int index = 0;
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs
@@ -3,7 +3,7 @@
 
 namespace OutGridView.Cmdlet
 {
-    internal class GridViewDetails
+    internal sealed class GridViewDetails
     {
         // Contains the width of each column in the grid view.
         public int[] ListViewColumnWidths { get; set; }
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewHelpers.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/GridViewHelpers.cs
@@ -1,18 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
-using NStack;
-using OutGridView.Models;
-using Terminal.Gui;
 
 namespace OutGridView.Cmdlet
 {
-    internal class GridViewHelpers
+    internal sealed class GridViewHelpers
     {
         // Add all items already selected plus any that match the filter
         // The selected items should be at the top of the list, in their original order
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj b/src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.csproj
@@ -27,4 +27,10 @@
     <ItemGroup>
         <None Update="Microsoft.PowerShell.ConsoleGuiTools.psd1" CopyToOutputDirectory="PreserveNewest" />
     </ItemGroup>
+
+    <PropertyGroup>
+        <EnableNETAnalyzers>true</EnableNETAnalyzers>
+        <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+        <AnalysisMode>Recommended</AnalysisMode>
+    </PropertyGroup>
 </Project>
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridviewCmdletCommand.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/OutConsoleGridviewCmdletCommand.cs
@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.Management.Automation;
 using System.Management.Automation.Internal;
+
 using OutGridView.Models;
 
 namespace OutGridView.Cmdlet
@@ -180,6 +181,7 @@ protected override void EndProcessing()
         public void Dispose()
         {
             _consoleGui.Dispose();
+            GC.SuppressFinalize(this);
         }
     }
 }
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs
@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.Management.Automation;
 using System.Management.Automation.Internal;
+
 using OutGridView.Models;
 
 namespace OutGridView.Cmdlet
@@ -149,7 +150,7 @@ protected override void EndProcessing()
 
         public void Dispose()
         {
-
+            GC.SuppressFinalize(this);
         }
     }
 }
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs
@@ -2,22 +2,23 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Collections;
 using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Management.Automation;
 using System.Reflection;
+using System.Text.RegularExpressions;
+
+using OutGridView.Models;
+
 using Terminal.Gui;
 using Terminal.Gui.Trees;
-using System.Management.Automation;
-using System.Management.Automation.Internal;
-using System.Linq;
-using System.Diagnostics;
-using System.Collections;
-using OutGridView.Models;
-using System.Text.RegularExpressions;
-using System.IO;
 
 namespace OutGridView.Cmdlet
 {
-    internal class ShowObjectView : Window, ITreeBuilder<object>
+    internal sealed class ShowObjectView : Window, ITreeBuilder<object>
     {
         private readonly TreeView<object> tree;
         private readonly RegexTreeViewTextFilter filter;
@@ -133,7 +134,7 @@ public ShowObjectView(List<object> rootObjects, ApplicationData applicationData)
         }
         private void SetRegexError(string error)
         {
-            if (string.Equals(error, filterErrorLabel.Text.ToString()))
+            if (string.Equals(error, filterErrorLabel.Text.ToString(), StringComparison.Ordinal))
             {
                 return;
             }
@@ -197,7 +198,7 @@ public bool CanExpand(object toExpand)
             return IsBasicType(toExpand);
         }
 
-        private bool IsBasicType(object value)
+        private static bool IsBasicType(object value)
         {
             return value != null && value is not string && !value.GetType().IsValueType;
         }
@@ -245,7 +246,7 @@ public IEnumerable<object> GetChildren(object forObject)
             return children;
         }
 
-        private IEnumerable<object> GetExtraChildren(object forObject)
+        private static IEnumerable<object> GetExtraChildren(object forObject)
         {
             if (forObject is DirectoryInfo dir)
             {
@@ -277,7 +278,7 @@ internal static void Run(List<PSObject> objects, ApplicationData applicationData
             }
         }
 
-        class CachedMemberResultElement
+        sealed class CachedMemberResultElement
         {
             public int Index;
             public object Value;
@@ -304,7 +305,7 @@ public override string ToString()
             }
         }
 
-        class CachedMemberResult
+        sealed class CachedMemberResult
         {
             public MemberInfo Member;
             public object Value;
@@ -402,7 +403,7 @@ public override string ToString()
                 return Member.Name + ": " + representation;
             }
         }
-        private class RegexTreeViewTextFilter : ITreeViewFilter<object>
+        private sealed class RegexTreeViewTextFilter : ITreeViewFilter<object>
         {
             private readonly ShowObjectView parent;
             readonly TreeView<object> _forTree;
diff --git a/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs b/src/Microsoft.PowerShell.ConsoleGuiTools/TypeGetter.cs
@@ -2,14 +2,15 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
 using System.Management.Automation;
 using System.Management.Automation.Internal;
-using System.Linq;
-using System.Globalization;
-using System.Collections.Generic;
+
 using Microsoft.PowerShell.Commands;
+
 using OutGridView.Models;
-using System.Text.RegularExpressions;
 
 namespace OutGridView.Cmdlet
 {
@@ -44,7 +45,7 @@ public FormatViewDefinition GetFormatViewDefinitionForObject(PSObject obj)
             return extendedTypeDefinition.FormatViewDefinition[0];
         }
 
-        public DataTableRow CastObjectToDataTableRow(PSObject ps, List<DataTableColumn> dataColumns, int objectIndex)
+        public static DataTableRow CastObjectToDataTableRow(PSObject ps, List<DataTableColumn> dataColumns, int objectIndex)
         {
             Dictionary<string, IValue> valuePairs = new Dictionary<string, IValue>();
 
@@ -72,7 +73,7 @@ public DataTableRow CastObjectToDataTableRow(PSObject ps, List<DataTableColumn>
             return new DataTableRow(valuePairs, objectIndex);
         }
 
-        private void SetTypesOnDataColumns(List<DataTableRow> dataTableRows, List<DataTableColumn> dataTableColumns)
+        private static void SetTypesOnDataColumns(List<DataTableRow> dataTableRows, List<DataTableColumn> dataTableColumns)
         {
             var dataRows = dataTableRows.Select(x => x.Values);
 
@@ -187,7 +188,7 @@ public DataTable CastObjectsToTableView(List<PSObject> psObjects)
             "System.Security.SecureString",
             "System.Numerics.BigInteger"
         };
-        private bool PSObjectIsPrimitive(PSObject ps)
+        private static bool PSObjectIsPrimitive(PSObject ps)
         {
             var psBaseType = ps.BaseObject.GetType();
 

Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,14 @@`
`7`	`7`	`using System.Linq;`
`8`	`8`	`using System.Reflection;`
`9`	`9`	`using System.Text;`
`10`		`-using NStack;`
	`10`	`+`
`11`	`11`	`using OutGridView.Models;`
	`12`	`+`
`12`	`13`	`using Terminal.Gui;`
`13`	`14`
`14`	`15`	`namespace OutGridView.Cmdlet`
`15`	`16`	`{`
`16`		`- internal class ConsoleGui : IDisposable`
	`17`	`+ internal sealed class ConsoleGui : IDisposable`
`17`	`18`	`{`
`18`	`19`	`private const string FILTER_LABEL = "Filter";`
`19`	`20`	`// This adjusts the left margin of all controls`
`@@ -154,7 +155,7 @@ private void ListViewSource_MarkChanged(object s, GridViewDataSource.RowMarkedEv`
`154`	`155`	`_inputSource.GridViewRowList[a.Row.OriginalIndex].IsMarked = a.Row.IsMarked;`
`155`	`156`	`}`
`156`	`157`
`157`		`- private void Accept()`
	`158`	`+ private static void Accept()`
`158`	`159`	`{`
`159`	`160`	`Application.RequestStop();`
`160`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,14 @@`
`4`	`4`	`using System;`
`5`	`5`	`using System.Collections;`
`6`	`6`	`using System.Collections.Generic;`
	`7`	`+`
`7`	`8`	`using NStack;`
	`9`	`+`
`8`	`10`	`using Terminal.Gui;`
`9`	`11`
`10`	`12`	`namespace OutGridView.Cmdlet`
`11`	`13`	`{`
`12`		`- internal class GridViewDataSource : IListDataSource`
	`14`	`+ internal sealed class GridViewDataSource : IListDataSource`
`13`	`15`	`{`
`14`	`16`	`public List<GridViewRow> GridViewRowList { get; set; }`
`15`	`17`
`@@ -42,7 +44,7 @@ public void SetMark(int item, bool value)`
`42`	`44`	`MarkChanged?.Invoke(this, args);`
`43`	`45`	`}`
`44`	`46`
`45`		`- public class RowMarkedEventArgs : EventArgs`
	`47`	`+ public sealed class RowMarkedEventArgs : EventArgs`
`46`	`48`	`{`
`47`	`49`	`public GridViewRow Row { get; set; }`
`48`	`50`	`public bool OldValue { get; set; }`
`@@ -57,7 +59,7 @@ public IList ToList()`
`57`	`59`	`}`
`58`	`60`
`59`	`61`	`// A slightly adapted method from gui.cs: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461`
`60`		`- private void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width)`
	`62`	`+ private static void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width)`
`61`	`63`	`{`
`62`	`64`	`int used = 0;`
`63`	`65`	`int index = 0;`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace OutGridView.Cmdlet`
`5`	`5`	`{`
`6`		`- internal class GridViewDetails`
	`6`	`+ internal sealed class GridViewDetails`
`7`	`7`	`{`
`8`	`8`	`// Contains the width of each column in the grid view.`
`9`	`9`	`public int[] ListViewColumnWidths { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using System.Collections.Generic;`
`7`	`7`	`using System.Management.Automation;`
`8`	`8`	`using System.Management.Automation.Internal;`
	`9`	`+`
`9`	`10`	`using OutGridView.Models;`
`10`	`11`
`11`	`12`	`namespace OutGridView.Cmdlet`
`@@ -180,6 +181,7 @@ protected override void EndProcessing()`
`180`	`181`	`public void Dispose()`
`181`	`182`	`{`
`182`	`183`	`_consoleGui.Dispose();`
	`184`	`+ GC.SuppressFinalize(this);`
`183`	`185`	`}`
`184`	`186`	`}`
`185`	`187`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,22 +2,23 @@`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`	`4`	`using System;`
	`5`	`+using System.Collections;`
`5`	`6`	`using System.Collections.Generic;`
	`7`	`+using System.Diagnostics;`
	`8`	`+using System.IO;`
	`9`	`+using System.Linq;`
	`10`	`+using System.Management.Automation;`
`6`	`11`	`using System.Reflection;`
	`12`	`+using System.Text.RegularExpressions;`
	`13`	`+`
	`14`	`+using OutGridView.Models;`
	`15`	`+`
`7`	`16`	`using Terminal.Gui;`
`8`	`17`	`using Terminal.Gui.Trees;`
`9`		`-using System.Management.Automation;`
`10`		`-using System.Management.Automation.Internal;`
`11`		`-using System.Linq;`
`12`		`-using System.Diagnostics;`
`13`		`-using System.Collections;`
`14`		`-using OutGridView.Models;`
`15`		`-using System.Text.RegularExpressions;`
`16`		`-using System.IO;`
`17`	`18`
`18`	`19`	`namespace OutGridView.Cmdlet`
`19`	`20`	`{`
`20`		`- internal class ShowObjectView : Window, ITreeBuilder<object>`
	`21`	`+ internal sealed class ShowObjectView : Window, ITreeBuilder<object>`
`21`	`22`	`{`
`22`	`23`	`private readonly TreeView<object> tree;`
`23`	`24`	`private readonly RegexTreeViewTextFilter filter;`
`@@ -133,7 +134,7 @@ public ShowObjectView(List<object> rootObjects, ApplicationData applicationData)`
`133`	`134`	`}`
`134`	`135`	`private void SetRegexError(string error)`
`135`	`136`	`{`
`136`		`- if (string.Equals(error, filterErrorLabel.Text.ToString()))`
	`137`	`+ if (string.Equals(error, filterErrorLabel.Text.ToString(), StringComparison.Ordinal))`
`137`	`138`	`{`
`138`	`139`	`return;`
`139`	`140`	`}`
`@@ -197,7 +198,7 @@ public bool CanExpand(object toExpand)`
`197`	`198`	`return IsBasicType(toExpand);`
`198`	`199`	`}`
`199`	`200`
`200`		`- private bool IsBasicType(object value)`
	`201`	`+ private static bool IsBasicType(object value)`
`201`	`202`	`{`
`202`	`203`	`return value != null && value is not string && !value.GetType().IsValueType;`
`203`	`204`	`}`
`@@ -245,7 +246,7 @@ public IEnumerable<object> GetChildren(object forObject)`
`245`	`246`	`return children;`
`246`	`247`	`}`
`247`	`248`
`248`		`- private IEnumerable<object> GetExtraChildren(object forObject)`
	`249`	`+ private static IEnumerable<object> GetExtraChildren(object forObject)`
`249`	`250`	`{`
`250`	`251`	`if (forObject is DirectoryInfo dir)`
`251`	`252`	`{`
`@@ -277,7 +278,7 @@ internal static void Run(List<PSObject> objects, ApplicationData applicationData`
`277`	`278`	`}`
`278`	`279`	`}`
`279`	`280`
`280`		`- class CachedMemberResultElement`
	`281`	`+ sealed class CachedMemberResultElement`
`281`	`282`	`{`
`282`	`283`	`public int Index;`
`283`	`284`	`public object Value;`
`@@ -304,7 +305,7 @@ public override string ToString()`
`304`	`305`	`}`
`305`	`306`	`}`
`306`	`307`
`307`		`- class CachedMemberResult`
	`308`	`+ sealed class CachedMemberResult`
`308`	`309`	`{`
`309`	`310`	`public MemberInfo Member;`
`310`	`311`	`public object Value;`
`@@ -402,7 +403,7 @@ public override string ToString()`
`402`	`403`	`return Member.Name + ": " + representation;`
`403`	`404`	`}`
`404`	`405`	`}`
`405`		`- private class RegexTreeViewTextFilter : ITreeViewFilter<object>`
	`406`	`+ private sealed class RegexTreeViewTextFilter : ITreeViewFilter<object>`
`406`	`407`	`{`
`407`	`408`	`private readonly ShowObjectView parent;`
`408`	`409`	`readonly TreeView<object> _forTree;`