diff --git a/Cargo.lock b/Cargo.lock index c6b19f8..1f8d582 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -907,7 +907,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d" [[package]] -name = "wakatime-lsp" +name = "wakatime-ls" version = "0.1.1" dependencies = [ "serde_json", diff --git a/Cargo.toml b/Cargo.toml index 68a514c..1976595 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,11 @@ [package] -name = "wakatime-lsp" +name = "wakatime-ls" version = "0.1.1" edition = "2021" -description = "A dead-simple LSP around wakatime-cli to send code tracking heartbeats" -repository = "https://github.com/mrnossiom/wakatime-lsp" -keywords = ["lsp", "wakatime"] +description = "A dead-simple language server around wakatime-cli to send code tracking heartbeats" +repository = "https://github.com/mrnossiom/wakatime-ls" +keywords = ["wakatime", "language-server", "lsp"] categories = ["development-tools"] license = "CECILL-2.1" diff --git a/README.md b/README.md index 1890931..8016110 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Wakatime LSP +# Wakatime language server

-A dead-simple LSP around wakatime-cli to send code tracking heartbeats +A dead-simple language server around wakatime-cli to send code tracking heartbeats

@@ -9,15 +9,15 @@ A dead-simple LSP around wakatime-cli to send code tracking heartbe Cachix Cache - - Time spent on wakatime-lsp + + Time spent on wakatime-ls Join support Discord

