Is your feature request related to a problem? Please describe
When Sql170ScriptGenerator regenerates a script, a CASE expression is always emitted inline — every
WHEN/THEN/ELSE is joined onto one logical line. For multi-branch CASE expressions this makes the
output substantially harder to read than the input, and where a WHEN predicate has multiple conjuncts
the hanging indent compounds: each AND is indented to the width of the preceding WHEN, and the next
WHEN is then appended after that indented continuation, producing a staircase.
Input (longest line 81 chars):
SELECT CASE
WHEN o.status = 'P' AND o.paid_amount >= o.total_amount THEN 'settled'
WHEN o.status = 'P' AND o.paid_amount > 0 THEN 'part-paid'
WHEN o.status = 'C' THEN 'cancelled'
ELSE 'open'
END AS settlement_state,
CASE WHEN o.due_date < SYSUTCDATETIME() THEN 1 ELSE 0 END AS is_overdue
FROM orders AS o
WHERE o.tenant_id = 42;
Output with MultilineSelectElementsList = true, IndentationSize = 4 (longest line 185 chars):
SELECT CASE WHEN o.status = 'P'
AND o.paid_amount >= o.total_amount THEN 'settled' WHEN o.status = 'P'
AND o.paid_amount > 0 THEN 'part-paid' WHEN o.status = 'C' THEN 'cancelled' ELSE 'open' END AS settlement_state,
CASE WHEN o.due_date < SYSUTCDATETIME() THEN 1 ELSE 0 END AS is_overdue
FROM orders AS o
WHERE o.tenant_id = 42;
An 81-character input becomes a 185-character line. There is currently no option that affects this:
of the 46 properties on SqlScriptGeneratorOptions, none matches Case or When, and none provides a
maximum line width. AlignClauseBodies, ClauseBodyAlignment and the Multiline* options do not reach
inside a CASE.
Describe the solution you'd like
A MultilineCaseExpression option (default false, preserving current output) that places each WHEN
branch and the ELSE on its own line, indented one level from the CASE:
SELECT CASE
WHEN o.status = 'P' AND o.paid_amount >= o.total_amount THEN 'settled'
WHEN o.status = 'P' AND o.paid_amount > 0 THEN 'part-paid'
WHEN o.status = 'C' THEN 'cancelled'
ELSE 'open'
END AS settlement_state,
This fits the existing naming and behaviour of the Multiline* family —
MultilineSelectElementsList, MultilineWherePredicatesList, MultilineInValuesList,
MultilineViewColumnsList, MultilineSetClauseItems, MultilineInsertTargetsList,
MultilineInsertSourcesList, MultilineProcedureParametersList — so it should need no new concepts.
A single-branch CASE staying inline when the option is off (as
CASE WHEN … THEN 1 ELSE 0 END above) seems the right default; whether a one-branch CASE should also
break under the option is a judgement call I have no strong view on.
Describe alternatives you've considered
- Existing options —
AlignClauseBodies, ClauseBodyAlignment = Indented,
MultilineSelectElementsList, and reduced IndentationSize. None affects the interior of a CASE;
the best combination I found did not shorten these lines.
- A general maximum-line-width option. More broadly useful, but a much larger change and a different
model from the current per-construct toggles, so I have not requested it here.
- Post-processing the generated text. Re-wrapping
CASE with a regex outside the generator defeats
the point of using an AST-based formatter and is not reliable in the presence of string literals.
Additional context
Is your feature request related to a problem? Please describe
When
Sql170ScriptGeneratorregenerates a script, aCASEexpression is always emitted inline — everyWHEN/THEN/ELSEis joined onto one logical line. For multi-branchCASEexpressions this makes theoutput substantially harder to read than the input, and where a
WHENpredicate has multiple conjunctsthe hanging indent compounds: each
ANDis indented to the width of the precedingWHEN, and the nextWHENis then appended after that indented continuation, producing a staircase.Input (longest line 81 chars):
Output with
MultilineSelectElementsList = true,IndentationSize = 4(longest line 185 chars):An 81-character input becomes a 185-character line. There is currently no option that affects this:
of the 46 properties on
SqlScriptGeneratorOptions, none matchesCaseorWhen, and none provides amaximum line width.
AlignClauseBodies,ClauseBodyAlignmentand theMultiline*options do not reachinside a
CASE.Describe the solution you'd like
A
MultilineCaseExpressionoption (defaultfalse, preserving current output) that places eachWHENbranch and the
ELSEon its own line, indented one level from theCASE:This fits the existing naming and behaviour of the
Multiline*family —MultilineSelectElementsList,MultilineWherePredicatesList,MultilineInValuesList,MultilineViewColumnsList,MultilineSetClauseItems,MultilineInsertTargetsList,MultilineInsertSourcesList,MultilineProcedureParametersList— so it should need no new concepts.A single-branch
CASEstaying inline when the option is off (asCASE WHEN … THEN 1 ELSE 0 ENDabove) seems the right default; whether a one-branchCASEshould alsobreak under the option is a judgement call I have no strong view on.
Describe alternatives you've considered
AlignClauseBodies,ClauseBodyAlignment = Indented,MultilineSelectElementsList, and reducedIndentationSize. None affects the interior of aCASE;the best combination I found did not shorten these lines.
model from the current per-construct toggles, so I have not requested it here.
CASEwith a regex outside the generator defeatsthe point of using an AST-based formatter and is not reliable in the presence of string literals.
Additional context
Microsoft.SqlServer.TransactSql.ScriptDom180.78.1 (assembly 18.0.0.0),net8.0; behaviour is thesame on
Sql160ScriptGenerator,Sql170ScriptGeneratorandSql180ScriptGenerator.Formatter needs to allow insert columns on separate lines #189 (INSERT columns) and Add options to generator to move stored proc params to separate lines #21 (stored-procedure parameters).