editor: Add prefix on newline in documentation block (e.g. JSDoc) (#30768)

Closes #8973

- [x] Tests


https://github.com/user-attachments/assets/7fc6608f-1c11-4c70-a69b-34bfa8f789a2

Release Notes:

- Added auto-insertion of asterisk (*) prefix when creating new lines
within JSDoc comment blocks.
This commit is contained in:
Smit Barmase 2025-05-15 20:30:06 +05:30 committed by GitHub
parent 4b7b5db58c
commit c2feffac9d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 225 additions and 3 deletions

View file

@ -755,6 +755,12 @@ pub struct LanguageConfig {
/// A list of preferred debuggers for this language.
#[serde(default)]
pub debuggers: IndexSet<SharedString>,
/// A character to add as a prefix when a new line is added to a documentation block.
#[serde(default)]
pub documentation_comment_prefix: Option<Arc<str>>,
/// Returns string documentation block of this language should start with.
#[serde(default)]
pub documentation_block: Option<Vec<Arc<str>>>,
}
#[derive(Clone, Debug, Serialize, Deserialize, Default, JsonSchema)]
@ -883,6 +889,8 @@ impl Default for LanguageConfig {
completion_query_characters: Default::default(),
debuggers: Default::default(),
significant_indentation: Default::default(),
documentation_comment_prefix: None,
documentation_block: None,
}
}
}
@ -1802,6 +1810,23 @@ impl LanguageScope {
.unwrap_or(false)
}
/// A character to add as a prefix when a new line is added to a documentation block.
///
/// Used for documentation styles that require a leading character on each line,
/// such as the asterisk in JSDoc, Javadoc, etc.
pub fn documentation_comment_prefix(&self) -> Option<&Arc<str>> {
self.language.config.documentation_comment_prefix.as_ref()
}
/// Returns prefix and suffix for documentation block of this language.
pub fn documentation_block(&self) -> &[Arc<str>] {
self.language
.config
.documentation_block
.as_ref()
.map_or([].as_slice(), |e| e.as_slice())
}
/// Returns a list of bracket pairs for a given language with an additional
/// piece of information about whether the particular bracket pair is currently active for a given language.
pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {