chore: sarif test & docs

.github/workflows/busted.yml

@@ -28,6 +28,7 @@ jobs:
           luarocks install busted
           luarocks install lanes # required for parallel execution
           luarocks install luautf8 # required for decoder unit test
+          luarocks install dkjson  # required for decoder unit test
           luarocks install luasocket # required for profiler unit test
           luarocks install luacov-coveralls
 

README.md

@@ -115,7 +115,7 @@ Use the Luacheck issue tracker on GitHub to submit bugs, suggestions and questio
 
 ## Building and testing
 
-After the Luacheck repo is cloned and changes are made, run `luarocks make` (using `sudo` if necessary) from its root directory to install dev version of Luacheck. To run Luacheck using sources in current directory without installing it, run `lua -e 'package.path="./src/?.lua;./src/?/init.lua;"..package.path' bin/luacheck.lua ...`. To test Luacheck, ensure that you have [busted](http://olivinelabs.com/busted/), [luautf8](https://github.com/starwing/luautf8), and [luasocket](https://github.com/lunarmodules/luasocket) installed and run `busted`.
+After the Luacheck repo is cloned and changes are made, run `luarocks make` (using `sudo` if necessary) from its root directory to install dev version of Luacheck. To run Luacheck using sources in current directory without installing it, run `lua -e 'package.path="./src/?.lua;./src/?/init.lua;"..package.path' bin/luacheck.lua ...`. To test Luacheck, ensure that you have [busted](http://olivinelabs.com/busted/), [luautf8](https://github.com/starwing/luautf8), [dkjson](https://luarocks.org/modules/dhkolf/dkjson) and [luasocket](https://github.com/lunarmodules/luasocket) installed and run `busted`.
 
 ## Docker
 

docsrc/cli.rst

@@ -142,6 +142,7 @@ Option                                  Meaning
 
                                         * ``TAP`` - Test Anything Protocol formatter;
                                         * ``JUnit`` - JUnit XML formatter;
+                                        * ``Sarif`` - Static Analysis Results Interchange Format formatter;
                                         * ``visual_studio`` - MSBuild/Visual Studio aware formatter;
                                         * ``plain`` - simple warning-per-line formatter;
                                         * ``default`` - standard formatter.

spec/cli_spec.lua

@@ -1,3 +1,4 @@
+local json = require "dkjson"
 local utils = require "luacheck.utils"
 local multithreading = require "luacheck.multithreading"
 local helper = require "spec.helper"
@@ -979,6 +980,14 @@ not ok 8 spec/samples/python_code.lua:1:6: (E011) expected '=' near '__future__'
 ]], get_output "bad_file spec/samples/good_code.lua spec/samples/bad_code.lua spec/samples/python_code.lua --std=lua52 --formatter JUnit --no-config")
    end)
 
+   it("has built-in Sarif formatter", function()
+      local expect = [[
+{"runs":[{"tool":{"driver":{"version":"1.0.0","name":"luacheck","informationUri":"https://github.com/lunarmodules/luacheck"}},"results":[{"locations":[{"physicalLocation":{"artifactLocation":{"uri":"bad_file"}}}],"ruleId":"I/O error","level":"error","message":{"text":"luacheck : fatal error F1: couldn't check bad_file: couldn't read: No such file or directory"}},{"locations":[{"physicalLocation":{"region":{"startLine":3,"startColumn":16},"artifactLocation":{"uri":"spec/samples/bad_code.lua"}}}],"ruleId":"W211","level":"warning","message":{"text":"spec/samples/bad_code.lua:3:16: unused function 'helper'"}},{"locations":[{"physicalLocation":{"region":{"startLine":3,"startColumn":23},"artifactLocation":{"uri":"spec/samples/bad_code.lua"}}}],"ruleId":"W212","level":"warning","message":{"text":"spec/samples/bad_code.lua:3:23: unused variable length argument"}},{"locations":[{"physicalLocation":{"region":{"startLine":7,"startColumn":10},"artifactLocation":{"uri":"spec/samples/bad_code.lua"}}}],"ruleId":"W111","level":"warning","message":{"text":"spec/samples/bad_code.lua:7:10: setting non-standard global variable 'embrace'"}},{"locations":[{"physicalLocation":{"region":{"startLine":8,"startColumn":10},"artifactLocation":{"uri":"spec/samples/bad_code.lua"}}}],"ruleId":"W412","level":"warning","message":{"text":"spec/samples/bad_code.lua:8:10: variable 'opt' was previously defined as an argument on line 7"}},{"locations":[{"physicalLocation":{"region":{"startLine":9,"startColumn":11},"artifactLocation":{"uri":"spec/samples/bad_code.lua"}}}],"ruleId":"W113","level":"warning","message":{"text":"spec/samples/bad_code.lua:9:11: accessing undefined variable 'hepler'"}},{"locations":[{"physicalLocation":{"region":{"startLine":1,"startColumn":6},"artifactLocation":{"uri":"spec/samples/python_code.lua"}}}],"ruleId":"E011","level":"error","message":{"text":"spec/samples/python_code.lua:1:6: expected '=' near '__future__'"}}]}],"version":"2.1.0","$schema":"https://json.schemastore.org/sarif-2.1.0.json"}
+]]
+      local actual = get_output "bad_file spec/samples/good_code.lua spec/samples/bad_code.lua spec/samples/python_code.lua --std=lua52 --formatter Sarif --no-config"
+      assert.same(json.decode(expect), json.decode(actual))
+   end)
+
    it("has built-in Visual Studio aware formatter", function()
       assert.equal([[
 luacheck : fatal error F1: couldn't check bad_file: couldn't read: No such file or directory

src/luacheck/main.lua

@@ -244,6 +244,7 @@ Links:
       parser:option("--formatter" , "Use custom formatter. <formatter> must be a module name or one of:\n" ..
          "   TAP - Test Anything Protocol formatter;\n" ..
          "   JUnit - JUnit XML formatter;\n" ..
+         "   Sarif - Static Analysis Results Interchange Format formatter;\n" ..
          "   visual_studio - MSBuild/Visual Studio aware formatter;\n" ..
          "   plain - simple warning-per-line formatter;\n" ..
          "   default - standard formatter."),