https://github.com/septias/garnix

Yet another language server and parser for the Nix language
https://github.com/septias/garnix

lsp nix

Last synced: 12 days ago
JSON representation

Yet another language server and parser for the Nix language

• Host: GitHub
• URL: https://github.com/septias/garnix
• Owner: Septias
• License: mit
• Created: 2024-01-20T11:02:55.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T01:02:03.000Z (about 2 months ago)
• Last Synced: 2024-12-10T02:07:10.587Z (about 1 month ago)
• Topics: lsp, nix
• Language: Rust
• Homepage:
• Size: 293 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Garnix

**Garnix** is another **parser** and **language server** for the Nix programming language. It's theoretical foundation is the SimpleSub [Lionel Parreaux: The simple essence of Subtyping] algorithm which is much stronger than normal HM-style type inferce.

### Structure

This project is a mono repository and contains the parser, inference algorithm and language server in three respective folders:

| Folder | Content |

| ------ | ------- |

| parser | The **parser** folder contains the parser for the nix language. It is capable of parsing all modern nix language features (no deprecated let-bindings) but needs extensive randomised testing to verify. |

|infer | The **infer** folder contains the type inference algorithm capable of infering principal types for the nix language.

|lsp| The **lsp** folder contains the language server which wraps the inference library to bring type hints and error reporting too the user.

### Theoretical foundation

The repository is related to the Bachelor Thesis of Sebastian Klähn at []. It contains a discussion about the current state of developer toolings in the nix ecosystem, a thorough language definition and the theoretical background for the type inference algorithm and it's drawbacks.

### Development

This project uses common development guidlines. To contribut PRs have to be made against this repository that comply to the cargo format and clippy guidlines. Tests also have to run through.

This project uses the nightly rust compiler wich can be run by adding `+stable` to cargo or by setting the default for a given directory.

```

cargo +nightly run

```

```

rustup override set nightly

```

### Using the language server

After compiling the project in release or debug mode, the language server binary `lsp` can be found in the `target` directory.

By setting the binary as language server, garnix can be used in IDEs. For VScode it might look like this:

```json

// settings.json

{

  "nix.serverPath": "home/user/garnix/target/release/lsp",

}

```

#### Testing

The parser and inference module have extensive tests in the respective `tests` subfolders. These tests can be used to test new implementations and learn more about the capabiliets of the current project.