terryyin/lizard: A simple code complexity analyser without caring about the C/C++ header files or Java imports, supports most of the popular languages.

This also applies to JSX and TSX. Existing CCN scores can increase for functions that use defaults, which may cause them to exceed a configured CCN threshold.

Installation ------------

lizard.py can be used as a stand alone Python script, most functionalities are there. You can always use it without any installation. To acquire all the functionalities of lizard, you will need a proper install.

::

python lizard.py

If you want a proper install:

::

[sudo] pip install lizard

Or if you've got the source:

::

[sudo] python setup.py install --prefix=/path/to/installation/directory/

Usage -----

::

lizard [options] [PATH or FILE] [PATH] ...

Run for the code under current folder (recursively):

::

lizard

Exclude anything in the tests folder:

::

lizard mySource/ -x"./tests/*"

Use .gitignore file:

::

lizard mySource/

If there is a .gitignore file in the given path, lizard will automatically use it as an additional filter to exclude files that match the gitignore patterns. This is useful when you want to analyze only the tracked files in your git repository. To analyze all discovered source files regardless of .gitignore, use --no-gitignore:

::

lizard --no-gitignore mySource/

.. _options: .. _example-use:

Command-line reference ~~~~~~~~~~~~~~~~~~~~~~

Using lizard as Python module -----------------------------

You can also use lizard as a Python module in your code:

.. code:: python

>>> import lizard >>> i = lizard.analyze_file("../cpputest/tests/AllTests.cpp") >>> print i.__dict__ {'nloc': 9, 'function_list': [], 'filename': '../cpputest/tests/AllTests.cpp'} >>> print i.function_list[0].__dict__ {'cyclomatic_complexity': 1, 'token_count': 22, 'name': 'main', 'parameter_count': 2, 'nloc': 3, 'long_name': 'main( int ac , const char ** av )', 'start_line': 30}

You can also use source code string instead of file. But you need to provide a file name (to identify the language).

.. code:: python

>>> i = lizard.analyze_file.analyze_source_code("AllTests.cpp", "int foo(){}")

.. _generated-code: .. _code-duplicate-detector: .. _generate-a-tag-cloud-for-your-code: .. _cognitive-complexity: .. _whitelist: .. _options-in-comments:

Extensions and warning controls -------------------------------

Limitations -----------

Lizard requires syntactically correct code. Upon processing input with incorrect or unknown syntax:

• Lizard guarantees to terminate eventually (i.e., no forever loops, hangs)

• There is a chance of a combination of the following soft failures:

This approach makes the Lizard implementation simpler and more focused with partial parsers for various languages. Developers of Lizard attempt to minimize the possibility of soft failures. Hard failures are bugs in Lizard code, while soft failures are trade-offs or potential bugs.

In addition to asserting the correct code, Lizard may choose not to deal with some advanced or complicated language features:

• C/C++ digraphs and trigraphs are not recognized.
• C/C++ preprocessing or macro expansion is not performed.

• Some C++ complicated templates may cause confusion with matching angle brackets

Literatures Referring to Lizard -------------------------------

Lizard is often used in software related researches. If you used it to support your work, you may contact the lizard author to add your work in the following list.

• Software Quality in the ATLAS experiment at CERN, which refers to Lizard as one of the tools, has been published in the Journal of Physics: http://iopscience.iop.org/article/10.1088/1742-6596/898/7/072011

Lizard is also used as a plugin for fastlane to help check code complexity and submit xml report to sonar.