Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexandregv/norminette-vim
42 norminette (linter) for vim
https://github.com/alexandregv/norminette-vim
linter neovim vim
Last synced: about 2 months ago
JSON representation
42 norminette (linter) for vim
- Host: GitHub
- URL: https://github.com/alexandregv/norminette-vim
- Owner: alexandregv
- Created: 2020-11-08T19:33:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T21:29:34.000Z (8 months ago)
- Last Synced: 2024-08-04T22:17:06.026Z (5 months ago)
- Topics: linter, neovim, vim
- Language: Vim Script
- Homepage:
- Size: 90.8 KB
- Stars: 83
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-42 - norminette-vim - Displays norm errors directly inside Vim. (Tools / Editor Extensions)
README
# norminette-vim
42 norminette (linter) for vim. It shows norm errors directly in vim, no more switching between vim and norminette.
Supports both Norm version 2 and Norm version 3.
## Installation
norminette-vim needs [syntastic](https://github.com/vim-syntastic/syntastic) and the [norminette](https://github.com/42School/norminette) to work.
You will need a plugin manager to install syntastic and norminette-vim. I recommend [vim-plug](https://github.com/junegunn/vim-plug).
1. If you are not on a 42 mac, install the [norminette](https://github.com/42School/norminette).
2. Install syntastic and norminette-vim with your plugin manager. See exemple below.
With vim-plug, add this to the beginning of your `~/.vimrc` (or `~/.config/nvim/init.vim` for neovim):
```vim
call plug#begin()
Plug 'vim-syntastic/syntastic'
Plug 'alexandregv/norminette-vim'
call plug#end()
```
then restart vim and run `:PlugInstall`
3. Copy the [configuration](#configuration) to your `~/.vimrc` (or `~/.config/nvim/init.vim` for neovim). Note that **first line is mandatory**.
## Configuration
Here is the configuration I recommend. **You at least need the first line to enable the checker.**
```vim
" Enable norminette-vim (and gcc)
let g:syntastic_c_checkers = ['norminette', 'gcc']
let g:syntastic_aggregate_errors = 1
" Set the path to norminette (do no set if using norminette of 42 mac)
let g:syntastic_c_norminette_exec = 'norminette'
" Support headers (.h)
let g:c_syntax_for_h = 1
let g:syntastic_c_include_dirs = ['include', '../include', '../../include', 'libft', '../libft/include', '../../libft/include']
" Pass custom arguments to norminette (this one ignores 42header)
let g:syntastic_c_norminette_args = '-R CheckTopCommentHeader'
" Check errors when opening a file (disable to speed up startup time)
let g:syntastic_check_on_open = 1
" Enable error list
let g:syntastic_always_populate_loc_list = 1
" Automatically open error list
let g:syntastic_auto_loc_list = 1
" Skip check when closing
let g:syntastic_check_on_wq = 0
```
## Norm version
To select the Norm version (2 or 3), just set `g:syntastic_c_norminette_exec` to the right norminette path.
- For v2 ([42Paris/norminette](https://github.com/42Paris/norminette)), it is probably `~/.norminette/norminette.rb`.
- For v3 ([42School/norminette](https://github.com/42School/norminette)), `norminette` should be enough if you installed it correctly.
Make sure that the `norminette` executable is available in your PATH. Check it with `whereis norminette` and `type -a norminette`.
If not found, make sure that Python's bin directory is in your PATH. Get it with `python3 -m site` or `python -m site`.
## Usage
Open any `.c` file and you should see your norm errors (if any!).
You can open the error list with `:Errors`
## Don't want to bother with this syntastic/plugins stuff? Check this
Vim has a native feature (vim-compiler and quickfix) which gives almost the same result. It basically just lacks the (sweet) line indicators on the left side.
1. `git clone https://github.com/alexandregv/norminette-vim ~/.vim/pack/syntax/start/norminette-vim`
2. Open a `.c` file and run `:Norminette`
If needed, you can specify norminette path by adding `let g:norminette_exec = '~/.norminette/norminette.rb'` to your `~/.vimrc` (or `~/.config/nvim/init.vim` for neovim).
## See also
* [norminette-action](https://github.com/alexandregv/norminette-action) - GitHub Action (CI) to test norminette after each push, automatically.
* [norminette-action-demo](https://github.com/alexandregv/norminette-action-demo) - Demo repository for norminette-action.
* [norminette-docker](https://github.com/alexandregv/norminette-docker) - A docker image for norminette. Used by norminette-action.
All of these are compatible with Norm version 2 and 3.
## Stargazers over time
[](https://starchart.cc/alexandregv/norminette-vim)