Once installed in Visual Studio Code, the Code Sight interface appears in a tabular view.
-
To see the Code Sight controls, click the sidebar icon that shows the Black Duck logo. - While the extension is active, the Code Sight panel appears at the left of the VS Code window. It displays various views that are described in more detail below:
- In the code editor, icons next to line numbers show Code Analysis (SAST) issues and other findings. A line of code that has an SAST issue is highlighted. When an SAST issue is highlighted, details about it display in their own editor tab.
SAST issue details
In the Editor, when you hover your mouse over an issue’s line of code, Code Sight displays a drop-down panel with a summary of the issues that were detected.
To see a more detailed description, click the issue’s entry in the LOCAL VIEW. Code Sight displays an “Issue Details” tab with a full description of the issue that was found.
LOCAL VIEW
The LOCAL VIEW displays issues found by scan engines installed locally on your system. You can use scan configurations to set up these scans: See Local View.
When you hover over LOCAL VIEW, Code Sight displays some icons that let you search and manage this view:
-
Click the Search Results icon to search items in this view’s list. -
Click the Sort Results icon to display a drop-down menu that lets you choose other criteria for sorting or filtering issues. Figure 6. Drop-down menu to choose a criterion in LOCAL VIEW
The sorting options don’t have a counterpart in the versions of Code Sight for other IDEs. You can use the search field at the top of this drop-down menu to find a sorting option quickly.
-
Click the Run Scan icon to run a new scan. -
Click the Open Scan Configuration icon to create, delete, or otherwise manage scan configurations.
TEAM VIEW
The TEAM VIEW displays issues found by scans that run on remote servers. Such scans can include Coverity Connect / Coverity on Polaris, Polaris, and Software Risk Manager.
When you hover over TEAM VIEW, Code Sight displays some icons that let you search and manage this view:
-
Click the Refresh remote results icon to update the current issues list. -
Click the Show Team View Filters icon to display issue filters for the currently active server. - Click the Sort Results icon to display a drop-down menu that lets you choose other criteria for sorting or filtering issues. Figure 8. Drop-down menu to choose a criterion in TEAM VIEW
The sorting options don’t have a counterpart in the versions of Code Sight for other IDEs. You can use the search field at the top of this drop-down menu to find a sorting option quickly.
- Click the Open Team View Configuration icon to open the Team View Configuration tab.
-
Click the Collapse All icon to collapse all issue entries that might have been expanded.
STATUS view
In the STATUS view in the left-hand side bar, shortcut icons help you view and manage the Scan Status panel and the Authentication pages.
-
Products and Licenses
Click to configure Black Duck scan engines. See Authenticating and installing: Products and Licenses panel.
-
Code Sight Settings
Click to display the Settings tab.
-
Edit Server Settings
Appears to the right when you hover over one of the server entries below the Server Connections label in the STATUS view. Click it to display the Authentication page, where you can change the server being used, the current Code Sight user, or both.
HELP view
The HELP view in the left-hand side bar provides a few useful links to web pages, and an Export Logs option.
- Export Logs
- Click the Export Logs text to display an Export Logs page with an Export Logs button that you can click to save a zipped file of the current scan logs.
Exporting logs can be helpful when you need to troubleshoot a problem by working with Black Duck Support. After export, you can attach the logs file to your Support request.