Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quantonganh/snippets-ls
A simple language server to just insert snippets into Helix (and other text editor, IDE)
https://github.com/quantonganh/snippets-ls
Last synced: 13 days ago
JSON representation
A simple language server to just insert snippets into Helix (and other text editor, IDE)
- Host: GitHub
- URL: https://github.com/quantonganh/snippets-ls
- Owner: quantonganh
- License: mit
- Created: 2023-07-31T11:10:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-17T13:56:33.000Z (5 months ago)
- Last Synced: 2024-08-01T22:53:11.739Z (3 months ago)
- Language: Go
- Size: 41 KB
- Stars: 47
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# snippets-ls
A simple language server to just insert snippets into Helix (and other text editor, IDE)
https://quantonganh.com/2023/07/31/create-snippets-in-helix
## Installation
You can download the latest binary from the [release page](https://github.com/quantonganh/snippets-ls/releases).
### Install via homebrew
```
brew install quantonganh/tap/snippets-ls
```
### Install via go
```sh
$ go install github.com/quantonganh/snippets-ls@latest
```
Don't forget to append `~/go/bin` to your `$PATH`.
### Install via [nix flake](https://nixos.wiki/wiki/Flakes) with [home-manager](https://nix-community.github.io/home-manager/index.xhtml#ch-nix-flakes)
Include the following in the `inputs` of `flake.nix` for `home-manager`:
```nix
inputs = {
# load compatible nixpkgs and home-mananger repos; they need not be 23.05
nixpkgs = { url = "github:nixos/nixpkgs/nixos-23.05"; };
home-manager = {
url = "github:nix-community/home-manager/release-23.05";
inputs.nixpkgs.follows = "nixpkgs";
};
# ...
snippets-ls = {
url = "github:quantonganh/snippets-ls";
inputs.nixpkgs.follows = "nixpkgs";
};
};
```
There are in turn many suitable ways to configure the `outputs` of `flake.nix`. One option is to use an overlay with something like
```nix
outputs = inputs:
with inputs;
let
system = "x86_64-linux"; # or other system as applicable (such as "x86_64-darwin")
pkgs = import nixpkgs {
inherit system;
overlays = [ pkgs_overlay ];
};
# ...
pkgs_overlay = final: prev: {
# ...
external.snippets-ls = snippets-ls.packages.${prev.system}.snippets-ls;
};
in {
homeConfigurations.YOUR-USER-NAME-HERE = home-manager.lib.homeManagerConfiguration {
inherit pkgs;
modules = [ ./home.nix ];
};
};
};
```
The use of this overlay allows you to call this packages with `pkgs.external.snippets-ls`, such the list of packages in `home.nix` can look something like
```nix
home.packages = with pkgs; [
# ...
external.snippets-ls
];
```
## Usage
Create your own snippets follow [VSCode syntax](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets). Alternatively, you can make use of [pre-existing](https://github.com/microsoft/vscode-go/blob/master/snippets/go.json) [sample](https://github.com/rust-lang/vscode-rust/blob/master/snippets/rust.json) for various programming languages.
Update your configuration file located at `~/.config/helix/languages.toml`:
```toml
[[language]]
name = "go"
formatter = { command = "goimports"}
language-servers = ["gopls", "snippets-ls"]
[language-server.snippets-ls]
command = "snippets-ls"
args = ["-config", "/Users/quantong/.config/helix/go-snippets.json"]
```
Subsequently, as you start working on your file, input a snippet prefix to observe the suggestion.
If it does not work, take a look at `~/.cache/helix/helix.log` for additional insights.