WOLFRAM

Wolfram 语言与系统参考资料中心
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. This tutorial assumes that the codetoolsexamples repo is next to the codeinspector repo in your setup.
Wolfram Language code: codetoolsExamplesDir = FileNameJoin[{ParentDirectory[NotebookDirectory[], 5], "codetoolsexamples"}];
Wolfram Language code: PrependTo[$Path, codetoolsExamplesDir];
Wolfram Language code: CodeInspect[File["Collatz`"]]
Wolfram Language code: CodeInspectSummarize[File["Collatz`"], %, ConfidenceLevel -> 0.]
The linter has caught an accidental usage of the Span operator ;;. The code should be this:
Collatz[n_Integer]  := Prepend[Collatz[(3 n + 1)/2], n] /; OddQ[n] && n > 0;

Implicit Times

CodeInspectImplicitTimes[code]returns a list of implicit times in code
CodeInspectImplicitTimesSummarize[code]returns an inspection summary object

Finding implicit times in WL code.

Report uses of implicit multiplication. This is a source of bugs but it is hard to automatically determine whether it is incorrect.
Wolfram Language code: Needs["CodeInspector`ImplicitTimes`"]
Wolfram Language code: times = CodeInspectImplicitTimes[File["Collatz`"]];
Wolfram Language code: CodeInspectImplicitTimesSummarize["Collatz`", times]
The linter has caught an accidental use of implicit multiplication. The equal sign is missing in the usage message assignment. The code should be this:
Collatz::usage = "Collatz[n] gives a list of the iterates in the 3n+1 problem,
        starting from n. The conjecture is that this sequence always
        terminates."