- Refactor 2 projects into single project

- Use Format-Table as formatter rather than built-in logic
    - Enabling styling via Format-Table's Properties feature
    - Fixing bug where columns were not aligned to right when appropriate
    - Reduce code base to maintain.

Author: emreaydinceren

ConsoleGuiTools.Common.props

@@ -1,6 +1,6 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
-        <VersionPrefix>0.7.7</VersionPrefix>
+        <VersionPrefix>0.8.0</VersionPrefix>
         <VersionSuffix></VersionSuffix>
         <Company>Microsoft</Company>
         <Copyright>© Microsoft Corporation.</Copyright>

src/Microsoft.PowerShell.ConsoleGuiTools/ConsoleGui.cs

@@ -0,0 +1,88 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace Microsoft.PowerShell.ConsoleGuiTools;
+
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Data;
+using System.Linq;
+using System.Management.Automation;
+using Microsoft.PowerShell.ConsoleGuiTools.Models;
+
+/// <summary>
+/// Helper class for formatting objects passed pipeline object into text.
+/// </summary>
+internal static class FormatHelper
+{
+    /// <summary>
+    /// Formats the output of a command as a table with the selected properties of the object in each column. 
+    /// The object type determines the default layout and properties that are displayed in each column. 
+    /// You can use the Property parameter to select the properties that you want to display.
+    /// </summary>
+    /// <param name="inputs">Collection of <see cref="PSObject"/></param>
+    /// <param name="properties">Specifies the object properties that appear in the display and the order in which they appear. 
+    /// Type one or more property names, separated by commas, or use a hash table to display a calculated property.
+    /// Wildcards are permitted.</param>
+    /// <returns><see cref="Table"/> data transfer object that contains header and rows in string.</returns>
+    /// <remarks>
+    /// <c>Format-Table</c> Powershell command is used to format the inputs objects as a table.
+    /// </remarks>
+    internal static Table FormatTable(IReadOnlyList<PSObject> inputs, bool force, object[] properties = null)
+    {
+        if (inputs.Count == 0)
+        {
+            return Table.Empty;
+        }
+
+        using var ps = PowerShell.Create(RunspaceMode.CurrentRunspace);
+        ps.AddCommand("Format-Table");
+        ps.AddParameter("AutoSize");
+
+        if (properties != null)
+        {
+            ps.AddParameter("Property", properties);
+        }   
+        
+        if (force == true)
+        {
+            ps.AddParameter("Force");
+        }
+
+        ps.AddParameter("InputObject", inputs);
+
+        // Format-Table's output objects are internal to Powershell,
+        // we cannot use them here,  so we need to convert it to a string as workaround.
+        ps.AddCommand("Out-String");
+
+        var results = ps.Invoke();
+        var text = results.FirstOrDefault()?.BaseObject.ToString();
+
+        var lines = text.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries)
+            .Where(line => string.IsNullOrEmpty(line) == false).ToList();
+
+        /* 
+         * Format-Table sometimes outputs a label on the top based on input's data type.
+         * We need to detect and skip the label and extract only header and rows.
+         * Strategy is to detect the index of the line under the header with dashes and spaces ('---- -- --- ').
+        */
+
+        static bool isHeaderLine(string text) => text.Contains('-') && text.All(c => c == '-' || c == ' ');
+
+        var headerLineIndex = lines.FindIndex(isHeaderLine);
+
+        if (headerLineIndex == -1)
+        {
+            // unexpected result, return the whole text
+            headerLineIndex = 1;
+        }
+
+        return new Table
+        {
+            Header = lines.Skip(headerLineIndex - 1).FirstOrDefault(),
+            HeaderLine = lines.Skip(headerLineIndex).FirstOrDefault(),
+            Rows = lines.Skip(headerLineIndex + 1)
+        };
+    }
+}

src/Microsoft.PowerShell.ConsoleGuiTools/FormatHelper.cs

@@ -4,80 +4,77 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
+
+using Microsoft.PowerShell.ConsoleGuiTools.Models;
 
 using NStack;
 
 using Terminal.Gui;
 
