Rename language server ID to "settings-sync"

ARCHITECTURE.md

@@ -40,15 +40,15 @@ On any command that requires interaction with Github:
 
 - use the Zed user-level `settings.json` file
   - check if it's present; if not, exit with an error message
-  - attempt to deserialize the config file into the same Config struct that is used in the LSP server backend ("/lsp/settings_sync/initialization_options" json path)
+  - attempt to deserialize the config file into the same Config struct that is used in the LSP server backend ("/lsp/settings-sync/initialization_options" json path)
 
 - Commands:
   - `load`
     - enumerate all files with a `.json` extension in the Gist
     - load them from the Gist and store under the user settings dir (Zed's `paths` crate)
     - if the file being loaded exists, ask a confirmation to overwrite it
     - `-f/--force` option to overwrite without any confirmation
-    - if a file is `settings.json` file, then overwrite "/lsp/settings_sync/initialization_options/github_token" JSON path in it with the current value of this node from the config file
+    - if a file is `settings.json` file, then overwrite "/lsp/settings-sync/initialization_options/github_token" JSON path in it with the current value of this node from the config file
   - `help`
     - help message generated by Clap
 

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "zed-settings-sync"
 description = "A Zed editor extension for syncing settings files to a remote storage (currently, GitHub)"
-version = "0.0.1-alpha.5"
+version = "0.0.1-alpha.6"
 edition = "2024"
 license-file = "LICENSE.txt"
 repository = "https://github.com/vittorius/zed-settings-sync"

README.md

@@ -27,7 +27,7 @@ Until then, you can use the [dev installation mode](#dev-extension-installation)
 ```jsonc
 {
   "lsp": {
-    "settings_sync": {
+    "settings-sync": {
       "initialization_options": {
         "github_token": "gho_my-shiny-token",
         "gist_id": "deadbeefdeadbeefdeadbeefdeadbeef"
@@ -83,7 +83,7 @@ Another approach could be swapping the keymap entries for <kbd>zed: open setting
 
 ## Troubleshooting
 
-- Open LSP logs (<kbd>dev: open language server logs</kbd>), find `settings_sync` LSP server instance running for the specific settings file, and inspect its log
+- Open LSP logs (<kbd>dev: open language server logs</kbd>), find `settings-sync` LSP server instance running for the specific settings file, and inspect its log
 - File an [issue](https://github.com/vittorius/zed-settings-sync/issues/new) on Github
 
 ## Development

cli/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "zed-settings-sync-cli"
-description = "A CLI tool for Zed editor settings_sync extension"
-version = "0.0.1-alpha.5"
+description = "A CLI tool for Zed editor settings-sync extension"
+version = "0.0.1-alpha.6"
 edition = "2024"
 
 [lints]

common/src/config.rs

@@ -48,9 +48,9 @@ impl Config {
             .ok_or(anyhow!("Settings file is empty"))?;
         let config = from_value(
             zed_settings
-                .pointer("/lsp/settings_sync/initialization_options") // TODO: make this pointer key shared among crates of this package
+                .pointer("/lsp/settings-sync/initialization_options") // TODO: make this pointer key shared among crates of this package
                 .ok_or(anyhow!(
-                    "Missing lsp.settings_sync.initialization_options key in settings tree"
+                    "Missing lsp.settings-sync.initialization_options key in settings tree"
                 ))?
                 .clone(),
         )?;
@@ -144,7 +144,7 @@ mod tests {
             r#"
             {
                 "lsp": {
-                    "settings_sync": {
+                    "settings-sync": {
                         "initialization_options": {
                             "github_token": "your_github_token",
                             "gist_id": "your_gist_id"
@@ -195,7 +195,7 @@ mod tests {
 
         assert_eq!(
             config.unwrap_err().to_string(),
-            "Missing lsp.settings_sync.initialization_options key in settings tree"
+            "Missing lsp.settings-sync.initialization_options key in settings tree"
         );
 
         Ok(())
@@ -209,7 +209,7 @@ mod tests {
 
         assert_eq!(
             config.unwrap_err().to_string(),
-            "Missing lsp.settings_sync.initialization_options key in settings tree"
+            "Missing lsp.settings-sync.initialization_options key in settings tree"
         );
 
         Ok(())
@@ -222,7 +222,7 @@ mod tests {
             r#"
             {
               "lsp": {
-                "settings_sync": {}
+                "settings-sync": {}
               }
             }"#,
         )?;
@@ -231,7 +231,7 @@ mod tests {
 
         assert_eq!(
             config.unwrap_err().to_string(),
-            "Missing lsp.settings_sync.initialization_options key in settings tree"
+            "Missing lsp.settings-sync.initialization_options key in settings tree"
         );
 
         Ok(())
@@ -243,7 +243,7 @@ mod tests {
             r#"
             {
               "lsp": {
-                "settings_sync": {
+                "settings-sync": {
                   "initialization_options": {}
                 }
               }
@@ -263,7 +263,7 @@ mod tests {
             r#"
             {
               "lsp": {
-                "settings_sync": {
+                "settings-sync": {
                   "initialization_options": {
                     "gist_id": "1234567890abcdef"
                   }

common/src/sync/client/github_client.rs

@@ -144,13 +144,13 @@ fn set_github_token_config_value(root: &CstRootNode, value: String) -> Result<()
         .ok_or(Error::InvalidConfig(
             r#"Missing "lsp" configuration object"#.to_string(),
         ))?
-        .get("settings_sync")
+        .get("settings-sync")
         .ok_or(Error::InvalidConfig(
-            r#"Missing "settings_sync" key"#.to_string(),
+            r#"Missing "settings-sync" key"#.to_string(),
         ))?
         .object_value()
         .ok_or(Error::InvalidConfig(
-            r#"Missing "settings_sync" configuration object"#.to_string(),
+            r#"Missing "settings-sync" configuration object"#.to_string(),
         ))?
         .get("initialization_options")
         .ok_or(Error::InvalidConfig(

extension.toml

@@ -1,15 +1,15 @@
 id = "settings-sync"
 name = "Settings Sync"
-version = "0.0.1-alpha.5"
+version = "0.0.1-alpha.6"
 schema_version = 1
 authors = ["Viktor Zahorodnii <post.vittorius@gmail.com>"]
 description = "Never again be afraid of losing your precious Zed configuration"
 repository = "https://github.com/vittorius/zed-settings-sync"
 
-[language_servers.settings_sync]
+[language_servers.settings-sync]
 name = "Settings Sync LSP"
 languages = ["JSON", "JSONC"]
 
-[language_servers.settings_sync.language_ids]
+[language_servers.settings-sync.language_ids]
 "JSON" = "json"
 "JSONC" = "jsonc"

lsp/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "zed-settings-sync-lsp"
-description = "An LSP server for Zed editor settings_sync extension"
-version = "0.0.1-alpha.5"
+description = "An LSP server for Zed editor settings-sync extension"
+version = "0.0.1-alpha.6"
 edition = "2024"
 
 [lints]