Merge pull request #3461 from lyz-code/feat/add-yamlfixer

feat: add yamlfix fixer

autoload/ale/fix/registry.vim

@@ -110,6 +110,11 @@ let s:default_registry = {
 \       'suggested_filetypes': [],
 \       'description': 'Remove all trailing whitespace characters at the end of every line.',
 \   },
+\   'yamlfix': {
+\       'function': 'ale#fixers#yamlfix#Fix',
+\       'suggested_filetypes': ['yaml'],
+\       'description': 'Fix yaml files with yamlfix.',
+\   },
 \   'yapf': {
 \       'function': 'ale#fixers#yapf#Fix',
 \       'suggested_filetypes': ['python'],

autoload/ale/fixers/yamlfix.vim

@@ -0,0 +1,25 @@
+" Author: lyz-code
+" Description: Fixing yaml files with yamlfix.
+
+call ale#Set('yaml_yamlfix_executable', 'yamlfix')
+call ale#Set('yaml_yamlfix_options', '')
+call ale#Set('yaml_yamlfix_use_global', get(g:, 'ale_use_global_executables', 0))
+
+function! ale#fixers#yamlfix#Fix(buffer) abort
+    let l:options = ale#Var(a:buffer, 'yaml_yamlfix_options')
+
+    let l:executable = ale#python#FindExecutable(
+    \   a:buffer,
+    \   'yaml_yamlfix',
+    \   ['yamlfix'],
+    \)
+
+    if !executable(l:executable)
+        return 0
+    endif
+
+    return {
+    \   'command': ale#path#BufferCdString(a:buffer)
+    \   .   ale#Escape(l:executable) . (!empty(l:options) ? ' ' . l:options : '') . ' -',
+    \}
+endfunction

doc/ale-supported-languages-and-tools.txt

@@ -524,6 +524,7 @@ Notes:
 * YAML
   * `prettier`
   * `swaglint`
+  * `yamlfix`
   * `yamllint`
 * YANG
   * `yang-lsp`

doc/ale-yaml.txt

@@ -15,7 +15,6 @@ Install prettier either globally or locally: >
   npm install prettier -g  # global
   npm install prettier     # local
 <
-  
 ===============================================================================
 swaglint                                                    *ale-yaml-swaglint*
 
@@ -49,6 +48,43 @@ g:ale_yaml_swaglint_use_global                 *g:ale_yaml_swaglint_use_global*
 
   See |ale-integrations-local-executables|
 
+===============================================================================
+yamlfix                                                      *ale-yaml-yamlfix*
+
+Website: https://lyz-code.github.io/yamlfix
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install yamlfix: >
+
+  pip install yamlfix
+<
+
+Options
+-------------------------------------------------------------------------------
+g:ale_yaml_yamlfix_executable                   *g:ale_yaml_yamlfix_executable*
+                                                *b:ale_yaml_yamlfix_executable*
+  Type: |String|
+  Default: `'yamlfix'`
+
+  See |ale-integrations-local-executables|
+
+
+g:ale_yaml_yamlfix_options                         *g:ale_yaml_yamlfix_options*
+                                                   *b:ale_yaml_yamlfix_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass extra options to yamlfix.
+
+g:ale_yaml_yamlfix_use_global                   *g:ale_yaml_yamlfix_use_global*
+                                                *b:ale_yaml_yamlfix_use_global*
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
 
 ===============================================================================
 yamllint                                                    *ale-yaml-yamllint*

doc/ale.txt

@@ -2971,6 +2971,7 @@ documented in additional help files.
   yaml....................................|ale-yaml-options|
     prettier..............................|ale-yaml-prettier|
     swaglint..............................|ale-yaml-swaglint|
+    yamlfix...............................|ale-yaml-yamlfix|
     yamllint..............................|ale-yaml-yamllint|
   yang....................................|ale-yang-options|
     yang-lsp..............................|ale-yang-lsp|

supported-tools.md

@@ -533,6 +533,7 @@ formatting.
 * YAML
   * [prettier](https://github.com/prettier/prettier)
   * [swaglint](https://github.com/byCedric/swaglint)
+  * [yamlfix](https://lyz-code.github.io/yamlfix)
   * [yamllint](https://yamllint.readthedocs.io/)
 * YANG
   * [yang-lsp](https://github.com/theia-ide/yang-lsp)

test/fixers/test_yamlfix_fixer_callback.vader

@@ -0,0 +1,50 @@
+Before:
+  Save g:ale_python_yamlfix_executable
+  Save g:ale_python_yamlfix_options
+
+  " Use an invalid global executable, so we don't match it.
+  let g:ale_python_yamlfix_executable = 'xxxinvalid'
+  let g:ale_python_yamlfix_options = ''
+
+  call ale#test#SetDirectory('/testplugin/test/fixers')
+  silent cd ..
+  silent cd command_callback
+  let g:dir = getcwd()
+
+  let b:bin_dir = has('win32') ? 'Scripts' : 'bin'
+
+After:
+  Restore
+
+  unlet! b:bin_dir
+
+  call ale#test#RestoreDirectory()
+
+Execute(The yamlfix callback should return the correct default values):
+  AssertEqual
+  \ 0,
+  \ ale#fixers#yamlfix#Fix(bufnr(''))
+
+  silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.yaml')
+  AssertEqual
+  \ {
+  \   'command': ale#path#BufferCdString(bufnr(''))
+  \     . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yamlfix')) . ' -',
+  \ },
+  \ ale#fixers#yamlfix#Fix(bufnr(''))
+
+Execute(The yamlfix callback should respect custom options):
+  let g:ale_yaml_yamlfix_options = '--multi-line=3 --trailing-comma'
+
+  AssertEqual
+  \ 0,
+  \ ale#fixers#yamlfix#Fix(bufnr(''))
+
+  silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.yaml')
+  AssertEqual
+  \ {
+  \   'command': ale#path#BufferCdString(bufnr(''))
+  \     . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/yamlfix'))
+  \     . ' --multi-line=3 --trailing-comma -',
+  \ },
+  \ ale#fixers#yamlfix#Fix(bufnr(''))