Add remark-lint for a markdown fixer (#2836)

This commit is contained in:
blyoa 2020-08-17 18:14:38 +09:00 committed by GitHub
parent 5c778e1ae7
commit d5c1d84230
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 53 additions and 0 deletions

View file

@ -365,6 +365,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['nix'],
\ 'description': 'A formatter for Nix code',
\ },
\ 'remark-lint': {
\ 'function': 'ale#fixers#remark_lint#Fix',
\ 'suggested_filetypes': ['markdown'],
\ 'description': 'Fix markdown files with remark-lint',
\ },
\ 'html-beautify': {
\ 'function': 'ale#fixers#html_beautify#Fix',
\ 'suggested_filetypes': ['html', 'htmldjango'],

View file

@ -0,0 +1,24 @@
" Author: blyoa <blyoa110@gmail.com>
" Description: Fixing files with remark-lint.
call ale#Set('markdown_remark_lint_executable', 'remark')
call ale#Set('markdown_remark_lint_use_global', get(g:, 'ale_use_global_executables', 0))
call ale#Set('markdown_remark_lint_options', '')
function! ale#fixers#remark_lint#GetExecutable(buffer) abort
return ale#node#FindExecutable(a:buffer, 'markdown_remark_lint', [
\ 'node_modules/remark-cli/cli.js',
\ 'node_modules/.bin/remark',
\])
endfunction
function! ale#fixers#remark_lint#Fix(buffer) abort
let l:executable = ale#fixers#remark_lint#GetExecutable(a:buffer)
let l:options = ale#Var(a:buffer, 'markdown_remark_lint_options')
return {
\ 'command': ale#Escape(l:executable)
\ . (!empty(l:options) ? ' ' . l:options : ''),
\}
endfunction

View file

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