Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-29 06:23:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Make doc comment highlight injection configurable

Browse source
This commit is contained in:
Lukas Wirth 2022-08-22 13:44:07 +02:00
parent 9a201873b8
commit 9700c95ced
4 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
crates/ide/src/syntax_highlighting.rs
View file

@ -38,11 +38,19 @@ pub struct HlRange {
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct HighlightConfig {
/// Whether to highlight strings
pub strings: bool,
/// Whether to highlight punctuation
pub punctuation: bool,
/// Whether to specialize punctuation highlights
pub specialize_punctuation: bool,
pub specialize_operator: bool,
/// Whether to highlight operator
pub operator: bool,
/// Whether to specialize operator highlights
pub specialize_operator: bool,
/// Whether to inject highlights into doc comments
pub inject_doc_comment: bool,
/// Whether to highlight unresolved things be their syntax
pub syntactic_name_ref_highlighting: bool,
}
@ -325,9 +333,11 @@ fn traverse(
Enter(it) => it,
Leave(NodeOrToken::Token(_)) => continue,
Leave(NodeOrToken::Node(node)) => {
// Doc comment highlighting injection, we do this when leaving the node
// so that we overwrite the highlighting of the doc comment itself.
inject::doc_comment(hl, sema, config, file_id, &node);
if config.inject_doc_comment {
// Doc comment highlighting injection, we do this when leaving the node
// so that we overwrite the highlighting of the doc comment itself.
inject::doc_comment(hl, sema, config, file_id, &node);
}
continue;
}
};

1
crates/ide/src/syntax_highlighting/html.rs
View file

@ -31,6 +31,7 @@ pub(crate) fn highlight_as_html(db: &RootDatabase, file_id: FileId, rainbow: boo
specialize_punctuation: true,
specialize_operator: true,
operator: true,
inject_doc_comment: true,
syntactic_name_ref_highlighting: false,
},
file_id,

1
crates/ide/src/syntax_highlighting/tests.rs
View file

@ -12,6 +12,7 @@ const HL_CONFIG: HighlightConfig = HighlightConfig {
specialize_punctuation: true,
specialize_operator: true,
operator: true,
inject_doc_comment: true,
syntactic_name_ref_highlighting: false,
};

6
crates/rust-analyzer/src/config.rs
View file

@ -411,6 +411,11 @@ config_data! {
/// When enabled, rust-analyzer will emit special token types for operator tokens instead
/// of the generic `operator` token type.
semanticHighlighting_operator_specialization_enable: bool = "false",
/// Inject additional highlighting into doc comments.
///
/// When enabled, rust-analyzer will highlight rust source in doc comments as well as intra
/// doc links.
semanticHighlighting_doc_comment_inject_enable: bool = "true",
/// Show full signature of the callable. Only shows parameters if disabled.
signatureInfo_detail: SignatureDetail = "\"full\"",
@ -1200,6 +1205,7 @@ impl Config {
.semanticHighlighting_punctuation_specialization_enable,
operator: self.data.semanticHighlighting_operator_enable,
specialize_operator: self.data.semanticHighlighting_operator_specialization_enable,
inject_doc_comment: self.data.semanticHighlighting_doc_comment_inject_enable,
syntactic_name_ref_highlighting: false,
}
}