-namespace OutGridView.Cmdlet
-{
-    internal sealed class GridViewDataSource : IListDataSource
-    {
-        public List<GridViewRow> GridViewRowList { get; set; }
+namespace Microsoft.PowerShell.ConsoleGuiTools;
 
-        public int Count => GridViewRowList.Count;
+internal sealed class GridViewDataSource(IEnumerable<GridViewRow> gridViewRowList) : IListDataSource
+{
+    internal List<GridViewRow> GridViewRowList { get; init; } = gridViewRowList.ToList();
 
-        public GridViewDataSource(List<GridViewRow> itemList)
-        {
-            GridViewRowList = itemList;
-        }
+    public int Count => GridViewRowList.Count;
 
-        public int Length { get; }
+    public int Length { get; }
 
-        public void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start)
-        {
-            container.Move(col, line);
-            RenderUstr(driver, GridViewRowList[item].DisplayString, col, line, width);
-        }
+    public void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start)
+    {
+        container.Move(col, line);
+        RenderUstr(driver, GridViewRowList[item].DisplayString, width);
+    }
 
-        public bool IsMarked(int item) => GridViewRowList[item].IsMarked;
+    public bool IsMarked(int item) => GridViewRowList[item].IsMarked;
 
-        public void SetMark(int item, bool value)
+    public void SetMark(int item, bool value)
+    {
+        var oldValue = GridViewRowList[item].IsMarked;
+        GridViewRowList[item].IsMarked = value;
+        var args = new RowMarkedEventArgs()
         {
-            var oldValue = GridViewRowList[item].IsMarked;
-            GridViewRowList[item].IsMarked = value;
-            var args = new RowMarkedEventArgs()
-            {
-                Row = GridViewRowList[item],
-                OldValue = oldValue
-            };
-            MarkChanged?.Invoke(this, args);
-        }
+            Row = GridViewRowList[item],
+            OldValue = oldValue
+        };
+        MarkChanged?.Invoke(this, args);
+    }
 
-        public sealed class RowMarkedEventArgs : EventArgs
-        {
-            public GridViewRow Row { get; set; }
-            public bool OldValue { get; set; }
+    public sealed class RowMarkedEventArgs : EventArgs
+    {
+        public GridViewRow Row { get; set; }
+        public bool OldValue { get; set; }
 
-        }
+    }
 
-        public event EventHandler<RowMarkedEventArgs> MarkChanged;
+    public event EventHandler<RowMarkedEventArgs> MarkChanged;
 
-        public IList ToList()
+    public IList ToList()
+    {
+        return GridViewRowList;
+    }
+
+    // A slightly adapted method from gui.cs: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461
+    private static void RenderUstr(ConsoleDriver driver, ustring ustr, int width)
+    {
+        int used = 0;
+        int index = 0;
+        while (index < ustr.Length)
         {
-            return GridViewRowList;
+            (var rune, var size) = Utf8.DecodeRune(ustr, index, index - ustr.Length);
+            var count = Rune.ColumnWidth(rune);
+            if (used + count > width) break;
+            driver.AddRune(rune);
+            used += count;
+            index += size;
         }
 
-        // A slightly adapted method from gui.cs: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461
-        private static void RenderUstr(ConsoleDriver driver, ustring ustr, int col, int line, int width)
+        while (used < width)
         {
-            int used = 0;
-            int index = 0;
-            while (index < ustr.Length)
-            {
-                (var rune, var size) = Utf8.DecodeRune(ustr, index, index - ustr.Length);
-                var count = Rune.ColumnWidth(rune);
-                if (used + count > width) break;
-                driver.AddRune(rune);
-                used += count;
-                index += size;
-            }
-
-            while (used < width)
-            {
-                driver.AddRune(' ');
-                used++;
-            }
+            driver.AddRune(' ');
+            used++;
         }
     }
 }

src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDataSource.cs

@@ -2,65 +2,59 @@
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
+using System.Data;
 using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
 
