COVLint (in English)

Coverity Connect server has a feature that highlights problematic lines in the source code. This feature has been implemented in Visual Studio Code. By using the Language Server Protocol, it also works in editors like Atom, Vim, and Emacs that support the language server (though this hasn't been confirmed).

• Coverity Connect Source Code Screen

• COVLint Source Code Screen

• COVLint Source Code Screen (Multiple Highlights)

COVLint displays the analysis results of the source code by Coverity in Visual Studio Code. The results are read from a CSV file obtained by the cov_snap script. cov_snap is a script that fetches the annotations of the source code registered on the Coverity Connect server.

Dependency note:

• Snapshot CSVs can be generated with the sanitized cov_snap_pub toolkit. Install it (e.g., pip install -e ../cov_snap_pub) and run cov_snap.py to produce the snapshot_id_*.csv files consumed by COVLint.
• The cov_snap script itself imports covautolib_3 (from the covautolib package). Make sure covautolib_pub is installed (e.g., pip install -e ../covautolib_pub) or PYTHONPATH is configured so that covautolib_3 can be resolved.

Procedure

1. Installing the COVLint Extension

There are two ways to install COVLint: from a VSIX package file or from the VSCode Extension Marketplace.

• Select extensions from the activity bar

1.1 Installation from VSIX Package File

• From the three-dot menu, select "Install from VSIX"

• Install the file covlint-X.Y.Z.vsix

• Installation is complete

• COVLint Extension

1.2 Installation from VSCode Extension Marketplace

• Enter covlint in the search box and click "Install"

• Installation is complete

2. Loading the CSV File

Load the snapshot CSV file obtained with cov_snap.

• Move to the folder where the snapshot is saved from VSCode's explorer and right-click to select the snapshot (you don't need to display the contents of the file with a left click)

• From the menu, select "Copy Path"

• Press Ctrl + Shift + p to open the command palette and select COVLint: open CSV file

• Paste the path of the copied snapshot CSV file into the input box

• Message when no input is made

• Message when loading is successful

• If loading fails, please retry

3. Displaying Annotations

• Move the folder and select the source code you are developing

• Lines with issues in the source code are underlined, so hover over them

  • Annotations will be displayed in a popup
  • A list of annotations will be displayed in the problem panel
  • Clicking on an issue will jump to the corresponding line

Notes

This was based on Microsoft's https://github.com/Microsoft/vscode-extension-samples lsp-sample and an article by @Ikuyadeu titled Language Server Protocol Development Tutorial.

---

• 2023/09/15 keides2 v0.0.1 First edition
• 2023/09/16 keides2 v0.0.2 Image replacement
• 2023/09/17 keides2 v0.0.3 Extension Marketplace support
• 2023/09/20 keides2 v0.1.0 webpack
• 2023/10/07 keides2 V0.2.0 Removed the uppercase character detection function for 3 or more characters.
• 2023/10/10 keides2 v0.3.0 The color of the wavy line, the level of the diagnosis result, and the icon change depending on the impact level: "high," "medium," and "low."
• 2023/10/13 keides2 v0.3.1 Added constraints when reading CSV files (files whose format is not snapshot_id_xxxx.csv will not be read).
• 2023/10/18 keides2 v0.3.2 Outputs an error when the return value type of the input box is undefined. (does not display an error dialog) The input box disappears when you move the focus, so "keep the input box open even if the focus moves to another part of the editor or to another window" (a usability improvement)
• 2023/11/06 keides2 v0.3.3 Supports cases where CSV file values include commas.
• 2023/11/14 keides2 v0.4.0 Added indication items "local effect" and "explanation".

---

COVLint (in Japanese)

Coverity Connectサーバーの特長の一つである問題のある行に指摘が付いたソースコード画面をVisual Studio Code上に実現しました。Language Server Protocol（言語サーバー）を利用していますので、言語サーバーの機能があるAtom、VimやEmacsなどのエディターで動作します（と言われていますが未確認です）。

• Coverity Connect ソースコード画面

• COVLint ソースコード画面

