WOLFRAM

Wolfram Language & System Documentation Center
CodeInspector Tutorial

CodeInspector Tutorial

The functions in the CodeInspector` context provide functionality for linting of WL code.

CodeInspect[code]returns a list of problems found in code
CodeInspectSummarize[code]returns an inspection summary object

Inspecting WL code.

First we need to load the CodeInspector` package
Wolfram Language code: Needs["CodeInspector`"]
See lints in a piece of WL code.
Wolfram Language code: str = "1+f[,2]";
Wolfram Language code: lints = CodeInspect[str]
Format the lints by lines
Wolfram Language code: CodeInspectSummarize[str, lints]
Next we lint code in an example package.
Wolfram Language code: paclet = PacletFind["CodeInspector"][[1]];
Wolfram Language code: buggyCollatz = paclet["AssetLocation", "Collatz"];
Wolfram Language code: CodeInspect[File[buggyCollatz]]
Wolfram Language code: CodeInspectSummarize[File[buggyCollatz], %, ConfidenceLevel -> 0.]
The linter has caught 2 strings accidentally being multiplied together with implicit Times, because the = is missing. The line should be this:
Collatz::usage = "Collatz[n] gives a list of the iterates in the 3n+1 problem,