Add support for html-beautify (#2788)

* Add support for html-beautify
* Add html-beautify to the list of supported tools
* Update docs

autoload/ale/fix/registry.vim

@@ -350,6 +350,11 @@ let s:default_registry = {
 \       'suggested_filetypes': ['nix'],
 \       'description': 'A formatter for Nix code',
 \   },
+\   'html-beautify': {
+\       'function': 'ale#fixers#html_beautify#Fix',
+\       'suggested_filetypes': ['html', 'htmldjango'],
+\       'description': 'Fix HTML files with html-beautify.',
+\   },
 \}
 
 " Reset the function registry to the default entries.

autoload/ale/fixers/html_beautify.vim

@@ -0,0 +1,21 @@
+" Author: WhyNotHugo <hugo@barrera.io>
+" Description: Lint HTML files with html-beautify.
+"
+call ale#Set('html_beautify_executable', 'html-beautify')
+call ale#Set('html_beautify_use_global', get(g:, 'ale_use_global_executables', 0))
+call ale#Set('html_beautify_options', '')
+call ale#Set('html_beautify_change_directory', 1)
+
+function! ale#fixers#html_beautify#Fix(buffer) abort
+    let l:executable = ale#python#FindExecutable(
+    \   a:buffer,
+    \   'html_beautify',
+    \   ['html-beautify']
+    \)
+
+    let l:options = ale#Var(a:buffer, 'html_beautify_options')
+
+    return {
+    \   'command': ale#Escape(l:executable). ' ' . l:options . ' -',
+    \}
+endfunction

doc/ale-html.txt

@@ -9,6 +9,16 @@ fecs                                                            *ale-html-fecs*
 and both of them reads `./.fecsrc` as the default configuration file.
 See: |ale-javascript-fecs|.
 
+===============================================================================
+html-beautify                                               *ale-html-beautify*
+
+g:ale_html_beautify_options                       *g:ale_html_beautify_options*
+                                                  *b:ale_html_beautify_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to modify flags given to html-beautify.
+
 
 ===============================================================================
 htmlhint                                                    *ale-html-htmlhint*

doc/ale.txt

@@ -2293,6 +2293,7 @@ documented in additional help files.
     terraform-fmt.........................|ale-hcl-terraform-fmt|
   html....................................|ale-html-options|
     fecs..................................|ale-html-fecs|
+    html-beautify.........................|ale-html-beautify|
     htmlhint..............................|ale-html-htmlhint|
     tidy..................................|ale-html-tidy|
     prettier..............................|ale-html-prettier|

supported-tools.md

@@ -203,6 +203,7 @@ formatting.
 * HTML
   * [alex](https://github.com/wooorm/alex) :floppy_disk:
   * [fecs](http://fecs.baidu.com/)
+  * [html-beautify](https://beautifier.io/)
   * [HTMLHint](http://htmlhint.com/)
   * [prettier](https://github.com/prettier/prettier)
   * [proselint](http://proselint.com/)

test/fixers/test_html_beautify_fixer_callback.vader

@@ -0,0 +1,31 @@
+Before:
+  Save g:ale_html_beautify_executable
+  Save g:ale_html_beautify_options
+
+  let g:ale_html_beautify_options = ''
+
+  call ale#test#SetDirectory('/testplugin/test/fixers')
+  silent cd ..
+  silent cd command_callback
+  let g:dir = getcwd()
+
+After:
+  Restore
+
+  unlet! b:bin_dir
+
+  call ale#test#RestoreDirectory()
+
+Execute(The html-beautify callback should return 0 if html-beautify not found):
+  let g:ale_html_beautify_executable = 'xxxinvalidpath'
+  AssertEqual
+  \ 0,
+  \ ale#fixers#html_beautify#Fix(bufnr(''))
+
+Execute(The html-beautify callback should return the correct default command):
+  AssertEqual
+  \ {
+  \   'command': ale#Escape('html_beautify_paths/html-beautify')
+  \     . ' -'
+  \ },
+  \ ale#fixers#html_beautify#Fix(bufnr(''))