Code modernization and cleanup.

Refactored namespaces to align with `Microsoft.PowerShell` conventions, replacing `OutGridView.Cmdlet` and `OutGridView.Models`. Updated the module version to `0.9.0` to reflect significant changes.

Improved code readability and maintainability by adding XML documentation, enforcing consistent naming conventions, and removing redundant code. Enhanced null safety with nullable annotations and null checks.

Refactored key classes (`ConsoleGui`, `GridViewDataSource`, `GridViewDetails`, `GridViewHelpers`, `OutConsoleGridviewCmdletCommand`, `ShowObjectTreeCmdletCommand`, etc.) to simplify logic, improve error handling, and ensure modern C# practices.

Updated `launchSettings.json` to rename the `SOT` profile to `SHOT` for consistency with the `Show-ObjectTree` cmdlet. Enhanced serialization logic in `Serializers.cs` and improved type handling in `TypeGetter.cs`.

These changes improve the maintainability, safety, and usability of the module while aligning with modern development standards.

Author: tig

GraphicalTools.sln.DotSettings

@@ -1,2 +1,7 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
-	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=236f7aa5_002D7b06_002D43ca_002Dbf2a_002D9b31bfcff09a/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Any" AccessRightKinds="Private" Description="Constant fields (private)"&gt;&lt;ElementKinds&gt;&lt;Kind Name="CONSTANT_FIELD" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" WarnAboutPrefixesAndSuffixes="False" Prefix="" Suffix="" Style="AA_BB" /&gt;&lt;/Policy&gt;</s:String></wpf:ResourceDictionary>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=PS/@EntryIndexedValue">PS</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=15b5b1f1_002D457c_002D4ca6_002Db278_002D5615aedc07d3/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Static" AccessRightKinds="Private" Description="Static readonly fields (private)"&gt;&lt;ElementKinds&gt;&lt;Kind Name="READONLY_FIELD" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" WarnAboutPrefixesAndSuffixes="False" Prefix="" Suffix="" Style="AA_BB" /&gt;&lt;/Policy&gt;</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=236f7aa5_002D7b06_002D43ca_002Dbf2a_002D9b31bfcff09a/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Any" AccessRightKinds="Private" Description="Constant fields (private)"&gt;&lt;ElementKinds&gt;&lt;Kind Name="CONSTANT_FIELD" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" WarnAboutPrefixesAndSuffixes="False" Prefix="" Suffix="" Style="AA_BB" /&gt;&lt;/Policy&gt;</s:String>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=BUGBUG/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=ocgv/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs

@@ -7,14 +7,14 @@
 using System.Linq;
 using System.Reflection;
 using System.Text.RegularExpressions;
-using OutGridView.Models;
+using Microsoft.PowerShell.OutGridView.Models;
 using Terminal.Gui.App;
 using Terminal.Gui.Drawing;
 using Terminal.Gui.Input;
 using Terminal.Gui.ViewBase;
 using Terminal.Gui.Views;
 
-namespace OutGridView.Cmdlet;
+namespace Microsoft.PowerShell.ConsoleGuiTools;
 
 internal sealed class ConsoleGui : IDisposable
 {
@@ -63,7 +63,7 @@ public HashSet<int> Start(ApplicationData applicationData)
         var win = CreateTopLevelWindow();
 
         // Create the headers and calculate column widths based on the DataTable
-        var gridHeaders = _applicationData.DataTable.DataColumns.Select(c => c.Label).ToList();
+        var gridHeaders = _applicationData.DataTable?.DataColumns.Select(c => c.Label).ToList();
 
         // Copy the input DataTable into our master ListView source list; upon exit any items
         // that are IsMarked are returned (if OutputMode is set)
@@ -74,14 +74,14 @@ public HashSet<int> Start(ApplicationData applicationData)
             // Add Filter UI
             AddFilter(win);
             // Add Header UI
-            AddHeaders(win, gridHeaders);
+            AddHeaders(win);
         }
 
         // Add ListView
         AddListView(win);
 
         // Status bar is where our key-bindings are handled
-        AddStatusBar(win, !_applicationData.MinUI);
+        AddStatusBar(win);
 
         // We *always* apply a filter, even if the -Filter parameter is not set or Filtering is not
         // available. The ListView always shows a filtered version of _inputSource even if there is no
@@ -126,7 +126,7 @@ private GridViewDataSource LoadData()
         if (_applicationData == null)
             return new GridViewDataSource(items);
 
