Skip to content

Commit

Permalink
feat: enhance lsp complete for function params (#957)
Browse files Browse the repository at this point in the history 
feat: enhance lsp complete for function params. use insert_text(place holder) to replace params name in CompletionItem label

Signed-off-by: he1pa <[email protected]>
  • Loading branch information
@He1pa
He1pa authored Dec 19, 2023
1 parent b8f7fd8 commit e14cbae
Showing 1 changed file with 103 additions and 7 deletions.
110 changes: 103 additions & 7 deletions kclvm/tools/src/LSP/src/completion.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ use kclvm_sema::builtin::{STANDARD_SYSTEM_MODULES, STRING_MEMBER_FUNCTIONS};
use kclvm_sema::core::package::ModuleInfo;
use kclvm_sema::resolver::doc::{parse_doc_string, Doc};
use kclvm_sema::ty::{FunctionType, SchemaType, Type};
use lsp_types::{CompletionItem, CompletionItemKind};
use lsp_types::{CompletionItem, CompletionItemKind, InsertTextFormat};

use crate::util::{get_real_path_from_external, is_in_schema_expr};
use crate::util::{inner_most_expr_in_stmt, is_in_docstring};
Expand Down Expand Up @@ -71,6 +71,7 @@ pub(crate) struct KCLCompletionItem {
pub detail: Option<String>,
pub documentation: Option<String>,
pub kind: Option<KCLCompletionItemKind>,
pub insert_text: Option<String>,
}

/// Computes completions at the given position.
Expand Down Expand Up @@ -102,6 +103,7 @@ pub(crate) fn completion(
detail: None,
documentation: None,
kind: Some(KCLCompletionItemKind::Module),
insert_text: None,
}));
}

Expand All @@ -126,6 +128,7 @@ pub(crate) fn completion(
detail: Some(ty.ty_str()),
documentation: sema_info.doc.clone(),
kind: Some(KCLCompletionItemKind::Module),
insert_text: None,
});
}
_ => {
Expand All @@ -134,6 +137,7 @@ pub(crate) fn completion(
detail: Some(ty.ty_str()),
documentation: sema_info.doc.clone(),
kind: None,
insert_text: None,
});
}
},
Expand Down Expand Up @@ -185,6 +189,10 @@ fn completion_dot(
detail: Some(ty.ty_str()),
documentation: ty.ty_doc(),
kind: Some(KCLCompletionItemKind::Function),
insert_text: Some(func_ty_complete_insert_text(
name,
&ty.into_function_ty(),
)),
})
.collect(),
)
Expand Down Expand Up @@ -223,6 +231,12 @@ fn completion_dot(
}
_ => name.clone(),
};
let insert_text = match &ty.kind {
kclvm_sema::ty::TypeKind::Function(func_ty) => {
Some(func_ty_complete_insert_text(&name, func_ty))
}
_ => None,
};
let kind = match &def.get_sema_info().ty {
Some(ty) => match &ty.kind {
kclvm_sema::ty::TypeKind::Schema(_) => {
Expand All @@ -247,6 +261,7 @@ fn completion_dot(
detail: Some(format!("{}: {}", name, ty.ty_str())),
documentation,
kind,
insert_text,
});
}
None => {
Expand All @@ -255,6 +270,7 @@ fn completion_dot(
detail: None,
documentation: None,
kind: None,
insert_text: None,
});
}
}
Expand Down Expand Up @@ -295,6 +311,7 @@ fn completion_assign(pos: &KCLPos, gs: &GlobalState) -> Option<lsp_types::Comple
)),
kind: Some(KCLCompletionItemKind::Variable),
documentation: sema_info.doc.clone(),
insert_text: None,
}
}),
);
Expand Down Expand Up @@ -330,6 +347,7 @@ fn completion_newline(
detail: Some("generate docstring".to_string()),
documentation: Some(format!("docstring for {}", schema.name.node.clone())),
kind: Some(KCLCompletionItemKind::Doc),
insert_text: None,
});
}
return Some(into_completion_items(&completions).into());
Expand Down Expand Up @@ -364,6 +382,7 @@ fn completion_newline(
None => None,
},
kind: Some(KCLCompletionItemKind::SchemaAttr),
insert_text: None,
});
}
_ => {}
Expand Down Expand Up @@ -397,6 +416,7 @@ fn completion_import_builtin_pkg(program: &Program, pos: &KCLPos) -> IndexSet<KC
detail: None,
documentation: None,
kind: Some(KCLCompletionItemKind::Module),
insert_text: None,
}))
}
}
Expand Down Expand Up @@ -452,6 +472,7 @@ fn schema_ty_completion_item(schema_ty: &SchemaType) -> KCLCompletionItem {
detail: Some(detail),
documentation: Some(schema_ty.doc.clone()),
kind: Some(KCLCompletionItemKind::Schema),
insert_text: None,
}
}

Expand Down Expand Up @@ -483,6 +504,7 @@ fn completion_import(
detail: None,
documentation: None,
kind: Some(KCLCompletionItemKind::Dir),
insert_text: None,
});
} else if path.is_file() {
if let Some(extension) = path.extension() {
Expand All @@ -498,6 +520,7 @@ fn completion_import(
detail: None,
documentation: None,
kind: Some(KCLCompletionItemKind::File),
insert_text: None,
});
}
}
Expand Down Expand Up @@ -572,6 +595,20 @@ fn func_ty_complete_label(func_name: &String, func_type: &FunctionType) -> Strin
)
}

