uno-takashi/Lizard Runner

GitHub action to lint your python code with lizard

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pathFile or directory to run lizard onno./
cli_output_fileSpecify the name of the file in which to save the cli output results. nolizard_cli_output.txt
timeoutThe time until the lizard process timeout. Reduces the risk of consuming time without terminating when a command is invalid. In general, there is no need to change from the default time, but for very large projects, it should be set appropriately. no600
languageMultiple languages are accepted by separating them by a space.(ex."python cpp java") List the programming languages you want to analyze. if left empty, it'll search for all languages it knows. `lizard -l cpp -l java`searches for C++ and Java code. The available languages are: cpp, java, csharp, javascript, python, objectivec, ttcn, ruby, php, swift, scala, GDScript, go, lua, rust, typescript no""
verboseOutput in verbose mode (long function name)nofalse
CCNThreshold for cyclomatic complexity number warning. The default value is 15. Functions with CCN bigger than it will generate warning no15
input_fileget a list of filenames from the given file If None, this flag is not given to lizard. The default is set to None. no""
output_fileOutput file. The output format is inferred from the file extension (e.g. .html), unless it is explicitly specified (e.g. using --xml). If None, this flag is not given to lizard. The default is set to None. no""
lengthThreshold for maximum function length warning. The default value is 1000. Functions length bigger than it will generate warning no1000
argumentsLimit for number of parameters no100
warnings_onlyShow warnings only, using clang/gcc's warning format for printing warnings. http://clang.llvm.org/docs/UsersManual.html#cmdoption- fdiagnostics-format nofalse
warning_msvsShow warnings only, using Visual Studio's warning format for printing warnings. https://msdn.microsoft.com/en-us/library/yxkt8b26.aspx nofalse
ignore_warningsIf the number of warnings is equal or less than the number, the tool will exit normally; otherwise, it will generate error. If the number is negative, the tool exits normally regardless of the number of warnings. Useful in makefile for legacy code. If None, this flag is not given to lizard. The default is set to None. no0
excludeExclude files that match the pattern. * matches everything, ? matches any single character, "./folder/*" exclude everything in the folder recursively. Multiple patterns can be specified. Don't forget to add "" around the pattern. If None, this flag is not given to lizard. The default is set to None. no""
working_threadsnumber of working threads. The default lizard value is 1. Using a bigger number can fully utilize the CPU and often faster. no4
xmlGenerate XML in cppncss style instead of the tabular output. Useful to generate report in Jenkins server nofalse
htmlOutput HTML reportnofalse
modifiedalculate modified cyclomatic complexity number , which count a switch/case with multiple cases as one CCN. nofalse
extensionUser the extensions. The available extensions are: -Ecpre: it will ignore code in the #else branch. -Ewordcount: count word frequencies and generate tag cloud. -Eoutside: include the global code as one function. -EIgnoreAssert: to ignore all code in assert. -ENS: count nested control structures. If None, this flag is not given to lizard. The default is set to None. no""
sortSort the warning with field. The field can be nloc, cyclomatic_complexity, token_count, parameter_count, etc. Or an customized field. If None, this flag is not given to lizard. The default is set to None. no""
ThresholdSet the limit for a field. The field can be nloc, cyclomatic_complexity, token_count, parameter_count, etc. Or an customized file. Lizard will report warning if a function exceed the limit If None, this flag is not given to lizard. The default is set to None. nonloc=1000000
whitelistThe path and file name to the whitelist file. It's './whitelizard.txt' by default. Find more information in README. no./whitelizard.txt
optional_argsoptional_args unconditionally appends the given string to the end of the command. This option is not recommended. It is intended for limited use only when the given input variables alone do not accomplish the intended purpose. (e.g., "--something_flag input") no""
namedescription
result_output_path
cli_output_path