Skip to content

README.md

Latest commit

 

History

History
38 lines (28 loc) · 2.95 KB

README.md

File metadata and controls

38 lines (28 loc) · 2.95 KB

Cppcheck Official

Cppcheck Official is a Visual Studio Code extension that runs cppcheck against C/C++ files upon save and reports any warnings or errors in the Problems panel.

Features

  • On-save linting: When you save a c/cpp file, cppcheck is automatically run on that file.
  • Per-file diagnostics: Only diagnostics relevant to the saved file are displayed.
  • Configurable severity threshold: Filter out messages below a chosen severity level (info, warning, or error).
  • Diagnostic cleanup: When you close a file, its diagnostics are automatically cleared.
  • Project file support: You can feed your project file to cppcheck through the --project flag in the cppcheck-official.arguments field in the extension settings.
  • Warning notes: Display notes for warnings when those are available
  • Dynamic config: The extension can run scripts that outputs arguments to be used. This can be done by wrapping the argument with ${}, then specifying the language to run the script with as well as the path to the script, e.g. --project=${bash path/to/script.sh}. The extension expects the script to output the value to set the argument to wrapped with ${}, so with the argument --project=${bash path/to/script.sh} the script will be run and expected to create a compile_commands.json file whose path will be output as such: ${path/to/compile_commands.json}.

Requirements

Cppcheck must be installed on your system.

  • By default, this extension looks for cppcheck on the system PATH.
  • Alternatively, specify a custom executable path using the cppcheck-official.path setting.

Examples of installing Cppcheck:

  • On Linux (Debian/Ubuntu), install via sudo apt-get install cppcheck.
  • On macOS with Homebrew: brew install cppcheck.
  • On Windows, install from cppcheck's website.

Extension Settings

This extension contributes the following settings under cppcheck-official.*:

  • cppcheck-official.enable: (boolean) Enable or disable the extension.
  • cppcheck-official.minSeverity: (string) Minimum severity to report (info, warning, or error). info shows style, performance, portability and information messages.
  • cppcheck-official.arguments: (string) Additional command line arguments to pass to cppcheck.
  • cppcheck-official.path: (string) Path to the cppcheck executable. If left empty, cppcheck from the system PATH is used. Supports paths relative to workspace folder on the formats ./RELATIVE_PATH, ../RELATIVE_PATH or ${workspaceFolder}/RELATIVE_PATH.

Reporting Issues

Please submit any issues or feature requests via the GitHub Issues page.

Acknowledgements

This plugin is forked from the plugin cppcheck-lite by Justus Rijke (https://github.com/JustusRijke/Cppcheck-Lite).