This package executes lizard cyclomatic complexity tooling in Atom Editor This package is basically an plugin for Linter. It uses lizard tool to show the cyclomatic complexity in atom.
The lizard linter analyzes functions for
- cyclomatic complexity.
- the number of number of parameters
- the line number of function without comments
- the token number
On file save the tool will run automatically in the background and if a threshold is exceeded a warning will be shown in the editor. For each of them an own warning threshold can be defined in the settings.
The following languages are supported: c, cpp, c#, GDScript, GoLang, Java, JavaScript, Lua, ObjectiveC, PHP, Python, Ruby, Rust, Scala, SWIFT.
It is possible to ignore certain analysis by setting the threshold value to 0. Then no warning will be raised. It is possible to ignore certain files or even file extension by the settings.
An info view is available it can be opened by pressing Ctrl-Alt-j. It shows your current file analysis in a table.
The cyclomatic complexity number is basically the number of decisions in the source code. The higher the number the more complex and the more tests you need to verify the function. E.g. a cyclomatic complexity of 3 would require at least 3 tests to verify the function.
The linter shall help you to keep your functions slim and less complex and easy to test.
The lizard tool itself is not part of this package. For details about lizard tool and how to install it please refer to https://github.com/terryyin/lizard.
The lizard-linter package can be installed either by using the ATOM GUI
go to Preferences > Install and search for lizard-inter or by:
$ apm install lizard-linter
lizard-linter is released under the MIT license. For details please check the LICENSE.md file.