Skip to content

Implement formatting option to align SELECT fields after DISTINCT/TOP #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Implement formatting option to align SELECT fields after DISTINCT/TOP #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bce2e68
Add select alignment formatting option
alex-bochkov Nov 22, 2025
1208dca
Adjust select field indentation after DISTINCT/TOP
alex-bochkov Nov 24, 2025
27a639e
Refine DISTINCT/TOP select indentation
alex-bochkov Nov 24, 2025
2c9e07b
Normalize select field spacing
alex-bochkov Nov 24, 2025
c530bbf
Improve SELECT alignment whitespace normalization
alex-bochkov Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AxialSqlTools/Commands/FormatQueryDialog/FormatOptionsDialog.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@
Content="Break sproc definition parameters per line"
Checked="formatSetting_Checked"
Unchecked="formatSetting_Unchecked"/>
<CheckBox x:Name="BreakSelectFieldsAfterTopAndUnindent" Margin="5"
Content="Break SELECT fields after DISTINCT/TOP"
Checked="formatSetting_Checked"
Unchecked="formatSetting_Unchecked"/>
</UniformGrid>

<StackPanel DockPanel.Dock="Bottom" Orientation="Horizontal"
Expand Down
3 changes: 3 additions & 0 deletions AxialSqlTools/Commands/FormatQueryDialog/FormatOptionsDialog.xaml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ private void ApplySettingsToUi()
UnindentBeginEndBlocks.IsChecked = Settings.unindentBeginEndBlocks;
BreakVariableDefinitionsPerLine.IsChecked = Settings.breakVariableDefinitionsPerLine;
BreakSprocDefinitionParametersPerLine.IsChecked = Settings.breakSprocDefinitionParametersPerLine;
BreakSelectFieldsAfterTopAndUnindent.IsChecked = Settings.breakSelectFieldsAfterTopAndUnindent;
}

private void formatSetting_Checked(object sender, RoutedEventArgs e)
Expand All @@ -51,6 +52,7 @@ private void SetAllFormatOptions(bool value)
UnindentBeginEndBlocks.IsChecked = value;
BreakVariableDefinitionsPerLine.IsChecked = value;
BreakSprocDefinitionParametersPerLine.IsChecked = value;
BreakSelectFieldsAfterTopAndUnindent.IsChecked = value;
}

private void CheckAllOptions_Click(object sender, RoutedEventArgs e)
Expand All @@ -76,6 +78,7 @@ private void SyncFromUi()
Settings.unindentBeginEndBlocks = UnindentBeginEndBlocks.IsChecked == true;
Settings.breakVariableDefinitionsPerLine = BreakVariableDefinitionsPerLine.IsChecked == true;
Settings.breakSprocDefinitionParametersPerLine = BreakSprocDefinitionParametersPerLine.IsChecked == true;
Settings.breakSelectFieldsAfterTopAndUnindent = BreakSelectFieldsAfterTopAndUnindent.IsChecked == true;
}

private void Ok_Click(object sender, RoutedEventArgs e)
Expand Down
177 changes: 140 additions & 37 deletions AxialSqlTools/Modules/TsqlFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class OwnVisitor : TSqlFragmentVisitor
public List<CreateProcedureStatement> SprocDefinitionsCreate = new List<CreateProcedureStatement>();
public List<AlterProcedureStatement> SprocDefinitionsAlter = new List<AlterProcedureStatement>();
public List<CreateOrAlterProcedureStatement> SprocDefinitionsCreateAlter = new List<CreateOrAlterProcedureStatement>();
public List<QuerySpecification> SelectsWithTop = new List<QuerySpecification>();
public List<QuerySpecification> SelectsWithTopOrDistinct = new List<QuerySpecification>();

public override void ExplicitVisit(QualifiedJoin node)
{
Expand Down Expand Up @@ -197,8 +197,8 @@ public override void ExplicitVisit(DeclareVariableStatement node)
public override void ExplicitVisit(QuerySpecification node)
{
base.ExplicitVisit(node);
if (node.TopRowFilter != null)
SelectsWithTop.Add(node);
if (node.TopRowFilter != null || node.UniqueRowFilter == UniqueRowFilter.Distinct)
SelectsWithTopOrDistinct.Add(node);
}
}

Expand Down Expand Up @@ -836,43 +836,146 @@ void SplitParams(IList<ProcedureParameter> parameters)

}

