Statick

Statick makes running static analysis and linting tools easier for all your projects. Each static analysis tool has strengths and weaknesses. Best practices recommend running multiple tools to get the best results. Statick has plugins that interface with a large number of static analysis and linting tools, allowing you to run a single tool to get all the results at once.

Many tools are known for generating a large number of false positives so Statick provides multiple ways to add exceptions to suppress false positives. The types of warnings to generate is highly dependent on your specific project, and Statick makes it easy to run each tool with custom flags to tailor the tools for the issues you care about. Once the results are ready, Statick provides multiple output formats. The results can be printed to the screen, or sent to a continuous integration tool like Jenkins.

Statick is a plugin-based tool with an explicit goal to support external, optionally proprietary, tools and reporting mechanisms.

Table of Contents

• Statick
  • Table of Contents
  • Installation
  • Basic Usage
  • Concepts
    • Discovery
    • Tools
    • Reporting
  • Basic Configuration
    • Levels
    • Profiles
    • Exceptions
    • Timings
  • Advanced Installation
  • Existing Plugins
    • Discovery Plugins
    • Tool Plugins
    • Reporting Plugins
    • External Plugins
  • Customization
    • User Paths
    • Custom Profile
    • Custom Configuration
    • Custom Cppcheck Configuration
    • Custom CMake Flags
    • Custom Clang Format Configuration
  • Custom Plugins
  • Examples
  • ROS Workspaces
  • Releases
  • Troubleshooting
    • Make Tool Plugin
    • CMake Discovery Plugin
  • Contributing
    • Tests
    • Mypy
    • Formatting
  • Original Author

Installation

Statick requires Python 3 to run, but can be used to analyze Python 2 projects, among many other languages.

The recommended install method is to create a Python virtual environment and install there. Getting the Python venv tool is operating system-specific. On Ubuntu Linux use sudo apt-get install python3-venv. Activating a Python virtual environment is also operating system-specific. The example command below is for Linux systems, but it will be similar for other operating systems.

python3 -m venv venv
. venv/bin/activate
pip install statick

For local development you can clone this repository, activate the virtual environment, then do a local install.

cd statick-clone-directory
pip install -e .

You will also need to install any tools you want to use. Some tools are installed with Statick if you install via pip. Other tools can be installed using a method supported by your operating system. For example, on Ubuntu Linux if you want to use the clang-tidy tool plugin you can install the tool with apt.

sudo apt-get install clang-tidy

If you want to install a custom version of Statick you can install from a git repository. Options are detailed from [PyPA][pip-git-install] documentation. Stack Overflow has a discussion about [installing a git branch][pip-install-git-repo-branch]. The general idea is to install from a git repository with an optional branch or commit hash. Use one of the following commands from the activated Python virtual environment.

pip install git+https://github.com/user/statick.git
pip install git+https://github.com/user/statick.git@branch-name
pip install git+https://github.com/user/statick.git@hash

Basic Usage

statick