-I made this LSP wrapper implementation around `wakatime-cli` because I wanted support for WakaTime in [Helix](https://github.com/helix-editor/helix). That said, it's should be compatible with every LSP implementations. +I made this language server wrapper implementation around `wakatime-cli` because I wanted support for WakaTime in [Helix](https://github.com/helix-editor/helix). That said, it's should be compatible with every LSP implementations. ## Installation @@ -27,7 +27,7 @@ I made this LSP wrapper implementation around `wakatime-cli` because I wanted su Install from repository with cargo: ```sh -cargo install --git https://github.com/mrnossiom/wakatime-lsp +cargo install --git https://github.com/mrnossiom/wakatime-ls ``` I don't plan on publishing pre-v1 versions on `crates.io`. @@ -37,14 +37,14 @@ I don't plan on publishing pre-v1 versions on `crates.io`.
With nix flakes
-A `flake.nix` is available which means that you can use `github:mrnossiom/wakatime-lsp` as a flake identifier. That way you can: +A `flake.nix` is available which means that you can use `github:mrnossiom/wakatime-ls` as a flake identifier. That way you can: - import this repository in your flake inputs ```nix { - wakatime-lsp.url = "github:mrnossiom/wakatime-lsp"; - wakatime-lsp.inputs.nixpkgs.follows = "nixpkgs"; + wakatime-ls.url = "github:mrnossiom/wakatime-ls"; + wakatime-ls.inputs.nixpkgs.follows = "nixpkgs"; } ``` @@ -52,20 +52,20 @@ A `flake.nix` is available which means that you can use `github:mrnossiom/wakati - use with `nix shell` for temporary testing - e.g. `nix shell github:mrnossiom/wakatime-lsp` + e.g. `nix shell github:mrnossiom/wakatime-ls` - use with `nix profile` for imperative installation - e.g. `nix profile install github:mrnossiom/wakatime-lsp` + e.g. `nix profile install github:mrnossiom/wakatime-ls` -Package is reachable through `packages.${system}.default` or `packages.${system}.wakatime-lsp`. +Package is reachable through `packages.${system}.default` or `packages.${system}.wakatime-ls`.
Download binary from GitHub releases
-Find the latest `wakatime-lsp` release on GitHub [here](https://github.com/mrnossiom/wakatime-lsp/releases). +Find the latest `wakatime-ls` release on GitHub [here](https://github.com/mrnossiom/wakatime-ls/releases). You may download the compressed tarball corresponding to your OS. @@ -78,7 +78,7 @@ For non-nixOS setups, you will also need `wakatime-cli` in path which you can do ## Configuration -Currently `wakatime-lsp` is not configurable cause it's more of a simple `wakatime-cli` wrapper which itself is configurable with [`$WAKATIME_HOME/.wakatime.cfg`](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#ini-config-file). +Currently `wakatime-ls` is not configurable cause it's more of a simple `wakatime-cli` wrapper which itself is configurable with [`$WAKATIME_HOME/.wakatime.cfg`](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#ini-config-file). Required configuration is to set your [WakaTime api key](https://wakatime.com/settings/api-key) in `$WAKATIME_HOME/.wakatime.cfg`, like so: @@ -93,13 +93,13 @@ It might be already filled if you've used another wakatime plugin in the past. ### Helix -You can add `wakatime-lsp` to your `languages.toml` configuration. Though, it's currently possible to add global LSPs, you can add `wakatime` for significant languages. Adding global LSPs is blocking on [Helix's new config system](https://github.com/helix-editor/helix/pull/9318). +You can add `wakatime-ls` to your `languages.toml` configuration. Though, it's currently possible to add global language servers, you can add `wakatime` for significant languages. Adding global language servers is blocking on [Helix's new config system](https://github.com/helix-editor/helix/pull/9318). e.g. ```toml [language-server.wakatime] -command = "wakatime-lsp" +command = "wakatime-ls" [[language]] name = "markdown" diff --git a/flake.nix b/flake.nix index 77a93e6..f186fc5 100644 --- a/flake.nix +++ b/flake.nix @@ -31,12 +31,12 @@ formatter = forAllPkgs (pkgs: pkgs.nixpkgs-fmt); packages = forAllPkgs (pkgs: rec { - default = wakatime-lsp; - wakatime-lsp = pkgs.callPackage ./package.nix { inherit gitignore; }; + default = wakatime-ls; + wakatime-ls = pkgs.callPackage ./package.nix { inherit gitignore; }; }); apps = forAllSystems (system: rec { - default = wakatime-lsp; - wakatime-lsp = mkApp (pkgs.getExe self.packages.${system}.app); + default = wakatime-ls; + wakatime-ls = mkApp (pkgs.getExe self.packages.${system}.app); }); devShells = forAllPkgs (pkgs: diff --git a/package.nix b/package.nix index 0069b91..62a67cc 100644 --- a/package.nix +++ b/package.nix @@ -26,13 +26,13 @@ rustPlatform.buildRustPackage { buildInputs = [ ]; postFixup = '' - wrapProgram $out/bin/wakatime-lsp \ + wrapProgram $out/bin/wakatime-ls \ --suffix PATH : ${makeBinPath [ wakatime ]} ''; meta = { inherit (cargoTOML.package) description homepage license; maintainers = [ "mrnossiom" ]; - mainProgram = "wakatime-lsp"; + mainProgram = "wakatime-ls"; }; } diff --git a/src/main.rs b/src/main.rs index f81d101..2156bdd 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,4 +1,4 @@ -//! Wakatime LSP +//! Wakatime LS // TODO: check options for additional ideas @@ -39,7 +39,7 @@ struct Backend { /// Interface for sending LSP notifications to the client client: Client, - /// Editor and LSP user agent for `wakatime-cli` + /// Editor and LS user agent for `wakatime-cli` user_agent: RwLock, } @@ -228,7 +228,7 @@ fn tracing_panic_hook(panic_info: &PanicInfo) { async fn main() { panic::set_hook(Box::new(tracing_panic_hook)); - let file_appender = tracing_appender::rolling::never("/tmp", "wakatime-lsp.log"); + let file_appender = tracing_appender::rolling::never("/tmp", "wakatime-ls.log"); let (non_blocking, _guard) = tracing_appender::non_blocking(file_appender); tracing_subscriber::fmt() .with_writer(non_blocking)