// special case #11 - split SELECT fields after TOP, fixed indent up to FROM
// TODO - can't get this right, so disabled for now
// special case #11 - split SELECT fields after DISTINCT/TOP, fixed indent up to FROM
if (formatSettings.breakSelectFieldsAfterTopAndUnindent)
{
//var tokens = sqlFragment.ScriptTokenStream;
//const string indent = "\t";
var tokens = sqlFragment.ScriptTokenStream;
// Keep field indentation predictable: always one indent level past the SELECT line.
// Prefer tabs when the surrounding block already uses tabs; otherwise fall back to 4 spaces.
string indentAfterSelect = "\t";

//foreach (var qs in visitor.SelectsWithTop)
//{
// // 1) break right after TOP(...) into "\r\n\t"
// int splitIdx = qs.TopRowFilter.LastTokenIndex + 1;
// if (splitIdx < tokens.Count
// && tokens[splitIdx].TokenType == TSqlTokenType.WhiteSpace)
// {
// tokens[splitIdx].Text = "\r\n" + indent;
// }

// //// 2) for every select‐element after the first, break before it into "\r\n\t"
// //for (int i = 1; i < qs.SelectElements.Count; i++)
// //{
// // var elem = qs.SelectElements[i];
// // int wsIdx = elem.FirstTokenIndex - 1;
// // if (wsIdx >= 0
// // && tokens[wsIdx].TokenType == TSqlTokenType.WhiteSpace)
// // {
// // tokens[wsIdx].Text = "\r\n" + indent;
// // }
// //}

// //// 3) unindent FROM back to column 1
// //int wsBeforeFrom = qs.FromClause.FirstTokenIndex - 1;
// //if (wsBeforeFrom >= 0
// // && tokens[wsBeforeFrom].TokenType == TSqlTokenType.WhiteSpace)
// //{
// // tokens[wsBeforeFrom].Text = "\r\n";
// //}
//}
string ExtractLineIndent(string whitespace)
{
int lastNl = whitespace.LastIndexOf("\r\n");
return lastNl >= 0 ? whitespace.Substring(lastNl + 2) : whitespace;
}

void ReduceInnerIndent(int startIdx, int endIdx, string indentUnit, int times)
{
if (times <= 0 || string.IsNullOrEmpty(indentUnit))
return;

for (int i = startIdx; i <= endIdx && i < tokens.Count; i++)
{
if (tokens[i].TokenType != TSqlTokenType.WhiteSpace)
continue;

string ws = tokens[i].Text;
for (int n = 0; n < times; n++)
{
ws = RemoveOneIndent(ws, indentUnit);
}
tokens[i].Text = ws;
}
}

string SingleLineIndent(string indent)
{
// collapse any accidental blank lines and keep a single newline + indent
return "\r\n" + (indent ?? string.Empty);
}

string CollapseBlankLines(string ws)
{
if (string.IsNullOrEmpty(ws))
return ws;

var lines = ws.Split(new[] { "\r\n" }, StringSplitOptions.None);
List<string> compact = new List<string>();
bool previousBlank = false;

foreach (var line in lines)
{
bool isBlank = string.IsNullOrWhiteSpace(line);

if (isBlank)
{
if (previousBlank)
continue;

compact.Add(string.Empty);
}
else
{
compact.Add(line);
}

previousBlank = isBlank;
}

return string.Join("\r\n", compact);
}

void CollapseRangeWhitespace(int startIdx, int endIdx)
{
for (int i = startIdx; i <= endIdx && i < tokens.Count; i++)
{
if (i < 0)
continue;

if (tokens[i].TokenType == TSqlTokenType.WhiteSpace)
{
tokens[i].Text = CollapseBlankLines(tokens[i].Text);
}
}
}

foreach (var qs in visitor.SelectsWithTopOrDistinct)
{
if (qs.SelectElements == null || qs.SelectElements.Count == 0)
continue;

int normalizeStart = Math.Max(0, qs.SelectElements[0].FirstTokenIndex - 1);
int normalizeEnd = qs.FromClause?.FirstTokenIndex - 1 ?? qs.LastTokenIndex;
CollapseRangeWhitespace(normalizeStart, normalizeEnd);

string baseIndent = "";
int wsBeforeSelect = qs.FirstTokenIndex - 1;
if (wsBeforeSelect >= 0 && tokens[wsBeforeSelect].TokenType == TSqlTokenType.WhiteSpace)
{
baseIndent = ExtractLineIndent(tokens[wsBeforeSelect].Text);
}

string indentUnit = baseIndent.Contains("\t") ? indentAfterSelect : new string(' ', 4);
string fieldIndent = baseIndent + indentUnit;

void ReplaceWhitespaceWithIndent(int idx, string indent)
{
if (idx >= 0
&& idx < tokens.Count
&& tokens[idx].TokenType == TSqlTokenType.WhiteSpace)
{
string original = tokens[idx].Text;
string originalIndent = ExtractLineIndent(original);
tokens[idx].Text = SingleLineIndent(indent);

// If we are pulling the element to the left, keep nested structure
// aligned by reducing inner whitespace by the same indent units.
if (originalIndent.Length > indent.Length)
{
int diff = originalIndent.Length - indent.Length;
int unitSize = Math.Max(1, indentUnit.Length);
int times = diff / unitSize;
ReduceInnerIndent(idx + 1, qs.FromClause?.FirstTokenIndex - 1 ?? qs.LastTokenIndex, indentUnit, times);
}
}
}

int firstFieldWs = qs.SelectElements[0].FirstTokenIndex - 1;
ReplaceWhitespaceWithIndent(firstFieldWs, fieldIndent);

for (int i = 1; i < qs.SelectElements.Count; i++)
{
int wsIdx = qs.SelectElements[i].FirstTokenIndex - 1;
ReplaceWhitespaceWithIndent(wsIdx, fieldIndent);
}

if (qs.FromClause != null)
{
int wsBeforeFrom = qs.FromClause.FirstTokenIndex - 1;
ReplaceWhitespaceWithIndent(wsBeforeFrom, baseIndent);
}
}
}

