Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Fix auto-indent for braceless if/for/while in TypeScript (#60708)

Apoorva Verma1a246efd7e1b
diff --git a/crates/grammars/src/tsx/indents.scm b/crates/grammars/src/tsx/indents.scm
index 1e72160bca2..ffc35bfec96 100644
--- a/crates/grammars/src/tsx/indents.scm
+++ b/crates/grammars/src/tsx/indents.scm
@@ -5,10 +5,26 @@
(lexical_declaration)
(variable_declaration)
(assignment_expression)
- (if_statement)
- (for_statement)
] @indent
+; Indent a braceless body (`if (x)\n y()`). When the body is a `{}` block the
+; `@end` stops the range before the brace so the block rule handles it instead,
+; which keeps Allman-style braces unindented.
+(if_statement
+ consequence: (statement_block)? @end) @indent
+
+(else_clause
+ (statement_block)? @end) @indent
+
+(for_statement
+ body: (statement_block)? @end) @indent
+
+(for_in_statement
+ body: (statement_block)? @end) @indent
+
+(while_statement
+ body: (statement_block)? @end) @indent
+
(_
"["
"]" @end) @indent
diff --git a/crates/grammars/src/typescript/indents.scm b/crates/grammars/src/typescript/indents.scm
index 2715d256719..3dc7d76813c 100644
--- a/crates/grammars/src/typescript/indents.scm
+++ b/crates/grammars/src/typescript/indents.scm
@@ -5,12 +5,26 @@
(lexical_declaration)
(variable_declaration)
(assignment_expression)
- ; below handled by `(_ "{" "}" @end) @indent`
- ; (if_statement)
- ; (for_statement)
- ; (while_statement)
] @indent
+; Indent a braceless body (`if (x)\n y()`). When the body is a `{}` block the
+; `@end` stops the range before the brace so the block rule handles it instead,
+; which keeps Allman-style braces unindented.
+(if_statement
+ consequence: (statement_block)? @end) @indent
+
+(else_clause
+ (statement_block)? @end) @indent
+
+(for_statement
+ body: (statement_block)? @end) @indent
+
+(for_in_statement
+ body: (statement_block)? @end) @indent
+
+(while_statement
+ body: (statement_block)? @end) @indent
+
(_
"["
"]" @end) @indent
diff --git a/crates/language/src/buffer_tests.rs b/crates/language/src/buffer_tests.rs
index 29afbe84b72..ea4c49d920c 100644
--- a/crates/language/src/buffer_tests.rs
+++ b/crates/language/src/buffer_tests.rs
@@ -4367,6 +4367,90 @@ fn get_tree_sexp(buffer: &Entity<Buffer>, cx: &mut gpui::TestAppContext) -> Stri
})
}
+fn typescript_lang_with_indents() -> Arc<Language> {
+ Arc::new(
+ Language::new(
+ LanguageConfig {
+ name: "TypeScript".into(),
+ ..Default::default()
+ },
+ Some(tree_sitter_typescript::LANGUAGE_TYPESCRIPT.into()),
+ )
+ .with_brackets_query(r#"("{" @open "}" @close) ("(" @open ")" @close)"#)
+ .unwrap()
+ .with_indents_query(include_str!("../../grammars/src/typescript/indents.scm"))
+ .unwrap(),
+ )
+}
+
+fn tsx_lang_with_indents() -> Arc<Language> {
+ Arc::new(
+ Language::new(
+ LanguageConfig {
+ name: "TSX".into(),
+ ..Default::default()
+ },
+ Some(tree_sitter_typescript::LANGUAGE_TSX.into()),
+ )
+ .with_brackets_query(r#"("{" @open "}" @close) ("(" @open ")" @close)"#)
+ .unwrap()
+ .with_indents_query(include_str!("../../grammars/src/tsx/indents.scm"))
+ .unwrap(),
+ )
+}
+
+#[gpui::test]
+fn test_autoindent_typescript_braceless_control_flow(cx: &mut App) {
+ init_settings(cx, |_| {});
+ cx.new(|cx| {
+ for lang in [typescript_lang_with_indents(), tsx_lang_with_indents()] {
+ let mut indent = |header: &str, header_len: usize, body: &str| {
+ let mut buffer = Buffer::local(header, cx).with_language(lang.clone(), cx);
+ buffer.edit(
+ [(header_len..header_len, body)],
+ Some(AutoindentMode::EachLine),
+ cx,
+ );
+ buffer.text()
+ };
+
+ // A braceless body is indented under its `if`/`for`/`while`.
+ assert_eq!(indent("if (true)", 9, "\nx()"), "if (true)\n x()");
+ assert_eq!(indent("for (;;)", 8, "\nx()"), "for (;;)\n x()");
+ assert_eq!(indent("while (true)", 12, "\nx()"), "while (true)\n x()");
+ assert_eq!(
+ indent("for (const a of b)", 18, "\nx()"),
+ "for (const a of b)\n x()"
+ );
+
+ // The statement after a braceless body returns to the outer indent.
+ assert_eq!(
+ indent("if (true)\n x()", 17, "\ny()"),
+ "if (true)\n x()\ny()"
+ );
+
+ // A `{}` block keeps its brace unindented (Allman style), leaving the
+ // block rule to indent the contents. Regression guard for #24976.
+ assert_eq!(indent("if (true)", 9, "\n{}"), "if (true)\n{}");
+ assert_eq!(indent("for (;;)", 8, "\n{}"), "for (;;)\n{}");
+ assert_eq!(indent("while (true)", 12, "\n{}"), "while (true)\n{}");
+
+ // K&R braced bodies indent their contents once.
+ assert_eq!(
+ indent("if (true) {\n}", 11, "\nx()"),
+ "if (true) {\n x()\n}"
+ );
+
+ // A braceless `else` body is indented under the `else`.
+ assert_eq!(
+ indent("if (true)\n x()\nelse", 22, "\ny()"),
+ "if (true)\n x()\nelse\n y()"
+ );
+ }
+ Buffer::local("", cx)
+ });
+}
+
// Assert that the enclosing bracket ranges around the selection match the pairs indicated by the marked text in `range_markers`
#[track_caller]
fn assert_bracket_pairs(