• COVLint ソースコード画面（指摘を複数表示）

COVLintは、Coverityが解析したソースコードの指摘結果を Visual Studio Code に表示します。 指摘結果は、スクリプトcov_snapが取得したCSVファイルから読み込みます。 cov_snapは、Coverity Connect サーバーに登録されているソースコードの指摘内容を取得するスクリプトです。

実施手順

1. COVLint拡張機能のインストール

COVLintは、VSIXパッケージファイルからインストールする方法と、VSCode拡張機能マーケットプレースからインストールする方法があります。

• アクティビティーバーから拡張機能を選択します

1.1 VSIXパッケージファイルからのインストール

• 3点メニューから「VSIXからインストール」を選択します

• ファイル「covlint-X.Y.Z.vsix」をインストールします

• インストール完了です

• 拡張機能 COVLint

1.2 VSCode拡張機能マーケットプレースからのインストール

• 検索窓にcovlintを入力し、「インストール」を押下げます

• インストール完了です

2. CSVファイルの読み込み

cov_snapで取得したスナップショットCSVファイルを読み込みます

依存関係:

• スナップショット CSV は公開リポジトリの cov_snap_pub に含まれる cov_snap.py で生成できます。pip install -e ../cov_snap_pub などで導入し、cov_snap.py を実行して snapshot_id_*.csv を作成後に COVLint に読み込ませてください。
• cov_snap スクリプトは covautolib パッケージの covautolib_3 に依存しています。事前に covautolib_pub をインストール (pip install -e ../covautolib_pub など) するか、PYTHONPATH を設定して covautolib_3 が解決できるようにしてください。

• VSCodeのエクスプローラーからスナップショットを保存しているフォルダに移動し、読み込みむスナップショットを右クリックで選択します（左クリックでファイルの中身を表示する必要はありません）

• メニューから「パスのコピー」を選択します

• Ctrl + Shift + pを押してコマンドパレットを開き、COVLint: open CSV fileを選択します

• 入力ボックスにコピーしたスナップショットCSVファイルのパスを貼り付けます

• 何も入力しなかったときのメッセージです

• 読み込みに成功したときのメッセージです

• 読み込みに失敗したときはリトライしてください

3. 指摘の表示

• フォルダを移動して開発中のソースコードを選択します

• ソースコードの問題のある行に波線が入っているのでマウスオーバーします

  • 指摘がポップアップ表示されます
  • 問題パネルに指摘の一覧が表示されます
  • 問題を左クリックすると該当行にジャンプします

備考

Microsoftのhttps://github.com/Microsoft/vscode-extension-samplesにあるlsp-sampleや、@Ikuyadeu 氏の記事 Language Server Protocol開発チュートリアル を参考にしました。

---

• 2023/09/15 keides2 v0.0.1 初版
• 2023/09/16 keides2 v0.0.2 図の差し替え
• 2023/09/17 keides2 v0.0.3 拡張機能マーケットプレース対応
• 2023/09/20 keides2 v0.1.0 webpack 対応。英文追加
• 2023/10/07 keides2 v0.2.0 ３文字以上の大文字検出をやめる
• 2023/10/10 keides2 v0.3.0 影響度「高」、「中」、「低」に対応し、波線の色と診断結果のレベルとアイコンを変える
• 2023/10/13 keides2 v0.3.1 CSVファイル読み込み時の制約を追加（書式が snapshot_id_xxxx.csv でないファイルを読み込まない）
• 2023/10/18 keides2 v0.3.2 入力ボックスの戻り値の型が、 undefined の時にエラーを出力する（エラーダイアログは出さない） フォーカスを移動すると入力ボックスが消えてしまうので、「フォーカスがエディタの他の部分や他のウィンドウに移動しても、入力ボックスを開いたままにする」（ユーザビリティ向上）
• 2023/11/06 keides2 v0.3.3 CSVファイルの値がコンマを含む場合に対応
• 2023/11/14 keides2 v0.4.0 指摘項目「ローカル効果」と「説明」を追加表示