Skip to content

fix: Handle Unicode characters in LSP formatting #1044

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

Merged
JohnnyMorganz merged 3 commits into from
Oct 12, 2025
Merged

fix: Handle Unicode characters in LSP formatting #1044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
930db61
fix: Handle Unicode characters in LSP formatting
Davidyz Oct 9, 2025
9273811
chore: cargo fmt
Davidyz Oct 11, 2025
ddd228e
docs: update CHANGELOG
Davidyz Oct 11, 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 CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- Use character-wised diff instead of byte-wise diff in the LSP server so that it can handle multi-byte characters ([#1042](https://github.com/JohnnyMorganz/StyLua/issues/1042), [#1043](https://github.com/JohnnyMorganz/StyLua/issues/1043)).

## [2.3.0] - 2025-09-27

### Added
Expand Down
184 changes: 175 additions & 9 deletions src/cli/lsp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,33 @@ use crate::{config::ConfigResolver, opt, stylua_ignore};
fn diffop_to_textedit(
op: DiffOp,
document: &FullTextDocument,
original_contents: &str,
formatted_contents: &str,
) -> Option<TextEdit> {
let range = |start: usize, len: usize| Range {
start: document.position_at(start.try_into().expect("usize fits into u32")),
end: document.position_at((start + len).try_into().expect("usize fits into u32")),
let range = |start: usize, len: usize| {
let byte_start = original_contents
.char_indices()
.nth(start)
.map(|(i, _)| i)
.unwrap_or(original_contents.len());
let byte_end = original_contents
.char_indices()
.nth(start + len)
.map(|(i, _)| i)
.unwrap_or(original_contents.len());
Range {
start: document.position_at(byte_start.try_into().expect("usize fits into u32")),
end: document.position_at(byte_end.try_into().expect("usize fits into u32")),
}
};

let lookup = |start: usize, len: usize| formatted_contents[start..start + len].to_string();
let lookup = |start: usize, len: usize| {
formatted_contents
.chars()
.skip(start)
.take(len)
.collect::<String>()
};

match op {
DiffOp::Equal {
Expand Down Expand Up @@ -181,14 +200,14 @@ impl LanguageServer<'_> {
return Err(FormattingError::StyLuaError);
};

let operations =
TextDiff::from_chars(contents.as_bytes(), formatted_contents.as_bytes()).grouped_ops(0);
let operations = TextDiff::from_chars(contents, &formatted_contents).grouped_ops(0);

let edits = operations
.into_iter()
.flat_map(|operations| {
operations
.into_iter()
.filter_map(|op| diffop_to_textedit(op, document, &formatted_contents))
operations.into_iter().filter_map(|op| {
diffop_to_textedit(op, document, contents, &formatted_contents)
})
})
.collect();
Ok(edits)
Expand Down Expand Up @@ -657,6 +676,153 @@ mod tests {
assert!(client.receiver.is_empty());
}

#[test]
fn test_lsp_document_formatting_with_unicode() {
let uri = Uri::from_str("file:///home/documents/file.lua").unwrap();
let contents = "local x = 1 -- 测试\nlocal y =2";

let opt = Opt::parse_from(vec!["BINARY_NAME"]);
let mut config_resolver = ConfigResolver::new(&opt).unwrap();

let (server, client) = Connection::memory();
client.sender.send(initialize(1, None)).unwrap();
client.sender.send(initialized()).unwrap();
client
.sender
.send(open_text_document(uri.clone(), contents.to_string()))
.unwrap();
client
.sender
.send(format_document(
2,
uri.clone(),
FormattingOptions::default(),
))
.unwrap();
client.sender.send(shutdown(3)).unwrap();
client.sender.send(exit()).unwrap();

main_loop(server, false, &mut config_resolver).unwrap();

expect_server_initialized(&client.receiver, 1);

let edits: Vec<TextEdit> = expect_response(&client.receiver, 2);
assert_eq!(
edits,
[
TextEdit {
range: Range {
start: Position {
line: 0,
character: 6
},
end: Position {
line: 0,
character: 7
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 0,
character: 8
},
end: Position {
line: 0,
character: 9
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 0,
character: 11
},
end: Position {
line: 0,
character: 12
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 1,
character: 5
},
end: Position {
line: 1,
character: 7
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 1,
character: 8
},
end: Position {
line: 1,
character: 9
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 1,
character: 10
},
end: Position {
line: 1,
character: 12
}
},
new_text: "".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 1,
character: 14
},
end: Position {
line: 1,
character: 14
}
},
new_text: " ".to_string()
},
TextEdit {
range: Range {
start: Position {
line: 1,
character: 15
},
end: Position {
line: 1,
character: 15
}
},
new_text: "\n".to_string()
}
]
);
let formatted = apply_text_edits_to(contents, edits);
assert_eq!(formatted, "local x = 1 -- 测试\nlocal y = 2\n");

expect_server_shutdown(&client.receiver, 3);
assert!(client.receiver.is_empty());
}

#[test]
fn test_lsp_range_formatting() {
let uri = Uri::from_str("file:///home/documents/file.luau").unwrap();
Expand Down