fn func_ty_complete_insert_text(func_name: &String, func_type: &FunctionType) -> String {
format!(
"{}({})",
func_name,
func_type
.params
.iter()
.enumerate()
.map(|(idx, param)| format!("${{{}:{}}}", idx + 1, param.name.clone()))
.collect::<Vec<String>>()
.join(", "),
)
}

pub(crate) fn into_completion_items(items: &IndexSet<KCLCompletionItem>) -> Vec<CompletionItem> {
items
.iter()
Expand All @@ -583,6 +620,12 @@ pub(crate) fn into_completion_items(items: &IndexSet<KCLCompletionItem>) -> Vec<
.clone()
.map(lsp_types::Documentation::String),
kind: item.kind.clone().map(|kind| kind.into()),
insert_text: item.insert_text.clone(),
insert_text_format: if item.insert_text.is_some() {
Some(InsertTextFormat::SNIPPET)
} else {
None
},
..Default::default()
})
.collect()
Expand All @@ -598,8 +641,8 @@ mod tests {

use crate::{
completion::{
completion, func_ty_complete_label, into_completion_items, KCLCompletionItem,
KCLCompletionItemKind,
completion, func_ty_complete_insert_text, func_ty_complete_label,
into_completion_items, KCLCompletionItem, KCLCompletionItemKind,
},
tests::compile_test_file,
};
Expand Down Expand Up @@ -681,7 +724,7 @@ mod tests {

// test completion for str builtin function
let got = completion(Some('.'), &program, &pos, &gs).unwrap();
let got_labels: Vec<String> = match got {
let got_labels: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr.iter().map(|item| item.label.clone()).collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
Expand All @@ -691,6 +734,19 @@ mod tests {
.collect();
assert_eq!(got_labels, expected_labels);

let got_insert_text: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr
.iter()
.map(|item| item.insert_text.clone().unwrap())
.collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
let expected_insert_text: Vec<String> = STRING_MEMBER_FUNCTIONS
.iter()
.map(|(name, ty)| func_ty_complete_insert_text(name, &ty.into_function_ty()))
.collect();
assert_eq!(got_insert_text, expected_insert_text);

// test completion for import pkg path
let pos = KCLPos {
filename: file.to_owned(),
Expand Down Expand Up @@ -852,7 +908,7 @@ mod tests {
column: Some(5),
};
let got = completion(Some('.'), &program, &pos, &gs).unwrap();
let got_labels: Vec<String> = match got {
let got_labels: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr.iter().map(|item| item.label.clone()).collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
Expand All @@ -862,6 +918,19 @@ mod tests {
.collect();
assert_eq!(got_labels, expected_labels);

let got_insert_text: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr
.iter()
.map(|item| item.insert_text.clone().unwrap())
.collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
let expected_insert_text: Vec<String> = MATH_FUNCTION_TYPES
.iter()
.map(|(name, ty)| func_ty_complete_insert_text(name, &ty.into_function_ty()))
.collect();
assert_eq!(got_insert_text, expected_insert_text);

// test completion for literal str builtin function
let pos = KCLPos {
filename: file.clone(),
Expand All @@ -870,7 +939,7 @@ mod tests {
};

let got = completion(Some('.'), &program, &pos, &gs).unwrap();
let got_labels: Vec<String> = match got {
let got_labels: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr.iter().map(|item| item.label.clone()).collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
Expand All @@ -881,6 +950,19 @@ mod tests {
.collect();
assert_eq!(got_labels, expected_labels);

let got_insert_text: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr
.iter()
.map(|item| item.insert_text.clone().unwrap())
.collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
let expected_insert_text: Vec<String> = STRING_MEMBER_FUNCTIONS
.iter()
.map(|(name, ty)| func_ty_complete_insert_text(name, &ty.into_function_ty()))
.collect();
assert_eq!(got_insert_text, expected_insert_text);

let pos = KCLPos {
filename: file,
line: 30,
Expand Down Expand Up @@ -936,6 +1018,7 @@ mod tests {
kind: Some(KCLCompletionItemKind::Module),
detail: None,
documentation: None,
insert_text: None,
})
.collect::<IndexSet<KCLCompletionItem>>(),
);
Expand Down Expand Up @@ -1162,7 +1245,7 @@ mod tests {
};

let got = completion(Some('.'), &program, &pos, &gs).unwrap();
let got_labels: Vec<String> = match got {
let got_labels: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr.iter().map(|item| item.label.clone()).collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
Expand All @@ -1173,6 +1256,19 @@ mod tests {
.collect();
assert_eq!(got_labels, expected_labels);

let got_insert_text: Vec<String> = match &got {
CompletionResponse::Array(arr) => arr
.iter()
.map(|item| item.insert_text.clone().unwrap())
.collect(),
CompletionResponse::List(_) => panic!("test failed"),
};
let expected_insert_text: Vec<String> = STRING_MEMBER_FUNCTIONS
.iter()
.map(|(name, ty)| func_ty_complete_insert_text(name, &ty.into_function_ty()))
.collect();
assert_eq!(got_insert_text, expected_insert_text);

let pos = KCLPos {
filename: file.to_owned(),
line: 2,
Expand Down

0 comments on commit e14cbae

Please sign in to comment.