Sort List command - change so it honors the SSMS Comma Placement setting

[jcouture100]

The Built-in SQL Formatter options has the settings: Comma Placement, Indentation Mode, and Indentation Size.

The new "Sort List Ascending (+Shift: Vertical)" and "Sort List Descending (+Shift: Vertical)" commands always places the comma after the field name or value.

Can we fix the "Sort List Ascending (+Shift: Vertical)" and "Sort List Descending (+Shift: Vertical)" commands so that they honor the selected comma placement setting?

John

[jcouture100]

I've put together some code that implements this, with the exception of getting the SsmsFormatterSettings. It keeps hanging on me when I make the call, so I just commented it out and return the defaults. That's why I posted about debugging the code. If any of you are willing to chat, just give me a call sometime.

Example Code:

private static SsmsFormatterSettingsSnapshot ssmsFormatterSettings = null;

 internal static string Sort(string text, bool descending, bool vertical)
{
    if (string.IsNullOrWhiteSpace(text) || text.IndexOf(',') < 0) return text;

    if (ssmsFormatterSettings == null) 
    { 
        GetSettings(); // Retrieve the SSMS formatter settings snapshot if it hasn't been retrieved yet.
    }  

    bool leadingCommas = GetLeadingCommas();  // This method retrieves the leading commas setting from SSMS formatter settings.
    char indentChar = GetIndentCharacter();   // This method retrieves the indent character (space or tab) from SSMS formatter settings.
    int indentLength = GetIndentSize(indentChar);  // This method retrieves the indent size (number of spaces or tabs) from SSMS formatter settings.
    string indentPad = new string(indentChar, indentLength); // Create a string of the indent character repeated indentLength times.

    var items = SplitItems(text);
    if (items.Length < 2) return text;
    var numbers = items.Select(NumericKey.Parse).ToArray();
    bool numeric = numbers.All(number => number != null);
    var comparer = Comparer<int>.Create((a, b) => numeric
        ? numbers[a].CompareTo(numbers[b])
        : StringComparer.OrdinalIgnoreCase.Compare(items[a], items[b]));
    var indexes = Enumerable.Range(0, items.Length);
    var ordered = descending ? indexes.OrderByDescending(i => i, comparer) : indexes.OrderBy(i => i, comparer);

    string result = leadingCommas
        ? string.Join(vertical ? Environment.NewLine + $"{indentPad}, " : ", ", ordered.Select(i => items[i]))
        : string.Join(vertical ? "," + Environment.NewLine : ", ", ordered.Select(i => items[i]));

    return result;
}

///<summary>Retrieve the SSMS formatter settings snapshot.</summary>
private static void GetSettings()
{
    try
    {
        //TODO: Remove this line when the SSMS formatter settings snapshot retrieval is implemented.
        return; 
        //CancellationTokenSource lifetime = new CancellationTokenSource();
        //var token = lifetime.Token;
        //var settings = SsmsFormatterHost.ReadSettingsAsync(token).Result;
        //ssmsFormatterSettings = settings;
    }
    catch (Exception)
    {
        ssmsFormatterSettings = null;
    }
}

///<summary>Retrieve the indent character based on SSMS formatter settings.</summary>
private static char GetIndentCharacter()
{
    char result = ' '; // default indent character
    try
    {
        if (ssmsFormatterSettings == null) { return result; }
        string indentModeValue = ssmsFormatterSettings.Settings.FirstOrDefault(x => x.Name == "IndentationMode")?.Value;
        result = indentModeValue == "Tabs" ? '\t' : ' ';
    }
    catch (Exception)
    {
        result = ' ';
    }
    return result;
}

///<summary>Retrieve the indent size based on SSMS formatter settings.</summary>
///<remarks>The indent size is only used when the indent character is a space.</remarks>
private static int GetIndentSize(char indentChar)
{
    int result = 4; // default indent size
    try
    {
        if (ssmsFormatterSettings == null) { return result; }
        if (indentChar == '\t')
        { 
            result = 1; 
        }
        else
        {
            string indentSizeValue = ssmsFormatterSettings.Settings.FirstOrDefault(x => x.Name == "IndentationSize")?.Value;
            result = int.TryParse(indentSizeValue, out int size) ? size : 4;
        }
    }
    catch (Exception)
    {
        result = 4;
    }
    return result;
}

///<summary>Retrieve whether to use leading commas based on SSMS formatter settings.</summary>
private static bool GetLeadingCommas()
{
    bool result = true;    // default to leading commas
    try
    {
        if (ssmsFormatterSettings == null) { return result; }
        string commaPlacementValue = ssmsFormatterSettings.Settings.FirstOrDefault(x => x.Name == "CommaPlacement")?.Value;
        result = commaPlacementValue != null && commaPlacementValue.Equals("Leading", StringComparison.OrdinalIgnoreCase);
    }
    catch
    {
        result = false;
    }
    return result;
}