Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sigmapitech/ecsls
A language server on top of the Epitech coding style.
https://github.com/sigmapitech/ecsls
c coding-style epitech epitech-norme language-server linter neovim neovim-lsp nix
Last synced: 8 days ago
JSON representation
A language server on top of the Epitech coding style.
- Host: GitHub
- URL: https://github.com/sigmapitech/ecsls
- Owner: Sigmapitech
- Created: 2023-07-23T17:24:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-21T09:22:35.000Z (8 months ago)
- Last Synced: 2024-03-21T10:58:46.542Z (8 months ago)
- Topics: c, coding-style, epitech, epitech-norme, language-server, linter, neovim, neovim-lsp, nix
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [ECSLS] Epitech Coding Style Language Server
## Dependencies
### Nix
- Via Home Manager
Using Home Manager, you can use the github url as an input and pass it to your
nvim config.
Set `ecsls.packages.${conf.system}.default` within the `neovim.extraPackages`
option and refer to the neovim configuration after the dependencie section.
- Development packages are provided throught `nix develop`.
### Non-Nix
- Install `banana-vera` package if existing, or you compile it by
[yourself](https://gist.github.com/Sigmanificient/6ef147920ad057ef6bcd9b057f81d83d).
#### Epitech Ruleset
You need to clone the repo of the coding style of EPITECH. If you do not have
access to this repo, we are sorry but you will not be able to use this LSP, as
it is required for this to run, and is internal to Epitech.
```bash
git submodules update --init --recursive
```
> or
```bash
git clone https://github.com/Epitech/banana-coding-style-checker.git
```
#### Setup ECSLS python package
> (optional) Create a virtual environement (avoid polluting your python).
```py
python -m venv venv
```
> Install the package locally.
```bash
venv/bin/pip install .
```
> **Note**
> If you are using virtual environments, don't forget to add the correct path
> for the command in your LSP config
## Setup
To activate ecsls as a language server, you'll need to create a custom LSP in
your editor.
Once it is done, you'll need to create a `ecsls.toml` to tell the LSP to run
as it is quite heavy and can be annoying.
### Neovim
To activate the language server using
[lspconfig](https://github.com/neovim/nvim-lspconfig), use the following
configuration:
```lua
local lspconfig = require('lspconfig')
local configs = require('lspconfig.configs')
-- ↓ Epitech C Style Checker
if not configs.ecsls then
configs.ecsls = {
default_config = {
root_dir = lspconfig.util.root_pattern('.git', 'Makefile'),
cmd = { 'ecsls_run' },
autostart = true,
name = 'ecsls',
filetypes = { 'c', 'cpp', 'make' },
},
}
end
lspconfig.ecsls.setup({})
```
### Emacs
```lisp
(require 'lsp-mode)
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection '("ecsls_run"))
:major-modes '(c-mode c++-mode makefile-mode)
:server-id 'ecsls))
(add-hook 'c-mode-hook 'lsp)
(add-hook 'c++-mode-hook 'lsp)
(add-hook 'makefile-mode-hook 'lsp)
```
### Change the ruleset path
> **Note**
> If you want to use it globally, or if you wish to change the vera rules
> directory, change `path` in by using `init_options`.
```lua
init_options = {
path = '/your/custom/path',
},
```
> **Warning**
> The path must be valid and pointing to the epitech ruleset repository root.
```py
path = ".../ls/banana" # invalid
path = ".../ls/banana-coding-style-checker/vera" # invalid too
path = ".../ls/banana-coding-style-checker" # valid
```
To see a configuration in more details, consider reading
[my dotfiles](https://github.com/Sigmanificient/dotfiles/blob/master/home/nvim/default.nix).