Lint a Julia project

lint_me.jl

using LanguageServer, StaticLint, SymbolServer

path = abspath(ARGS[1])
root_file = if length(ARGS) > 1
    abspath(ARGS[2])
else
    joinpath(path, "src", string(basename(path), ".jl"))
end

s = LanguageServerInstance(Pipe(), stdout, path)
_, symbols = SymbolServer.getstore(s.symbol_server, path)
s.global_env.symbols = symbols
s.global_env.extended_methods = SymbolServer.collect_extended_methods(s.global_env.symbols)
s.global_env.project_deps = collect(keys(s.global_env.symbols))

f = StaticLint.loadfile(s, root_file)
StaticLint.semantic_pass(LanguageServer.getroot(f))

for doc in LanguageServer.getdocuments_value(s)
    StaticLint.check_all(LanguageServer.getcst(doc), s.lint_options, LanguageServer.getenv(doc, s))
    LanguageServer.mark_errors(doc, doc.diagnostics)
    foreach(println, doc.diagnostics)
end

Thanks for providing this. Is there an example file I can run this on to see some expected output for something detected?

$ cat test.jl                       
function foo(x, y)
    z = x
    for i in 1
        z += i
    end
    return z
end

$ julia lintme.jl . test.jl
LanguageServer.Diagnostic(LanguageServer.Range(LanguageServer.Position(0, 16), LanguageServer.Position(0, 17)), 4, "UnusedFunctionArgument", missing, "Julia", "An argument is included in a function signature but not used within its body.", [1], missing)
LanguageServer.Diagnostic(LanguageServer.Range(LanguageServer.Position(2, 8), LanguageServer.Position(2, 14)), 3, "IncorrectIterSpec", missing, "Julia", "A loop iterator has been used that will likely error.", missing, missing)

Thx for the script. I wondered, how I can use it for a whole project.

I guess I would include the main script, i.e. src/MyPackage.jl as root_file and the path is where the package is. However, I get e.g. ┌ Warning: Mocking not stored on disc and then LanguageServer.Diagnostic(LanguageServer.Range(LanguageServer.Position(89, 16), LanguageServer.Position(89, 21)), 2, missing, missing, "Julia", "Missing reference: @mock", missing, missing).