// return full recompiled result
Expand Down
5 changes: 2 additions & 3 deletions AxialSqlTools/WindowSettings/SettingsWindowControl.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,9 +363,8 @@
Content="Break sproc definition parameters per line"
Checked="formatSetting_Checked"
Unchecked="formatSetting_Unchecked"/>
<!-- TODO -->
<CheckBox x:Name="BreakSelectFieldsAfterTopAndUnindent" Margin="5" Visibility="Hidden"
Content="Break SELECT fields after TOP and unindent"
<CheckBox x:Name="BreakSelectFieldsAfterTopAndUnindent" Margin="5"
Content="Break SELECT fields after DISTINCT/TOP"
Checked="formatSetting_Checked"
Unchecked="formatSetting_Unchecked"/>

Expand Down
8 changes: 4 additions & 4 deletions AxialSqlTools/WindowSettings/SettingsWindowControl.xaml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ private void LoadSavedSettings()
BreakSprocParametersPerLine.IsChecked = tsqlCodeFormatSettings.breakSprocParametersPerLine;
UppercaseBuiltInFunctions.IsChecked = tsqlCodeFormatSettings.uppercaseBuiltInFunctions;
UnindentBeginEndBlocks.IsChecked = tsqlCodeFormatSettings.unindentBeginEndBlocks;
BreakVariableDefinitionsPerLine.IsChecked = tsqlCodeFormatSettings.breakVariableDefinitionsPerLine;
BreakVariableDefinitionsPerLine.IsChecked = tsqlCodeFormatSettings.breakVariableDefinitionsPerLine;
BreakSprocDefinitionParametersPerLine.IsChecked = tsqlCodeFormatSettings.breakSprocDefinitionParametersPerLine;
// BreakSelectFieldsAfterTopAndUnindent.IsChecked = tsqlCodeFormatSettings.breakSelectFieldsAfterTopAndUnindent;
BreakSelectFieldsAfterTopAndUnindent.IsChecked = tsqlCodeFormatSettings.breakSelectFieldsAfterTopAndUnindent;

OpenAiApiKey.Password = SettingsManager.GetOpenAiApiKey();

Expand Down Expand Up @@ -327,7 +327,7 @@ private void Button_SaveApplyAdditionalFormat_Click(object sender, RoutedEventAr
unindentBeginEndBlocks = UnindentBeginEndBlocks.IsChecked.GetValueOrDefault(false),
breakVariableDefinitionsPerLine = BreakVariableDefinitionsPerLine.IsChecked.GetValueOrDefault(false),
breakSprocDefinitionParametersPerLine = BreakSprocDefinitionParametersPerLine.IsChecked.GetValueOrDefault(false),
// breakSelectFieldsAfterTopAndUnindent = BreakSelectFieldsAfterTopAndUnindent.IsChecked.GetValueOrDefault(false)
breakSelectFieldsAfterTopAndUnindent = BreakSelectFieldsAfterTopAndUnindent.IsChecked.GetValueOrDefault(false)
};

SettingsManager.SaveTSqlCodeFormatSettings(settings);
Expand Down Expand Up @@ -515,7 +515,7 @@ private void formatTSqlExample()
unindentBeginEndBlocks = UnindentBeginEndBlocks.IsChecked.GetValueOrDefault(false),
breakVariableDefinitionsPerLine = BreakVariableDefinitionsPerLine.IsChecked.GetValueOrDefault(false),
breakSprocDefinitionParametersPerLine = BreakSprocDefinitionParametersPerLine.IsChecked.GetValueOrDefault(false),
// breakSelectFieldsAfterTopAndUnindent = BreakSelectFieldsAfterTopAndUnindent.IsChecked.GetValueOrDefault(false)
breakSelectFieldsAfterTopAndUnindent = BreakSelectFieldsAfterTopAndUnindent.IsChecked.GetValueOrDefault(false)
};

FormattedQueryPreview.Text = TSqlFormatter.FormatCode(SourceQueryPreview.Text, settings);
Expand Down