From 2dd9790281b8fa8e31b664629ecbb06de46c5a70 Mon Sep 17 00:00:00 2001
From: Jon Parise <jon@indelible.org>
Date: Tue, 3 Aug 2021 17:29:07 -0700
Subject: [PATCH] Add a thriftcheck linter (#3852)

ThriftCheck (https://github.com/pinterest/thriftcheck) is a linter for
Thrift IDL files.
---
 ale_linters/thrift/thriftcheck.vim          | 46 +++++++++++++++++++++
 doc/ale-supported-languages-and-tools.txt   |  1 +
 doc/ale-thrift.txt                          | 19 +++++++++
 doc/ale.txt                                 |  1 +
 supported-tools.md                          |  1 +
 test/handler/test_thriftcheck_handler.vader | 28 +++++++++++++
 test/linter/test_thriftcheck.vader          | 21 ++++++++++
 7 files changed, 117 insertions(+)
 create mode 100644 ale_linters/thrift/thriftcheck.vim
 create mode 100644 test/handler/test_thriftcheck_handler.vader
 create mode 100644 test/linter/test_thriftcheck.vader

diff --git a/ale_linters/thrift/thriftcheck.vim b/ale_linters/thrift/thriftcheck.vim
new file mode 100644
index 00000000..7b8cbee1
--- /dev/null
+++ b/ale_linters/thrift/thriftcheck.vim
@@ -0,0 +1,46 @@
+" Author: Jon Parise <jon@indelible.org>
+
+call ale#Set('thrift_thriftcheck_executable', 'thriftcheck')
+call ale#Set('thrift_thriftcheck_options', '')
+
+function! ale_linters#thrift#thriftcheck#GetCommand(buffer) abort
+    return '%e'
+    \   . ale#Pad(ale#Var(a:buffer, 'thrift_thriftcheck_options'))
+    \   . ' --stdin-filename %s'
+    \   . ' %t'
+endfunction
+
+function! ale_linters#thrift#thriftcheck#Handle(buffer, lines) abort
+    " Matches lines like the following:
+    "
+    " file.thrift:1:1:error: "py" namespace must match "^idl\\." (namespace.pattern)
+    " file.thrift:3:5:warning: 64-bit integer constant -2147483649 may not work in all languages (int.64bit)
+    let l:pattern = '\v^[a-zA-Z]?:?[^:]+:(\d+):(\d+):(\l+): (.*) \((.*)\)$'
+
+    let l:output = []
+
+    for l:match in ale#util#GetMatches(a:lines, l:pattern)
+        if l:match[3] is# 'warning'
+            let l:type = 'W'
+        else
+            let l:type = 'E'
+        endif
+
+        call add(l:output, {
+        \   'lnum': l:match[1] + 0,
+        \   'col': l:match[2] + 0,
+        \   'type': l:type,
+        \   'text': l:match[4],
+        \   'code': l:match[5],
+        \})
+    endfor
+
+    return l:output
+endfunction
+
+call ale#linter#Define('thrift', {
+\   'name': 'thriftcheck',
+\   'executable': {b -> ale#Var(b, 'thrift_thriftcheck_executable')},
+\   'command': function('ale_linters#thrift#thriftcheck#GetCommand'),
+\   'callback': 'ale_linters#thrift#thriftcheck#Handle',
+\})
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index f3d7767c..eaad7411 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -533,6 +533,7 @@ Notes:
   * `write-good`
 * Thrift
   * `thrift`
+  * `thriftcheck`
 * TypeScript
   * `deno`
   * `eslint`
diff --git a/doc/ale-thrift.txt b/doc/ale-thrift.txt
index bb2ec058..810127b4 100644
--- a/doc/ale-thrift.txt
+++ b/doc/ale-thrift.txt
@@ -42,5 +42,24 @@ g:ale_thrift_thrift_options                       *g:ale_thrift_thrift_options*
   This variable can be changed to customize the additional command-line
   arguments that are passed to the thrift compiler.
 
+===============================================================================
+thriftcheck                                            *ale-thrift-thriftcheck*
+
+g:ale_thrift_thriftcheck_executable       *g:ale_thrift_thriftcheck_executable*
+                                          *b:ale_thrift_thriftcheck_executable*
+  Type: |String|
+  Default: `'thriftcheck'`
+
+  See |ale-integrations-local-executables|
+
+
+g:ale_thrift_thriftcheck_options             *g:ale_thrift_thriftcheck_options*
+                                             *b:ale_thrift_thriftcheck_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to customize the additional command-line
+  arguments that are passed to thriftcheck.
+
 ===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 62a14b02..2f77e7c1 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3053,6 +3053,7 @@ documented in additional help files.
     write-good............................|ale-text-write-good|
   thrift..................................|ale-thrift-options|
     thrift................................|ale-thrift-thrift|
+    thriftcheck...........................|ale-thrift-thriftcheck|
   typescript..............................|ale-typescript-options|
     deno..................................|ale-typescript-deno|
     eslint................................|ale-typescript-eslint|
diff --git a/supported-tools.md b/supported-tools.md
index dc66069f..5f36287e 100644
--- a/supported-tools.md
+++ b/supported-tools.md
@@ -542,6 +542,7 @@ formatting.
   * [write-good](https://github.com/btford/write-good) :warning:
 * Thrift
   * [thrift](http://thrift.apache.org/)
+  * [thriftcheck](https://github.com/pinterest/thriftcheck)
 * TypeScript
   * [deno](https://deno.land/)
   * [eslint](http://eslint.org/)
diff --git a/test/handler/test_thriftcheck_handler.vader b/test/handler/test_thriftcheck_handler.vader
new file mode 100644
index 00000000..efe62593
--- /dev/null
+++ b/test/handler/test_thriftcheck_handler.vader
@@ -0,0 +1,28 @@
+Before:
+    runtime ale_linters/thrift/thriftcheck.vim
+
+After:
+    call ale#linter#Reset()
+
+Execute(The thriftcheck handler should handle basic warnings and errors):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 1,
+  \     'col': 1,
+  \     'type': 'E',
+  \     'text': '"py" namespace must match "^idl\\."',
+  \     'code': 'namespace.pattern',
+  \   },
+  \   {
+  \     'lnum': 3,
+  \     'col': 5,
+  \     'type': 'W',
+  \     'text': '64-bit integer constant -2147483649 may not work in all languages',
+  \     'code': 'int.64bit',
+  \   },
+  \ ],
+  \ ale_linters#thrift#thriftcheck#Handle(1, [
+  \   'file.thrift:1:1:error: "py" namespace must match "^idl\\." (namespace.pattern)',
+  \   'file.thrift:3:5:warning: 64-bit integer constant -2147483649 may not work in all languages (int.64bit)',
+  \ ])
diff --git a/test/linter/test_thriftcheck.vader b/test/linter/test_thriftcheck.vader
new file mode 100644
index 00000000..0da3bd6d
--- /dev/null
+++ b/test/linter/test_thriftcheck.vader
@@ -0,0 +1,21 @@
+Before:
+  call ale#assert#SetUpLinterTest('thrift', 'thriftcheck')
+
+After:
+  call ale#assert#TearDownLinterTest()
+
+Execute(The default command should be correct):
+  AssertLinter 'thriftcheck', ale#Escape('thriftcheck')
+  \ . ' --stdin-filename %s %t'
+
+Execute(The executable should be configurable):
+  let b:ale_thrift_thriftcheck_executable = 'foobar'
+
+  AssertLinter 'foobar', ale#Escape('foobar')
+  \ . ' --stdin-filename %s %t'
+
+Execute(The string of options should be configurable):
+  let b:ale_thrift_thriftcheck_options = '--errors-only'
+
+  AssertLinter 'thriftcheck', ale#Escape('thriftcheck')
+  \ . ' --errors-only --stdin-filename %s %t'