Skip to content

Commit 162fa1b

Browse files
committed
changed gifs for images and updated readme text
1 parent 88d2301 commit 162fa1b

11 files changed

Lines changed: 6 additions & 5 deletions

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,29 @@
33

44
**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.
55

6-
![GIF showing example of warnings output from cppcheck](./images/check_result.gif)
6+
![Image showing example of problem tab with warnings output from cppcheck](./images/check_result2.png)
77

88
## Features
9-
109
- **On-save linting**: When you save a c/cpp file, `cppcheck` is automatically run on that file.
1110
- **Per-file diagnostics**: Only diagnostics relevant to the saved file are displayed.
1211
- **Configurable severity threshold**: Filter out messages below a chosen severity level (`info`, `warning`, or `error`).
1312
- **Diagnostic cleanup**: When you close a file, its diagnostics are automatically cleared.
1413
- **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 GIF below)
1514

16-
![GIF showing where to set up project file](./images/project_file.gif)
15+
![Image showing where to set up project file](./images/project_file.png)
1716
- **Warning notes**: Display notes for warnings when those are available
1817
- **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`.
1918

20-
![GIF showing how to suppress warnings](./images/suppression.gif)
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+
21+
![Image showing how to suppress warnings](./images/suppression.png)
2122
## Requirements
2223

2324
**Cppcheck** must be installed on your system.
2425
- By default, this extension looks for `cppcheck` on the system PATH.
2526
- Alternatively, specify a custom executable path using the `cppcheck-official.path` setting.
2627

27-
![GIF showing location of path setting](./images/cppcheck_path.gif)
28+
![Image showing location of path setting](./images/cppcheck_path.png)
2829

2930
Examples of installing Cppcheck:
3031
- On Linux (Debian/Ubuntu), install via `sudo apt-get install cppcheck`.

images/check_result.gif

-6.95 MB
Binary file not shown.

images/check_result.png

59.6 KB
Loading

images/check_result2.png

154 KB
Loading

images/cppcheck_path.gif

-2.11 MB
Binary file not shown.

images/cppcheck_path.png

51.7 KB
Loading

images/palette.png

-834 Bytes
Binary file not shown.

images/project_file.gif

-2.41 MB
Binary file not shown.

images/project_file.png

45 KB
Loading

images/suppression.gif

-5.13 MB
Binary file not shown.

0 commit comments

Comments
 (0)