Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

editor: Improve JSDoc extend comment on newline to follow convention (#30800)

Browse source 
Follow up for https://github.com/zed-industries/zed/pull/30768

This PR makes JSDoc auto comment on new line lot better by:

- Inserting delimiters regardless of whether previous delimiters have
trailing spaces or not
- When on start tag, auto-indenting both prefix and end tag upon new
line

This makes it correct as per convention out of the box. No need to
manually adjust spaces on every new line.


https://github.com/user-attachments/assets/81b8e05a-fe8a-4459-9e90-c8a3d70a51a2

Release Notes:

- Improved JSDoc auto-commenting on newline which now correctly indents
as per convention.
This commit is contained in:
Smit Barmase 2025-05-16 12:42:11 +05:30 • committed by GitHub
parent cc3a28a8e8
commit 18d39e3f81
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 264 additions and 139 deletions
Download patch file Download diff file Expand all files Collapse all files

96
crates/editor/src/editor_tests.rs
View file

@ -2805,8 +2805,12 @@ async fn test_newline_documentation_comments(cx: &mut TestAppContext) {
let language = Arc::new(Language::new(
LanguageConfig {
documentation_block: Some(vec!["/**".into(), "*/".into()]),
documentation_comment_prefix: Some("*".into()),
documentation: Some(language::DocumentationConfig {
start: "/**".into(),
end: "*/".into(),
prefix: "* ".into(),
tab_size: NonZeroU32::new(1).unwrap(),
}),
..LanguageConfig::default()
},
None,
@ -2821,9 +2825,10 @@ async fn test_newline_documentation_comments(cx: &mut TestAppContext) {
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
*ˇ
* ˇ
"});
// Ensure that if cursor is before the comment start, we do not actually insert a comment prefix.
// Ensure that if cursor is before the comment start,
// we do not actually insert a comment prefix.
cx.set_state(indoc! {"
ˇ/**
"});
@ -2848,8 +2853,71 @@ async fn test_newline_documentation_comments(cx: &mut TestAppContext) {
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
*ˇ
*/
* ˇ
*/
"});
// Ensure that if suffix exists on same line after cursor with space it adds new line.
cx.set_state(indoc! {"
/**ˇ */
"});
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
* ˇ
*/
"});
// Ensure that if suffix exists on same line after cursor with space it adds new line.
cx.set_state(indoc! {"
/** ˇ*/
"});
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(
indoc! {"
/**s
* ˇ
*/
"}
.replace("s", " ") // s is used as space placeholder to prevent format on save
.as_str(),
);
// Ensure that delimiter space is preserved when newline on already
// spaced delimiter.
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(
indoc! {"
/**s
*s
* ˇ
*/
"}
.replace("s", " ") // s is used as space placeholder to prevent format on save
.as_str(),
);
// Ensure that delimiter space is preserved when space is not
// on existing delimiter.
cx.set_state(indoc! {"
/**
*ˇ
*/
"});
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
*
* ˇ
*/
"});
// Ensure that if suffix exists on same line after cursor it
// doesn't add extra new line if prefix is not on same line.
cx.set_state(indoc! {"
/**
ˇ*/
"});
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
ˇ*/
"});
// Ensure that it detects suffix after existing prefix.
cx.set_state(indoc! {"
@ -2860,7 +2928,8 @@ async fn test_newline_documentation_comments(cx: &mut TestAppContext) {
/**
ˇ/
"});
// Ensure that if suffix exists on same line before cursor it does not add comment prefix.
// Ensure that if suffix exists on same line before
// cursor it does not add comment prefix.
cx.set_state(indoc! {"
/** */ˇ
"});
@ -2869,18 +2938,19 @@ async fn test_newline_documentation_comments(cx: &mut TestAppContext) {
/** */
ˇ
"});
// Ensure that if suffix exists on same line before cursor it does not add comment prefix.
// Ensure that if suffix exists on same line before
// cursor it does not add comment prefix.
cx.set_state(indoc! {"
/**
*
*/ˇ
*
*/ˇ
"});
cx.update_editor(|e, window, cx| e.newline(&Newline, window, cx));
cx.assert_editor_state(indoc! {"
/**
*
*/
ˇ
*
*/
ˇ
"});
}
// Ensure that comment continuations can be disabled.