fix: sort_text and search through orderred collections

Author: estin

src/lib.rs

@@ -3,7 +3,7 @@ use anyhow::Result;
 use ropey::Rope;
 use serde::Deserialize;
 use std::borrow::Cow;
-use std::collections::{HashMap, HashSet};
+use std::collections::{BTreeMap, HashMap, HashSet};
 use std::io::prelude::*;
 use tokio::sync::{mpsc, oneshot};
 use tower_lsp::lsp_types::*;
@@ -286,7 +286,7 @@ pub struct BackendState {
     settings: BackendSettings,
     docs: HashMap<Url, Document>,
     snippets: Vec<Snippet>,
-    unicode_input: HashMap<String, String>,
+    unicode_input: BTreeMap<String, String>,
     max_unicude_input_prefix_len: usize,
     min_unicude_input_prefix_len: usize,
     max_snippet_input_prefix_len: usize,
@@ -301,7 +301,7 @@ impl BackendState {
     pub async fn new(
         home_dir: String,
         snippets: Vec<Snippet>,
-        unicode_input: HashMap<String, String>,
+        unicode_input: BTreeMap<String, String>,
     ) -> (mpsc::UnboundedSender<BackendRequest>, Self) {
         let (request_tx, request_rx) = mpsc::unbounded_channel::<BackendRequest>();
 
@@ -562,6 +562,7 @@ impl BackendState {
                 };
                 CompletionItem {
                     label: s.prefix.to_owned(),
+                    sort_text: Some(s.prefix.to_string()),
                     filter_text: Some(if filter_text_prefix.is_empty() {
                         s.prefix.to_string()
                     } else {
@@ -668,6 +669,7 @@ impl BackendState {
                     };
                     Some(CompletionItem {
                         label: body.to_string(),
+                        sort_text: Some(prefix.to_string()),
                         filter_text: Some(format!("{word_prefix}{prefix}")),
                         kind: Some(CompletionItemKind::TEXT),
                         text_edit: Some(CompletionTextEdit::InsertAndReplace(InsertReplaceEdit {
@@ -789,6 +791,7 @@ impl BackendState {
                 };
                 Some(CompletionItem {
                     label: full_path.to_string(),
+                    sort_text: Some(full_path.to_string()),
                     filter_text: Some(format!("{word_prefix}{full_path}")),
                     kind: Some(if path.is_dir() {
                         CompletionItemKind::FOLDER
@@ -941,6 +944,7 @@ impl BackendState {
                         };
                         Some(CompletionItem {
                             label: format!("@{}", b.key),
+                            sort_text: Some(word_prefix.to_string()),
                             filter_text: Some(word_prefix.to_string()),
                             kind: Some(CompletionItemKind::REFERENCE),
                             text_edit: Some(CompletionTextEdit::InsertAndReplace(

src/main.rs

@@ -1,5 +1,5 @@
 use etcetera::base_strategy::{choose_base_strategy, BaseStrategy};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
 use xshell::{cmd, Shell};
 
@@ -45,7 +45,7 @@ async fn serve(start_options: &StartOptions) {
     let unicode_input = load_unicode_input_from_path(&start_options.unicode_input_path)
         .unwrap_or_else(|e| {
             tracing::error!("On read 'unicode input' config: {e}");
-            HashMap::new()
+            BTreeMap::new()
         });
 
     server::start(

src/server.rs

@@ -1,5 +1,5 @@
 use crate::{snippets::Snippet, BackendRequest, BackendResponse, BackendState};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use tokio::io::{AsyncRead, AsyncWrite};
 use tokio::sync::{mpsc, oneshot};
 use tower_lsp::jsonrpc::Result;
@@ -113,7 +113,7 @@ pub async fn start<I, O>(
     read: I,
     write: O,
     snippets: Vec<Snippet>,
-    unicode_input: HashMap<String, String>,
+    unicode_input: BTreeMap<String, String>,
     home_dir: String,
 ) where
     I: AsyncRead + Unpin,

src/snippets/config.rs

@@ -3,7 +3,7 @@ use crate::snippets::vscode::VSSnippetsConfig;
 use crate::StartOptions;
 use anyhow::Result;
 use serde::Deserialize;
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 
 #[derive(Deserialize)]
 pub struct SnippetsConfig {
@@ -21,7 +21,7 @@ pub struct Snippet {
 #[derive(Deserialize)]
 pub struct UnicodeInputConfig {
     #[serde(flatten)]
-    pub inner: HashMap<String, String>,
+    pub inner: BTreeMap<String, String>,
 }
 
 pub fn load_snippets(start_options: &StartOptions) -> Result<Vec<Snippet>> {
@@ -70,6 +70,8 @@ pub fn load_snippets(start_options: &StartOptions) -> Result<Vec<Snippet>> {
         }
     }
 
+    snippets.sort_unstable_by(|a, b| a.prefix.cmp(&b.prefix));
+
     Ok(snippets)
 }
 
@@ -169,7 +171,7 @@ pub fn load_snippets_from_path(
     Ok(snippets)
 }
 
-pub fn load_unicode_input_from_file(path: &std::path::PathBuf) -> Result<HashMap<String, String>> {
+pub fn load_unicode_input_from_file(path: &std::path::PathBuf) -> Result<BTreeMap<String, String>> {
     tracing::info!("Try load 'unicode input' config from: {path:?}");
 
     let content = std::fs::read_to_string(path)?;
@@ -188,12 +190,12 @@ pub fn load_unicode_input_from_file(path: &std::path::PathBuf) -> Result<HashMap
 
 pub fn load_unicode_input_from_path(
     snippets_path: &std::path::PathBuf,
-) -> Result<HashMap<String, String>> {
+) -> Result<BTreeMap<String, String>> {
     if snippets_path.is_file() {
         return load_unicode_input_from_file(snippets_path);
     }
 
-    let mut result = HashMap::new();
+    let mut result = BTreeMap::new();
     match std::fs::read_dir(snippets_path) {
         Ok(entries) => {
             for entry in entries {

tests/basic.rs

@@ -1,5 +1,5 @@
 use simple_completion_language_server::{ac_searcher, search, server, snippets, RopeReader};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use std::io::Read;
 
 use std::pin::Pin;
@@ -75,7 +75,7 @@ struct TestContext {
 impl TestContext {
     pub async fn new(
         snippets: Vec<snippets::Snippet>,
-        unicode_input: HashMap<String, String>,
+        unicode_input: BTreeMap<String, String>,
         home_dir: String,
     ) -> anyhow::Result<Self> {
         let (request_tx, rx) = mpsc::unbounded_channel::<String>();
@@ -227,7 +227,7 @@ fn words_search() -> anyhow::Result<()> {
 
 #[test_log::test(tokio::test)]
 async fn initialize() -> anyhow::Result<()> {
-    let mut context = TestContext::new(Vec::new(), HashMap::new(), String::new()).await?;
+    let mut context = TestContext::new(Vec::new(), BTreeMap::new(), String::new()).await?;
 
     let request = jsonrpc::Request::build("initialize")
         .id(1)
@@ -258,7 +258,7 @@ async fn initialize() -> anyhow::Result<()> {
 
 #[test_log::test(tokio::test)]
 async fn completion() -> anyhow::Result<()> {
-    let mut context = TestContext::new(Vec::new(), HashMap::new(), String::new()).await?;
+    let mut context = TestContext::new(Vec::new(), BTreeMap::new(), String::new()).await?;
     context.initialize().await?;
     context.send_all(&[
         r#"{"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"python","text":"hello\nhe","uri":"file:///tmp/main.py","version":0}}}"#,
@@ -295,7 +295,7 @@ async fn completion() -> anyhow::Result<()> {
 
 #[test_log::test(tokio::test)]
 async fn completion_by_quoted_word() -> anyhow::Result<()> {
-    let mut context = TestContext::new(Vec::new(), HashMap::new(), String::new()).await?;
+    let mut context = TestContext::new(Vec::new(), BTreeMap::new(), String::new()).await?;
     context.initialize().await?;
     context.send_all(&[
         r#"{"jsonrpc":"2.0","method":"textDocument/didOpen","params":{"textDocument":{"languageId":"python","text":"function(\"hello\")\nhe","uri":"file:///tmp/main.py","version":0}}}"#,
@@ -334,7 +334,7 @@ async fn snippets() -> anyhow::Result<()> {
                 description: None,
             },
         ],
-        HashMap::new(),
+        BTreeMap::new(),
         String::new(),
     )
     .await?;
@@ -374,7 +374,7 @@ async fn snippets_inline_by_word_tail() -> anyhow::Result<()> {
             body: "^2".to_string(),
             description: None,
         }],
-        HashMap::new(),
+        BTreeMap::new(),
         String::new(),
     )
     .await?;
@@ -428,7 +428,7 @@ async fn snippets_inline_by_word_tail() -> anyhow::Result<()> {
 async fn unicode_input() -> anyhow::Result<()> {
     let mut context = TestContext::new(
         Vec::new(),
-        HashMap::from_iter([
+        BTreeMap::from_iter([
             ("alpha".to_string(), "α".to_string()),
             ("betta".to_string(), "β".to_string()),
         ]),
@@ -484,7 +484,7 @@ async fn unicode_input() -> anyhow::Result<()> {
 async fn paths() -> anyhow::Result<()> {
     std::fs::create_dir_all("/tmp/scls-test/sub-folder")?;
 
-    let mut context = TestContext::new(Vec::new(), HashMap::new(), "/tmp".to_string()).await?;
+    let mut context = TestContext::new(Vec::new(), BTreeMap::new(), "/tmp".to_string()).await?;
     context.initialize().await?;
 
     let request = jsonrpc::Request::from_str(&serde_json::to_string(&serde_json::json!(
@@ -625,7 +625,7 @@ bibliography: "/tmp/scls-test-citation/test.bib" # could also be surrounded by b
 
     std::fs::write("/tmp/scls-test-citation/test.bib", bib)?;
 
-    let mut context = TestContext::new(Vec::new(), HashMap::new(), String::new()).await?;
+    let mut context = TestContext::new(Vec::new(), BTreeMap::new(), String::new()).await?;
     context.initialize().await?;
 
     let request = jsonrpc::Request::from_str(&serde_json::to_string(&serde_json::json!(