-namespace OutGridView.Cmdlet
+using Microsoft.PowerShell.ConsoleGuiTools.Models;
+
+namespace Microsoft.PowerShell.ConsoleGuiTools;
+
+internal static 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
+    internal static List<GridViewRow> FilterData(List<GridViewRow> listToFilter, string filter)
     {
-        // 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
-        public static List<GridViewRow> FilterData(List<GridViewRow> listToFilter, string filter)
+        var filteredList = new List<GridViewRow>();
+        if (string.IsNullOrEmpty(filter))
         {
-            var filteredList = new List<GridViewRow>();
-            if (string.IsNullOrEmpty(filter))
-            {
-                return listToFilter;
-            }
-
-            filteredList.AddRange(listToFilter.Where(gvr => gvr.IsMarked));
-            filteredList.AddRange(listToFilter.Where(gvr => !gvr.IsMarked && Regex.IsMatch(gvr.DisplayString, filter, RegexOptions.IgnoreCase)));
-
-            return filteredList;
+            return listToFilter;
         }
 
-        public static string GetPaddedString(List<string> strings, int offset, int[] listViewColumnWidths)
-        {
-            var builder = new StringBuilder();
-            if (offset > 0)
-            {
-                builder.Append(string.Empty.PadRight(offset));
-            }
+        filteredList.AddRange(listToFilter.Where(gvr => gvr.IsMarked));
+        filteredList.AddRange(listToFilter.Where(gvr => !gvr.IsMarked && Regex.IsMatch(gvr.DisplayString, filter, RegexOptions.IgnoreCase)));
 
-            for (int i = 0; i < strings.Count; i++)
-            {
-                if (i > 0)
-                {
-                    // Add a space between columns
-                    builder.Append(' ');
-                }
+        return filteredList;
+    }
 
-                // Replace any newlines with encoded newline/linefeed (`n or `r)
-                // Note we can't use Environment.Newline because we don't know that the
-                // Command honors that.
-                strings[i] = strings[i].Replace("\r", "`r");
-                strings[i] = strings[i].Replace("\n", "`n");
+    /// <summary>
+    /// Creates the header and data source for the GridView.
+    /// </summary>
+    /// <param name="listViewOffset"> Dictates where the header should actually start considering
+    /// some offset is needed to factor in the checkboxes
+    /// </param>
+    /// <param name="applicationData"></param>
+    /// <param name="leftMargin">Dictates where the header should actually start considering some offset is needed to factor in the checkboxes</param>
+    /// <returns><see cref="GridViewHeader"/> and <see cref="GridViewDataSource"/> from commandlet inputs.</returns>
+    internal static (GridViewHeader Header, GridViewDataSource DataSource) CreateGridViewInputs(int listViewOffset, int leftMargin, ApplicationData applicationData, object[] properties)
+    {
+        var table = FormatHelper.FormatTable(applicationData.Input, applicationData.Force, properties);
 
-                // If the string won't fit in the column, append an ellipsis.
-                if (strings[i].Length > listViewColumnWidths[i])
-                {
-                    builder.Append(strings[i], 0, listViewColumnWidths[i] - 3);
-                    builder.Append("...");
-                }
-                else
-                {
-                    builder.Append(strings[i].PadRight(listViewColumnWidths[i]));
-                }
-            }
+        var gridViewHeader = new GridViewHeader
+        {
+            HeaderText = string.Concat(new string(' ', listViewOffset), table.Header),
+            HeaderUnderLine = string.Concat(new string(' ', listViewOffset), table.HeaderLine)
+        };
 
-            return builder.ToString();
-        }
+        var gridViewDataSource = new GridViewDataSource(table.Rows.Select((line, index) => new GridViewRow
+        {
+            DisplayString = line,
+            OriginalIndex = index
+        }));
+
+        return (
+            gridViewHeader, 
+            gridViewDataSource);
     }
 }

src/Microsoft.PowerShell.ConsoleGuiTools/GridViewDetails.cs

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
     <Import Project="..\..\ConsoleGuiTools.Common.props" />
     <PropertyGroup>
         <TargetFramework>net6.0</TargetFramework>
@@ -11,6 +11,7 @@
         - Add ';https://api.nuget.org/v3/index.json' to the end of the RestoreSources property group below
         - Uncomment the RestoreSources property group below
         -->
+        <!-- <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> -->
         <!-- <RestoreSources>$(RestoreSources);../../../gui-cs/Terminal.Gui/Terminal.Gui/bin/Debug</RestoreSources> -->
     </PropertyGroup>
 
@@ -20,10 +21,6 @@
         <PackageReference Include="Microsoft.PowerShell.SDK" Version="7.2.23" />
     </ItemGroup>
 
-    <ItemGroup>
-        <ProjectReference Include ="../Microsoft.PowerShell.OutGridView.Models/Microsoft.PowerShell.OutGridView.Models.csproj" />
-    </ItemGroup>
-
     <ItemGroup>
         <None Update="Microsoft.PowerShell.ConsoleGuiTools.psd1" CopyToOutputDirectory="PreserveNewest" />
     </ItemGroup>