Add alejandra for nix (#4435)

- Fixes https://github.com/dense-analysis/ale/issues/4434
This commit is contained in:
Nathan Henrie 2023-02-07 01:24:52 -07:00 committed by GitHub
parent 45a3e3f574
commit e1ae009bac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 63 additions and 0 deletions

View File

@ -7,6 +7,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['python'],
\ 'description': 'Add blank lines before control statements.',
\ },
\ 'alejandra': {
\ 'function': 'ale#fixers#alejandra#Fix',
\ 'suggested_filetypes': ['nix'],
\ 'description': 'The Uncompromising Nix Code Formatter',
\ },
\ 'align_help_tags': {
\ 'function': 'ale#fixers#help#AlignTags',
\ 'suggested_filetypes': ['help'],

View File

@ -0,0 +1,13 @@
call ale#Set('nix_alejandra_executable', 'alejandra')
call ale#Set('nix_alejandra_options', '')
function! ale#fixers#alejandra#Fix(buffer) abort
let l:executable = ale#Var(a:buffer, 'nix_alejandra_executable')
let l:options = ale#Var(a:buffer, 'nix_alejandra_options')
return {
\ 'command': ale#Escape(l:executable)
\ . (empty(l:options) ? '' : ' ' . l:options)
\ . ' -- -'
\}
endfunction

View File

@ -2,6 +2,24 @@
ALE Nix Integration *ale-nix-options*
===============================================================================
alejandra *ale-nix-alejandra*
g:ale_nix_alejandra_executable *g:ale_nix_alejandra_executable*
*b:ale_nix_alejandra_executable*
Type: |String|
Default: `'alejandra'`
This variable sets the executable used for alejandra.
g:ale_nix_alejandra_options *g:ale_nix_alejandra_options*
*b:ale_nix_alejandra_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the alejandra fixer.
===============================================================================
nixfmt *ale-nix-nixfmt*

View File

@ -378,6 +378,7 @@ Notes:
* `nimlsp`
* `nimpretty`
* nix
* `alejandra`
* `nix-instantiate`
* `nixfmt`
* `nixpkgs-fmt`

View File

@ -3094,6 +3094,7 @@ documented in additional help files.
nimlsp................................|ale-nim-nimlsp|
nimpretty.............................|ale-nim-nimpretty|
nix.....................................|ale-nix-options|
alejandra.............................|ale-nix-alejandra|
nixfmt................................|ale-nix-nixfmt|
nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
statix................................|ale-nix-statix|

View File

@ -387,6 +387,7 @@ formatting.
* [nimlsp](https://github.com/PMunch/nimlsp)
* nimpretty
* nix
* [alejandra](https://github.com/kamadorueda/alejandra)
* [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate)
* [nixfmt](https://github.com/serokell/nixfmt)
* [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)

View File

@ -0,0 +1,24 @@
Before:
Save g:ale_nix_alejandra_executable
Save g:ale_nix_alejandra_options
After:
Restore
Execute(The alejandra callback should return the correct default values):
AssertEqual
\ {
\ 'command': ale#Escape('alejandra') . ' -- -'
\ },
\ ale#fixers#alejandra#Fix(bufnr(''))
Execute(The alejandra executable and options should be configurable):
let g:ale_nix_alejandra_executable = '/path/to/alejandra'
let g:ale_nix_alejandra_options = '-q'
AssertEqual
\ {
\ 'command': ale#Escape('/path/to/alejandra')
\ . ' -q -- -',
\ },
\ ale#fixers#alejandra#Fix(bufnr(''))