Skip to content
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.

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

Take into account size of function definition when formatting return type #919

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Luau: Fixed incorrect removal of semicolon before compound assignment with parentheses leading to ambiguous syntax error ([#885](https://github.com/JohnnyMorganz/StyLua/issues/885))
- Luau: Fixed incorrect collapsing of union/intersection type value with comments in a type table leading to a syntax error ([#893](https://github.com/JohnnyMorganz/StyLua/issues/893))
- Fixed `--verify` panicing due to overflow for very large Hex numbers ([#875](https://github.com/JohnnyMorganz/StyLua/issues/875), [#889](https://github.com/JohnnyMorganz/StyLua/issues/889))
- Luau: take into account the size of the current function definition when formatting the return type ([#896](https://github.com/JohnnyMorganz/StyLua/issues/896))

## [0.20.0] - 2024-01-20

Expand Down
26 changes: 20 additions & 6 deletions src/formatters/functions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -750,6 +750,9 @@ pub fn format_function_body(
function_body: &FunctionBody,
shape: Shape,
) -> FunctionBody {
const SINGLE_PAREN_LEN: usize = "(".len();
const PARENS_LEN: usize = SINGLE_PAREN_LEN * 2;

// Calculate trivia
let leading_trivia = vec![create_indent_trivia(ctx, shape)];

Expand Down Expand Up @@ -814,14 +817,26 @@ pub fn format_function_body(
shape
};

let type_specifiers = function_body
.type_specifiers()
.map(|x| x.map(|specifier| format_type_specifier(ctx, specifier, parameters_shape)))
.collect::<Vec<_>>();

let return_type_shape = if multiline_params {
shape.reset() + SINGLE_PAREN_LEN
} else {
shape.take_first_line(&formatted_parameters)
+ PARENS_LEN
+ type_specifiers.iter().fold(0, |acc, x| {
acc + x.as_ref().map_or(0, |x| x.to_string().len())
})
};

(
function_body
.type_specifiers()
.map(|x| x.map(|specifier| format_type_specifier(ctx, specifier, parameters_shape)))
.collect::<Vec<_>>(),
type_specifiers,
function_body
.return_type()
.map(|return_type| format_type_specifier(ctx, return_type, shape)),
.map(|return_type| format_type_specifier(ctx, return_type, return_type_shape)),
)
};

Expand All @@ -834,7 +849,6 @@ pub fn format_function_body(
if trivia_util::is_block_empty(function_body.block()) {
Block::new()
} else {
const PARENS_LEN: usize = "()".len();
let block_shape = shape.take_first_line(&formatted_parameters) + PARENS_LEN;

#[cfg(feature = "luau")]
Expand Down
2 changes: 2 additions & 0 deletions tests/inputs-luau/function_types_4.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-- https://github.com/JohnnyMorganz/StyLua/issues/896
local function getData(player: Player): (LongReturnValueWithTypeGeneric1<TypeParameter1>, LongReturnValueWithTypeGeneric2<TypeParameter2>) end
11 changes: 11 additions & 0 deletions tests/snapshots/tests__luau@function_types_4.lua.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
source: tests/tests.rs
expression: "format(&contents, LuaVersion::Luau)"
input_file: tests/inputs-luau/function_types_4.lua
---
-- https://github.com/JohnnyMorganz/StyLua/issues/896
local function getData(player: Player): (
LongReturnValueWithTypeGeneric1<TypeParameter1>,
LongReturnValueWithTypeGeneric2<TypeParameter2>
) end

Loading