-        for (var i = 0; i < _applicationData.DataTable.Data.Count; i++)
+        for (var i = 0; i < _applicationData.DataTable!.Data.Count; i++)
         {
             var dataTableRow = _applicationData.DataTable.Data[i];
             var valueList = new List<string>();
@@ -155,7 +155,7 @@ private void UpdateDisplayStrings(GridViewDataSource? source)
         foreach (var gvr in source.GridViewRowList)
         {
             var valueList = new List<string>();
-            var dataTableRow = _applicationData!.DataTable.Data[gvr.OriginalIndex];
+            var dataTableRow = _applicationData!.DataTable!.Data[gvr.OriginalIndex];
             foreach (var dataTableColumn in _applicationData.DataTable.DataColumns)
             {
                 var dataValue = dataTableRow.Values[dataTableColumn.ToString()].DisplayValue;
@@ -238,7 +238,7 @@ private Window CreateTopLevelWindow()
         return win;
     }
 
-    private void AddStatusBar(Window win, bool visible)
+    private void AddStatusBar(Window win)
     {
         var shortcuts = new List<Shortcut>();
         if (_applicationData!.OutputMode != OutputModeOption.None)
@@ -299,15 +299,16 @@ private void AddStatusBar(Window win, bool visible)
         win.Add(new StatusBar(shortcuts));
     }
 
-    private void CalculateColumnWidths(List<string> gridHeaders)
+    private void CalculateColumnWidths(List<string>? gridHeaders)
     {
+        if (gridHeaders == null) return;
         _gridViewDetails!.ListViewColumnWidths = new int[gridHeaders.Count];
         var listViewColumnWidths = _gridViewDetails.ListViewColumnWidths;
 
         for (var i = 0; i < gridHeaders.Count; i++) listViewColumnWidths[i] = gridHeaders[i].Length;
 
         // calculate the width of each column based on longest string in each column for each row
-        foreach (var row in _applicationData!.DataTable.Data)
+        foreach (var row in _applicationData!.DataTable!.Data)
         {
             var index = 0;
 
@@ -370,19 +371,19 @@ private void AddFilter(Window win)
             Text = string.Empty,
             X = Pos.Right(_filterLabel) + 1,
             Y = Pos.Top(_filterLabel) + 1,
-            Width = Dim.Fill() - _filterLabel.Text!.Length,
+            Width = Dim.Fill() - _filterLabel.Text.Length,
             // This enables the height to go 0, and the view to disappear when there is no error
             Height = Dim.Auto(DimAutoStyle.Text),
             SchemeName = "Error"
         };
 
-        _filterField.TextChanged += (sender, e) =>
+        _filterField.TextChanged += (_, _) =>
         {
             var filterText = _filterField.Text;
             try
             {
                 _filterErrorView.Text = string.Empty;
-                _applicationData!.Filter = filterText!;
+                _applicationData!.Filter = filterText;
                 ApplyFilter();
             }
             catch (Exception ex)
@@ -397,16 +398,10 @@ private void AddFilter(Window win)
         _filterField.CursorPosition = _filterField.Text.Length;
     }
 
-    private void AddHeaders(Window win, List<string> gridHeaders)
+    private void AddHeaders(Window win)
     {
-        _header = new Label
-        {
-            //Text = GridViewHelpers.GetPaddedString(gridHeaders, _gridViewDetails!.ListViewOffset, _gridViewDetails.ListViewColumnWidths),
-        };
-        if (_applicationData!.MinUI)
-            _header.Y = 0;
-        else
-            _header.Y = Pos.Bottom(_filterErrorView!);
+        _header = new Label();
+        _header.Y = _applicationData!.MinUI ? 0 : Pos.Bottom(_filterErrorView!);
         win.Add(_header);
 
         if (!_applicationData.MinUI)

src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs

@@ -5,43 +5,83 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Collections.Specialized;
-using System.Text;
 using Terminal.Gui.App;
-using Terminal.Gui.Drivers;
-using Terminal.Gui.Text;
 using Terminal.Gui.Views;
 
-namespace OutGridView.Cmdlet;
+namespace Microsoft.PowerShell.ConsoleGuiTools;
 
-internal sealed class GridViewDataSource : IListDataSource, IDisposable
+/// <summary>
+///     Provides a data source implementation for the grid view that manages rows and supports marking and rendering.
+/// </summary>
+internal sealed class GridViewDataSource : IListDataSource
 {
+    /// <summary>
+    ///     Gets or sets the list of rows displayed in the grid view.
+    /// </summary>
     public List<GridViewRow> GridViewRowList { get; set; }
 
+    /// <summary>
+    ///     Gets the number of rows in the data source.
+    /// </summary>
     public int Count => GridViewRowList.Count;
-    
+
+    /// <summary>
+    ///     Gets the number of rows in the data source.
+    /// </summary>
     public int Length => GridViewRowList.Count;
-    
+
+    /// <summary>
+    ///     Gets or sets a value indicating whether to suspend raising the <see cref="CollectionChanged" /> event.
+    /// </summary>
     public bool SuspendCollectionChangedEvent { get; set; }
-    
+
+#pragma warning disable CS0067  
+    /// <summary>
+    ///     Occurs when the collection changes.
+    /// </summary>
     public event NotifyCollectionChangedEventHandler? CollectionChanged;
+#pragma warning restore CS0067
 
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="GridViewDataSource" /> class with the specified item list.
+    /// </summary>
+    /// <param name="itemList">The list of grid view rows to display.</param>
     public GridViewDataSource(List<GridViewRow> itemList)
     {
         GridViewRowList = itemList;
     }
 
+    /// <summary>
+    ///     Renders a specific item in the list view at the specified position.
+    /// </summary>
+    /// <param name="listView">The list view to render into.</param>
+    /// <param name="selected">A value indicating whether the item is selected.</param>
+    /// <param name="item">The index of the item to render.</param>
+    /// <param name="col">The column position to start rendering.</param>
+    /// <param name="line">The line position to render on.</param>
+    /// <param name="width">The width available for rendering.</param>
+    /// <param name="start">The starting position within the item's display string.</param>
     public void Render(ListView listView, bool selected, int item, int col, int line, int width, int start = 0)
     {
         listView.Move(col, line);
 
         var driver = Application.Driver;
         var row = GridViewRowList[item];
-        driver!.AddStr(row.DisplayString);
-        
+        driver!.AddStr(row.DisplayString ?? string.Empty);
     }
 
+    /// <summary>
+    ///     Determines whether the specified item is marked.
+    /// </summary>
+    /// <param name="item">The index of the item to check.</param>
+    /// <returns><see langword="true" /> if the item is marked; otherwise, <see langword="false" />.</returns>
     public bool IsMarked(int item) => GridViewRowList[item].IsMarked;
 
+    /// <summary>
+    ///     Sets the marked state of the specified item and raises the <see cref="MarkChanged" /> event.
+    /// </summary>
+    /// <param name="item">The index of the item to mark or unmark.</param>
+    /// <param name="value"><see langword="true" /> to mark the item; <see langword="false" /> to unmark it.</param>
     public void SetMark(int item, bool value)
     {
         var oldValue = GridViewRowList[item].IsMarked;
@@ -54,22 +94,38 @@ public void SetMark(int item, bool value)
         MarkChanged?.Invoke(this, args);
     }
 
+    /// <summary>
+    ///     Provides data for the <see cref="MarkChanged" /> event.
+    /// </summary>
     public sealed class RowMarkedEventArgs : EventArgs
     {
+        /// <summary>
+        ///     Gets or sets the row that was marked or unmarked.
+        /// </summary>
         public required GridViewRow Row { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the previous marked state of the row.
+        /// </summary>
         public bool OldValue { get; set; }
     }
 
+    /// <summary>
+    ///     Occurs when a row's marked state changes.
+    /// </summary>
     public event EventHandler<RowMarkedEventArgs>? MarkChanged;
 
-    public IList ToList()
-    {
-        return GridViewRowList;
-    }
-       
+    /// <summary>
+    ///     Converts the data source to a list.
+    /// </summary>
+    /// <returns>The grid view row list as an <see cref="IList" />.</returns>
+    public IList ToList() => GridViewRowList;
+
+    /// <summary>
+    ///     Releases all resources used by the <see cref="GridViewDataSource" />.
+    /// </summary>
     public void Dispose()
     {
         // No resources to dispose currently
     }
-
-}
+}

src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs

@@ -1,19 +1,26 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-namespace OutGridView.Cmdlet
+namespace Microsoft.PowerShell.ConsoleGuiTools;
+
+/// <summary>
+///     Contains layout and dimension details for rendering the grid view in the console.
+/// </summary>
+internal sealed class GridViewDetails
 {
-    internal sealed class GridViewDetails
-    {
-        // Contains the width of each column in the grid view.
-        public int[] ListViewColumnWidths { get; set; }
+    /// <summary>
+    ///     Gets or sets the width of each column in the grid view.
+    /// </summary>
+    public int[]? ListViewColumnWidths { get; set; }
 
-        // Dictates where the header should actually start considering
-        // some offset is needed to factor in the checkboxes
-        public int ListViewOffset { get; set; }
+    /// <summary>
+    ///     Gets or sets the offset where the header should start, accounting for space needed for checkboxes.
+    /// </summary>
+    public int ListViewOffset { get; set; }
 
-        // The width that is actually useable on the screen after
-        // subtracting space needed for a clean UI (spaces between columns, etc).
-        public int UsableWidth { get; set; }
-    }
-}
+    /// <summary>
+    ///     Gets or sets the usable width available on the screen after subtracting space needed for UI elements such as spaces
+    ///     between columns.
+    /// </summary>
+    public int UsableWidth { get; set; }
+}