feat(gitleaks): add support for gitleaks

Closes #4588

feat(gitleaks): add gitleaks linter for sh

fix(gitleaks): set lint_file for gitleaks

feat(gitleaks): add gitleaks support for multiple file-types

fix: add docs and support a few more filetypes

docs: add gitleaks docs

tests: add gitleaks handler & linter tests

docs(gitleaks): add missing docs

docs: fix toc & heading sorting

docs: fix toc issue

ale_linters/ada/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Ada files.
+
+call ale#handlers#gitleaks#DefineLinter('ada')

ale_linters/ansible/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for ansible files.
+
+call ale#handlers#gitleaks#DefineLinter('ansible')

ale_linters/asciidoc/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for ASCIIDoc files.
+
+call ale#handlers#gitleaks#DefineLinter('asciidoc')

ale_linters/c/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for C files.
+
+call ale#handlers#gitleaks#DefineLinter('c')

ale_linters/cpp/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for C++ files.
+
+call ale#handlers#gitleaks#DefineLinter('cpp')

ale_linters/cs/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for C# files.
+
+call ale#handlers#gitleaks#DefineLinter('cs')

ale_linters/css/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for CSS files.
+
+call ale#handlers#gitleaks#DefineLinter('css')

ale_linters/dockerfile/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Dockerfiles.
+
+call ale#handlers#gitleaks#DefineLinter('dockerfile')

ale_linters/elixir/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Elixir files.
+
+call ale#handlers#gitleaks#DefineLinter('elixir')

ale_linters/go/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Go files.
+
+call ale#handlers#gitleaks#DefineLinter('go')

ale_linters/haskell/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Haskell files.
+
+call ale#handlers#gitleaks#DefineLinter('haskell')

ale_linters/html/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for HTML files.
+
+call ale#handlers#gitleaks#DefineLinter('html')

ale_linters/java/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Java files.
+
+call ale#handlers#gitleaks#DefineLinter('java')

ale_linters/javascript/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for JavaScript files.
+
+call ale#handlers#gitleaks#DefineLinter('javascript')

ale_linters/json/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for JSON files.
+
+call ale#handlers#gitleaks#DefineLinter('json')

ale_linters/lua/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Lua files.
+
+call ale#handlers#gitleaks#DefineLinter('lua')

ale_linters/markdown/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Markdown files.
+
+call ale#handlers#gitleaks#DefineLinter('markdown')

ale_linters/php/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for PHP files.
+
+call ale#handlers#gitleaks#DefineLinter('php')

ale_linters/powershell/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for PowerShell files.
+
+call ale#handlers#gitleaks#DefineLinter('powershell')

ale_linters/python/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Python files.
+
+call ale#handlers#gitleaks#DefineLinter('python')

ale_linters/rego/gitleaks.vim

@@ -0,0 +1,4 @@
+scriptencoding utf-8
+" Description: gitleaks support for rego files.
+
+call ale#handlers#gitleaks#DefineLinter('rego')

ale_linters/rst/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for ReStructuredText files.
+
+call ale#handlers#gitleaks#DefineLinter('rst')

ale_linters/ruby/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Ruby files.
+
+call ale#handlers#gitleaks#DefineLinter('ruby')

ale_linters/rust/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Rust files.
+
+call ale#handlers#gitleaks#DefineLinter('rust')

ale_linters/scala/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Scala files.
+
+call ale#handlers#gitleaks#DefineLinter('scala')

ale_linters/sh/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for terraform files.
+
+call ale#handlers#gitleaks#DefineLinter('sh')

ale_linters/sql/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for SQL files.
+
+call ale#handlers#gitleaks#DefineLinter('sql')

ale_linters/swift/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Swift files.
+
+call ale#handlers#gitleaks#DefineLinter('swift')

ale_linters/terraform/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for terraform files.
+
+call ale#handlers#gitleaks#DefineLinter('terraform')

ale_linters/tex/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for TeX files.
+
+call ale#handlers#gitleaks#DefineLinter('tex')

ale_linters/texinfo/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for TeXInfo files.
+
+call ale#handlers#gitleaks#DefineLinter('texinfo')

ale_linters/text/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for general text files.
+
+call ale#handlers#gitleaks#DefineLinter('text')

ale_linters/typescript/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for TypeScript files.
+
+call ale#handlers#gitleaks#DefineLinter('typescript')

ale_linters/vim/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Vim files.
+
+call ale#handlers#gitleaks#DefineLinter('vim')

ale_linters/vue/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Vue files.
+
+call ale#handlers#gitleaks#DefineLinter('vue')

ale_linters/xhtml/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for XHTML files.
+
+call ale#handlers#gitleaks#DefineLinter('xhtml')

ale_linters/yaml/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for YAML files.
+
+call ale#handlers#gitleaks#DefineLinter('yaml')

ale_linters/zig/gitleaks.vim

@@ -0,0 +1,5 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: gitleaks support for Zig files.
+
+call ale#handlers#gitleaks#DefineLinter('zig')

