Added TODOs

Author: KyrylR

Cargo.toml

@@ -2,14 +2,21 @@
 name = "simplicityhl-lsp"
 version = "0.1.3"
 edition = "2024"
+# TODO: add rust-version
 
 [dependencies]
 tokio = { version = "1.47.1", features = ["full"] }
 serde_json = "1.0.143"
 tower-lsp-server = "0.22.1"
-simplicityhl = { git = "https://github.com/BlockstreamResearch/SimplicityHL.git", rev = "e68e1c6" }
+
+# TODO: remove in favor of HashMap pls
 dashmap = "6.1.0"
-ropey = "1.6.1"
+
 log = "0.4.28"
 env_logger = "0.11.8"
-miniscript = "12.3.1"
+
+ropey = "1.6.1"
+miniscript = "12"
+simplicityhl = { git = "https://github.com/BlockstreamResearch/SimplicityHL.git", rev = "e68e1c6" }
+
+# TODO: add `[lints.rust]` and `[lints.clippy]` pls (to enforce consistent lints across users on edition 2024)

src/backend.rs

@@ -68,6 +68,7 @@ impl LanguageServer for Backend {
                 )),
                 completion_provider: Some(CompletionOptions {
                     resolve_provider: Some(false),
+                    // TODO: maybe use double-colon (via filtering)?
                     trigger_characters: Some(vec![":".to_string()]),
                     work_done_progress_options: WorkDoneProgressOptions::default(),
                     all_commit_characters: None,
@@ -223,6 +224,7 @@ impl Backend {
                 if let Some(mut doc) = self.document_map.get_mut(uri) {
                     doc.functions.push(func.to_owned());
 
+                    // TODO: avoid cloning Rope and repeated Rope conversions
                     let rope = doc.text.clone();
                     let start_line =
                         u32::try_from(func.as_ref().start.line.get()).unwrap_or_default() - 1;
@@ -253,6 +255,7 @@ impl Backend {
 
         match err {
             None => {
+                // TODO: Is this really needed on the INFO level?
                 self.client
                     .log_message(MessageType::INFO, "errors not found!".to_string())
                     .await;
@@ -264,6 +267,7 @@ impl Backend {
                 let (start, end) = match span_to_positions(err.span()) {
                     Ok(result) => result,
                     Err(err) => {
+                        // TODO: Replace dbg! with structured logging to client.log_message
                         dbg!("catch error: {}", err);
                         return;
                     }
@@ -301,6 +305,7 @@ impl Backend {
                     simplicityhl::simplicity::jet::Elements::from_str(format!("{jet}").as_str())
                         .ok()?;
 
+                // TODO: For consistency use `template.get_signature()` instead of reconstructing
                 let template = completion::jet::jet_to_template(element);
                 let description = format!(
                     "```simplicityhl\nfn jet::{}({}) -> {}\n```\n{}",
@@ -427,6 +432,13 @@ fn find_related_call(
         .iter()
         .find(|func| span_contains(func.span(), &token_span))?;
 
+    // Replace with?
+    // parse::ExprTree::Expression(func.body())
+    // .pre_order_iter()
+    // .filter_map(|expr| if let parse::ExprTree::Call(call) = expr { Some(call) } else { None })
+    // .filter(|c| span_contains(c.span(), &token_span))
+    // .last()
+
     let calls = parse::ExprTree::Expression(func.body())
         .pre_order_iter()
         .filter_map(|expr| match expr {

src/completion/builtin.rs

@@ -49,7 +49,6 @@ pub fn get_builtin_functions() -> Vec<FunctionTemplate> {
 }
 
 /// Match [`simplicityhl::parse::CallName`] and return [`FunctionTemplate`]
-#[allow(warnings)]
 pub fn match_callname(call: CallName) -> Option<FunctionTemplate> {
     match call {
         CallName::UnwrapLeft(aliased_type) => {
@@ -102,7 +101,7 @@ let y: u8 = unwrap(x); // 5
         CallName::IsNone(aliased_type) => {
             let ty = aliased_type.to_string();
             Some(FunctionTemplate::new(
-                format!("is_none"),
+                "is_none".to_string(),
                 "is_none",
                 str_vec![format!("{ty}")],
                 str_vec![format!("Option<{ty}>").as_str()],