Skip to content

Commit 6e43d31

Browse files
authored
Feature #25 / updated readme with gifs (#42)
* feature/ updated readme with gifs * feature/ updated readme with gifs * replaced gifs with mp4s due to file size * updated references to videos * restored gifs but of smaller size * restored gifs but of smaller size * spacing * removed videos * changed gifs for images and updated readme text * updated pictures * updated readme text
1 parent a3fd853 commit 6e43d31

5 files changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
11
# Cppcheck Official
22

3+
34
**Cppcheck Official** is a Visual Studio Code extension that runs [cppcheck](https://cppcheck.sourceforge.io/) against C/C++ files upon save and reports any warnings or errors in the Problems panel.
45

5-
## Features
6+
![Image showing example of problem tab with warnings output from cppcheck](./images/check_result2.png)
67

8+
## Features
79
- **On-save linting**: When you save a c/cpp file, `cppcheck` is automatically run on that file.
810
- **Per-file diagnostics**: Only diagnostics relevant to the saved file are displayed.
911
- **Configurable severity threshold**: Filter out messages below a chosen severity level (`info`, `warning`, or `error`).
1012
- **Diagnostic cleanup**: When you close a file, its diagnostics are automatically cleared.
11-
- **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.
13+
- **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. (See image below)
14+
15+
![Image showing where to set up project file](./images/project_file.png)
1216
- **Warning notes**: Display notes for warnings when those are available
1317
- **Dynamic config**: The extension supports running a script to generate arguments to pass to cppcheck. This can be done by including the command in the argument field wrapped with \@(), e.g. `--suppress=memleak:src/file1.cpp @(bash path/to/script.sh)`. The script is expected to output the argument(s) wrapped with \@(). If the script e.g. creates a project file it should print out as `@(--project=path/to/projectfile.json)`. This output will be spliced into the argument string as such: `--suppress=memleak:src/file1.cpp --project=path/to/projectfile.json`.
18+
19+
- **Warning suppression**: Warnings of a specific type can be supressed with the --supress flag in the argument field in the extension settings. The extension also supports inline suppression for specific lines of code, simply write `// cppcheck-supress >warning id<` (see image below).
20+
![Image showing how to suppress warnings](./images/suppression.png)
1421
## Requirements
1522

1623
**Cppcheck** must be installed on your system.
1724
- By default, this extension looks for `cppcheck` on the system PATH.
1825
- Alternatively, specify a custom executable path using the `cppcheck-official.path` setting.
1926

27+
![Image showing location of path setting](./images/cppcheck_path.png)
28+
2029
Examples of installing Cppcheck:
2130
- On Linux (Debian/Ubuntu), install via `sudo apt-get install cppcheck`.
2231
- On macOS with Homebrew: `brew install cppcheck`.

images/check_result2.png

154 KB
Loading

images/cppcheck_path.png

51.7 KB
Loading

images/project_file.png

45 KB
Loading

images/suppression.png

32.2 KB
Loading

0 commit comments

Comments
 (0)