Add a Multiline option for CASE expressions (WHEN/THEN/ELSE on their own lines)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 56/100
Línea de trabajo
Comienza leyendo SqlScriptGeneratorOptions y el comportamiento de Sql170ScriptGenerator para las opciones Multiline* existentes; después, compara cómo se emiten las expresiones CASE. Sigue las pruebas relevantes del generador, si existen, y verifica que el comportamiento predeterminado conserve la salida en línea, mientras que MultilineCaseExpression coloca las ramas WHEN y ELSE en líneas separadas con sangría.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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 reducedIndentationSize. None affects the interior of aCASE;
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
CASEwith 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
Microsoft.SqlServer.TransactSql.ScriptDom180.78.1 (assembly 18.0.0.0),net8.0; behaviour is the
same onSql160ScriptGenerator,Sql170ScriptGeneratorandSql180ScriptGenerator.- Related open requests of the same shape, both asking for a construct to be broken across lines:
#189 (INSERT columns) and #21 (stored-procedure parameters). - Happy to test a change against a large real-world T-SQL corpus if that is useful.
- Lenguaje dominante
- GAP
- Estrellas
- 277
- Forks
- 43
- Merge medio
- 6 d 17 h
- PR fusionados (30 d)
- 3
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de microsoft/SqlScriptDOM
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
microsoft/SqlScriptDOM#228 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
microsoft/SqlScriptDOM#183 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
microsoft/SqlScriptDOM#225 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
microsoft/SqlScriptDOM#224 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
microsoft/SqlScriptDOM#222 ·
Todos los issues de microsoft/SqlScriptDOM
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
nightscout/nocturne#1424 ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Abiertoarea: repo bug perceived difficulty: 2
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
impl detach for native Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
paritytech/zombienet-sdk#591 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mruangutai/harness#1897 ·