Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add htmlbeautifier support #4751

Merged
merged 1 commit into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions autoload/ale/fix/registry.vim
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['html', 'htmldjango'],
\ 'description': 'Fix HTML files with html-beautify from js-beautify.',
\ },
\ 'htmlbeautifier': {
\ 'function': 'ale#fixers#htmlbeautifier#Fix',
\ 'suggested_filetypes': ['eruby'],
\ 'description': 'Fix ERB files with htmlbeautifier gem.',
\ },
\ 'lua-format': {
\ 'function': 'ale#fixers#lua_format#Fix',
\ 'suggested_filetypes': ['lua'],
Expand Down
13 changes: 13 additions & 0 deletions autoload/ale/fixers/htmlbeautifier.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
" Author: Arash Mousavi <arash-m>
" Description: Support for HTML Beautifier https://github.com/threedaymonk/htmlbeautifier

call ale#Set('eruby_htmlbeautifier_executable', 'htmlbeautifier')

function! ale#fixers#htmlbeautifier#Fix(buffer) abort
let l:executable = ale#Var(a:buffer, 'eruby_htmlbeautifier_executable')

return {
\ 'command': ale#Escape(l:executable) . ' %t',
\ 'read_temporary_file': 1,
\}
endfunction
13 changes: 13 additions & 0 deletions doc/ale-eruby.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ There are four linters for `eruby` files:
- `erblint`
- `erubis`
- `erubi`
- `htmlbeautifier`
- `ruumba`

`erb` is in the Ruby standard library and is mostly universal. `erubis` is the
Expand Down Expand Up @@ -47,6 +48,18 @@ g:ale_eruby_erblint_options *g:ale_ruby_erblint_options*
This variable can be change to modify flags given to erblint.


===============================================================================
htmlbeautifier *ale-eruby-htmlbeautifier*

g:ale_eruby_htmlbeautifier_executable *g:ale_eruby_htmlbeautifier_executable*
*b:ale_eruby_htmlbeautifier_executable*
Type: |String|
Default: `'htmlbeautifier'`

Override the invoked htmlbeautifier binary. This is useful for running
htmlbeautifier from binstubs or a bundle.


===============================================================================
ruumba *ale-eruby-ruumba*

Expand Down
1 change: 1 addition & 0 deletions doc/ale-supported-languages-and-tools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ Notes:
* `erblint`
* `erubi`
* `erubis`
* `htmlbeautifier`
* `ruumba`
* Erlang
* `SyntaxErl`
Expand Down
1 change: 1 addition & 0 deletions doc/ale.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3020,6 +3020,7 @@ documented in additional help files.
eruby...................................|ale-eruby-options|
erb-formatter.........................|ale-eruby-erbformatter|
erblint...............................|ale-eruby-erblint|
htmlbeautifier........................|ale-eruby-htmlbeautifier|
ruumba................................|ale-eruby-ruumba|
fish....................................|ale-fish-options|
fish_indent...........................|ale-fish-fish_indent|
Expand Down
1 change: 1 addition & 0 deletions supported-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ formatting.
* [erblint](https://github.com/Shopify/erb-lint)
* [erubi](https://github.com/jeremyevans/erubi)
* [erubis](https://github.com/kwatch/erubis)
* [htmlbeautifier](https://github.com/threedaymonk/htmlbeautifier)
* [ruumba](https://github.com/ericqweinstein/ruumba)
* Erlang
* [SyntaxErl](https://github.com/ten0s/syntaxerl)
Expand Down
19 changes: 19 additions & 0 deletions test/fixers/test_htmlbeautifier_fixer_callback.vader
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Before:
call ale#assert#SetUpFixerTest('eruby', 'htmlbeautifier')

After:
call ale#assert#TearDownFixerTest()

Execute(The htmlbeautifier callback should return the correct default values):
AssertFixer {
\ 'command': ale#Escape('htmlbeautifier') . ' %t',
\ 'read_temporary_file': 1,
\}

Execute(The htmlbeautifier callback should allow custom htmlbeautifier executables):
let g:ale_eruby_htmlbeautifier_executable = 'foo/bar'

AssertFixer {
\ 'command': ale#Escape('foo/bar') . ' %t',
\ 'read_temporary_file': 1,
\}