From d5c1d842307a4c916905d5160544cfe152a16ee0 Mon Sep 17 00:00:00 2001
From: blyoa <blyoa@users.noreply.github.com>
Date: Mon, 17 Aug 2020 18:14:38 +0900
Subject: [PATCH] Add remark-lint for a markdown fixer (#2836)

---
 autoload/ale/fix/registry.vim                 |  5 ++++
 autoload/ale/fixers/remark_lint.vim           | 24 +++++++++++++++++++
 .../test_remark_lint_fixer_callback.vader     | 24 +++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 autoload/ale/fixers/remark_lint.vim
 create mode 100644 test/fixers/test_remark_lint_fixer_callback.vader

diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim
index 02b02699..94476ca9 100644
--- a/autoload/ale/fix/registry.vim
+++ b/autoload/ale/fix/registry.vim
@@ -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'],
diff --git a/autoload/ale/fixers/remark_lint.vim b/autoload/ale/fixers/remark_lint.vim
new file mode 100644
index 00000000..3ce442f3
--- /dev/null
+++ b/autoload/ale/fixers/remark_lint.vim
@@ -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
+
diff --git a/test/fixers/test_remark_lint_fixer_callback.vader b/test/fixers/test_remark_lint_fixer_callback.vader
new file mode 100644
index 00000000..5e2e342d
--- /dev/null
+++ b/test/fixers/test_remark_lint_fixer_callback.vader
@@ -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(''))