StaticLint.jl

StaticLint provides functionality similar to LanguageServer.jl by performing a single pass over a project's Syntax Tree (ST). The analysis process involves:

1. Linking the file tree: Mapping the project structure.
2. Scope marking: Identifying namespaces within the ST.
3. Binding marking: Identifying variable bindings (functions, instances, etc.).
4. Identifier linking: Connecting variable names to their relevant bindings.
5. Error detection: Marking possible errors within the ST (which relies on the previous four steps).

To perform a pass over a single EXPR (expression), you call a State object on the ST. This State requires an AbstractServer to determine how files are loaded and how packages are made available.

To use StaticLint.jl in a Julia project, add it via Pkg and then load it using using.

using Pkg
Pkg.add("StaticLint")

using StaticLint

DEPRECATION NOTICE

The functionality of StaticLint.jl has been moved to JuliaWorkspaces.jl. This package is no longer being maintained. Developers should transition to JuliaWorkspaces.jl for static code analysis capabilities.

An AbstractServer is required to manage files within a project and provide access to installed packages. Any implementation of an AbstractServer must support the following functions:

StaticLint.hasfile(server, path)::Bool
StaticLint.getfile(server, path)::AbstractFile
StaticLint.setfile(server, path, file)::AbstractFile
StaticLint.canloadfile(server, path)::Bool
StaticLint.loadfile(server, path)::AbstractFile
StaticLint.getsymbolserver(server)::Dict{String,SymbolServer.ModuleStore}

An AbstractFile represents a file within the server's scope and must support the following methods:

StaticLint.getpath(file)
StaticLint.getroot(file)
StaticLint.setroot(file, root)
StaticLint.getcst(file)
StaticLint.setcst(file, cst::CSTParser.EXPR)
StaticLint.getserver(file)
StaticLint.setserver(file, server::AbstractServer)
StaticLint.semantic_pass(file, target = nothing(optional))