autoload/ale/handlers/gitleaks.vim

@@ -0,0 +1,49 @@
+scriptencoding utf-8
+" Author: Peter Benjamin <https://github.com/pbnj>
+" Description: Define a handler function for gitleaks
+
+call ale#Set('gitleaks_executable', 'gitleaks')
+call ale#Set('gitleaks_options', '')
+
+function! ale#handlers#gitleaks#GetCommand(buffer) abort
+ return '%e'
+ \  . ' detect --no-git --no-color --no-banner --redact --verbose --source=%s'
+ \  . ale#Pad(ale#Var(a:buffer, 'gitleaks_options'))
+endfunction
+
+function! ale#handlers#gitleaks#Handle(buffer, lines) abort
+ " Look for lines like the following:
+ "
+ " Finding: ACCESS_KEY_ID=REDACTED
+ " Secret: REDACTED
+ " RuleID: generic-api-key
+ " Entropy: 3.546594
+ " File: tmp/env
+ " Line: 1
+ " Fingerprint: tmp/env:generic-api-key:1
+ let l:pattern = '\v^Fingerprint: .*:(.*):(\d+)$'
+ let l:output = []
+
+ for l:match in ale#util#GetMatches(a:lines, l:pattern)
+ call add(l:output, {
+ \  'lnum': l:match[2] + 0,
+ \  'text': l:match[1],
+ \  'type': 'E',
+ \})
+ endfor
+
+ return l:output
+endfunction
+
+function! ale#handlers#gitleaks#DefineLinter(filetype) abort
+ call ale#Set('gitleaks_executable', 'gitleaks')
+ call ale#Set('gitleaks_options', '')
+
+ call ale#linter#Define(a:filetype, {
+ \  'name': 'gitleaks',
+ \  'executable': {b -> ale#Var(b, 'gitleaks_executable')},
+ \  'command': function('ale#handlers#gitleaks#GetCommand'),
+ \  'callback': 'ale#handlers#gitleaks#Handle',
+ \  'lint_file': 1,
+ \})
+endfunction

doc/ale-ada.txt

@@ -7,6 +7,7 @@ cspell *ale-ada-cspell*
 
 See |ale-cspell-options|
 
+
 ===============================================================================
 gcc *ale-ada-gcc*
 
@@ -26,6 +27,12 @@ g:ale_ada_gcc_options *g:ale_ada_gcc_options*
  This variable can be set to pass additional options to gcc.
 
 
+===============================================================================
+gitleaks *ale-ada-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 gnatpp *ale-ada-gnatpp*
 

doc/ale-ansible.txt

@@ -2,20 +2,26 @@
 ALE Ansible Integration *ale-ansible-options*
 
 ===============================================================================
-ansible-language-server *ale-ansible-language-server*
+gitleaks  *ale-ansible-gitleaks*
 
+See |ale-gitleaks-options|
 
-g:ale_ansible_language_server_executable *g:ale_ansible_language_server*
- *b:ale_ansible_language_server*
+
+===============================================================================
+ansible-language-server *ale-ansible-language-server*
+
+
+g:ale_ansible_language_server_executable *g:ale_ansible_language_server*
+ *b:ale_ansible_language_server*
 
  Type: |String|
  Default: 'ansible-language-server'
 
  Variable can be used to modify the executable used for ansible language server.
 
 
-g:ale_ansible_language_server_config  *g:ale_ansible_language_server_config*
-  *b:ale_ansible_language_server_config*
+g:ale_ansible_language_server_config *g:ale_ansible_language_server_config*
+ *b:ale_ansible_language_server_config*
 
  Type: |Dictionary|
  Default: '{}'

doc/ale-asciidoc.txt

@@ -8,6 +8,12 @@ cspell *ale-asciidoc-cspell*
 See |ale-cspell-options|
 
 
+===============================================================================
+gitleaks *ale-asciidoc-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 write-good *ale-asciidoc-write-good*
 

doc/ale-c.txt

@@ -428,6 +428,12 @@ g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity*
  error. This setting also applies to flawfinder for c++.
 
 
+===============================================================================
+gitleaks *ale-c-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 uncrustify *ale-c-uncrustify*
 

doc/ale-cpp.txt

@@ -391,6 +391,12 @@ g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder*
  This variable can be used to pass extra options into the flawfinder command.
 
 
+===============================================================================
+gitleaks *ale-cpp-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 uncrustify *ale-cpp-uncrustify*
 

doc/ale-cs.txt

@@ -136,6 +136,12 @@ g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options*
  fixer.
 
 
+===============================================================================
+gitleaks *ale-cs-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 mcs *ale-cs-mcs*
 

doc/ale-dockerfile.txt

@@ -56,6 +56,12 @@ dprint *ale-dockerfile-dprint*
 See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
 
 
+===============================================================================
+gitleaks *ale-dockerfile-gitleaks*
+
+See |ale-gitleaks-options|
+
+
 ===============================================================================
 hadolint *ale-dockerfile-hadolint*