1 //! Handles the `Enter` key press. At the momently, this only continues
2 //! comments, but should handle indent some time in the future as well.
4 use base_db::{FilePosition, SourceDatabase};
5 use ide_db::RootDatabase;
8 AstNode, SmolStr, SourceFile,
10 SyntaxToken, TextRange, TextSize, TokenAtOffset,
13 use text_edit::TextEdit;
17 // rust-analyzer can override kbd:[Enter] key to make it smarter:
19 // - kbd:[Enter] inside triple-slash comments automatically inserts `///`
20 // - kbd:[Enter] in the middle or after a trailing space in `//` inserts `//`
22 // This action needs to be assigned to shortcut explicitly.
26 // Add the following to `keybindings.json`:
31 // "command": "rust-analyzer.onEnter",
32 // "when": "editorTextFocus && !suggestWidgetVisible && editorLangId == rust"
35 pub(crate) fn on_enter(db: &RootDatabase, position: FilePosition) -> Option<TextEdit> {
36 let parse = db.parse(position.file_id);
37 let file = parse.tree();
40 .token_at_offset(position.offset)
42 .and_then(ast::Comment::cast)?;
44 if comment.kind().shape.is_block() {
48 let prefix = comment.prefix();
49 let comment_range = comment.syntax().text_range();
50 if position.offset < comment_range.start() + TextSize::of(prefix) {
54 let mut remove_last_space = false;
55 // Continuing single-line non-doc comments (like this one :) ) is annoying
56 if prefix == "//" && comment_range.end() == position.offset {
57 if comment.text().ends_with(' ') {
58 mark::hit!(continues_end_of_line_comment_with_space);
59 remove_last_space = true;
60 } else if !followed_by_comment(&comment) {
65 let indent = node_indent(&file, comment.syntax())?;
66 let inserted = format!("\n{}{} $0", indent, prefix);
67 let delete = if remove_last_space {
68 TextRange::new(position.offset - TextSize::of(' '), position.offset)
70 TextRange::empty(position.offset)
72 let edit = TextEdit::replace(delete, inserted);
76 fn followed_by_comment(comment: &ast::Comment) -> bool {
77 let ws = match comment.syntax().next_token().and_then(ast::Whitespace::cast) {
81 if ws.spans_multiple_lines() {
84 ws.syntax().next_token().and_then(ast::Comment::cast).is_some()
87 fn node_indent(file: &SourceFile, token: &SyntaxToken) -> Option<SmolStr> {
88 let ws = match file.syntax().token_at_offset(token.text_range().start()) {
89 TokenAtOffset::Between(l, r) => {
93 TokenAtOffset::Single(n) => {
95 return Some("".into());
97 TokenAtOffset::None => unreachable!(),
99 if ws.kind() != WHITESPACE {
102 let text = ws.text();
103 let pos = text.rfind('\n').map(|it| it + 1).unwrap_or(0);
104 Some(text[pos..].into())
109 use stdx::trim_indent;
110 use test_utils::{assert_eq_text, mark};
112 use crate::mock_analysis::analysis_and_position;
114 fn apply_on_enter(before: &str) -> Option<String> {
115 let (analysis, position) = analysis_and_position(&before);
116 let result = analysis.on_enter(position).unwrap()?;
118 let mut actual = analysis.file_text(position.file_id).unwrap().to_string();
119 result.apply(&mut actual);
123 fn do_check(ra_fixture_before: &str, ra_fixture_after: &str) {
124 let ra_fixture_after = &trim_indent(ra_fixture_after);
125 let actual = apply_on_enter(ra_fixture_before).unwrap();
126 assert_eq_text!(ra_fixture_after, &actual);
129 fn do_check_noop(ra_fixture_text: &str) {
130 assert!(apply_on_enter(ra_fixture_text).is_none())
134 fn continues_doc_comment() {
181 fn does_not_continue_before_doc_comment() {
182 do_check_noop(r"<|>//! docz");
186 fn continues_code_comment_in_the_middle_of_line() {
205 fn continues_code_comment_in_the_middle_several_lines() {
226 fn does_not_continue_end_of_line_comment() {
238 fn continues_end_of_line_comment_with_space() {
239 mark::check!(continues_end_of_line_comment_with_space);