This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Ameba LS

Language server for the Ameba linter for Crystal lang.

Supports reporting issues while typing, and correcting issues via code actions. Does not require ameba be installed.

Installation

Each release corresponds to an Ameba release.

Ameba LS	Ameba
0.2.0	1.7.0
0.1.0	1.6.4

The latest release can be downloaded from GitHub or built from source.

Homebrew

$ brew tap crystal-ameba/ameba
$ brew install ameba-ls

Build from source

$ git clone https://github.com/crystal-ameba/ameba-ls
$ cd ameba-ls
$ make
$ cp ./bin/ameba-ls ~/.local/bin # or somewhere else in PATH

Usage

Zed

The latest version of the Zed Crystal extension has support for ameba-ls if it's installed in PATH.

If you want to use the ameba-ls alone, use the following config:

{
  "languages": {
    "Crystal": {
      "language_servers": ["ameba-ls", "!crystalline"],
      "formatter": {
        "external": {
          "command": "crystal",
          "arguments": ["tool", "format", "-"],
        },
      },
      "format_on_save": "on",
    }
  }
}

Sublime Text

Install the Sublime LSP package and configure it to use ameba-ls:

{
  "clients": {
    "ameba-ls": {
      "command": [
        "ameba-ls"
      ],
      "selector": "source.crystal",
      "enabled": true,
    },
  },
}

Contributing

1. Fork it (https://github.com/crystal-ameba/ameba-ls/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Margret Riegert - creator and maintainer
• Sijawusz Pur Rahnama - contributor, maintainer