# OpenSCA-VSCode-plugin

**Repository Path**: XmirrorSecurity/OpenSCA-VSCode-plugin

## Basic Information

- **Project Name**: OpenSCA-VSCode-plugin
- **Description**: VS Code平台的OpenSCA Xcheck插件，让代码更安全
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://opensca.xmirror.cn/
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 4
- **Created**: 2023-09-05
- **Last Updated**: 2025-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
	<img alt="logo" src="https://opensca.xmirror.cn/docs/img/OpenSCAlogo.png">
</p>
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">OpenSCA Xcheck</h1>
<h4 align="center">VS Code平台的OpenSCA Xcheck插件，让代码更安全</h4>
<p align="center">
	<a href="https://github.com/XmirrorSecurity/OpenSCA-intellij-plugin/blob/master/LICENSE"><img src="https://img.shields.io/github/license/XmirrorSecurity/OpenSCA-intellij-plugin?style=flat-square"></a>
	<!-- <a href="https://github.com/XmirrorSecurity/OpenSCA-intellij-plugin/releases"><img src="https://img.shields.io/github/v/release/XmirrorSecurity/OpenSCA-intellij-plugin?style=flat-square"></a> -->
</p>

---

## 项目介绍

[Xcheck](https://marketplace.visualstudio.com/items?itemName=xmirror.opensca)是基于VS Code平台的OpenSCA插件。Xcheck能对当前项目进行代码质量评估，并在可视化界面中展示评估结果。评估结果包括漏洞和有漏洞的组件的统计数、具体组件信息和相关漏洞信息。

## 安装插件

**安装方法一**：在[适配的VS Code](https://code.visualstudio.com/)中通过应用商店安装（推荐）

在VS Code中左边栏打开扩展->扩展的搜索框中输入“OpenSCA Xcheck”，点击“Install”

<img src="https://opensca.xmirror.cn/docs/img/vscode_01.jpg" alt="xcheck_market" />

**安装方法二**：在[OpenSCA平台](https://opensca.xmirror.cn/pages/plug-in)下载插件安装

- 从OpenSCA平台下载 “OpenSCA-Xcheck.vsix”；
- 打开VS Code，依次操作：左边栏打开扩展->扩展顶栏的更多操作->“从VSIX安装”->找到并安装“OpenSCA-Xcheck.vsix”；

**安装方法三**：[下载源码](https://github.com/XmirrorSecurity/)自行编译安装

- 环境要求：

  - node v18及以上版本
  - 系统支持MacOS、Windows、Linux

- 从[gitee](https://gitee.com/XmirrorSecurity/OpenSCA-VSCode-plugin)或[github](https://github.com/XmirrorSecurity/OpenSCA-VSCode-plugin/)下载源码

* 全局安装vsce

  ```
  npm install --global @vscode/vsce
  ```

* 执行打包命令

  ```
  vsce package
  ```

## 使用插件

### 插件功能

- 开始检测：点击操作栏的“Run”，开始检测当前项目内的组件漏洞风险情况；
- 停止检测：点击操作栏的“Stop”，停止检测当前项目内的组件漏洞风险情况；
- 清除检测结果：点击操作栏的“Clean”，清除当前项目的检测结果；
- 连接配置：点击操作栏的“Test”按钮，配置平台Url及Token信息，点击“测试连接”按钮可测试连接配置是否正确，连接成功后就可以开始检测啦；
- 设置：点击操作栏的“Setting”，查看OpenSCA Xcheck相关设置信息。
- 使用说明：点击操作栏的“Instructions”，查看OpenSCA Xcheck相关使用说明。
- 查看更多：点击操作栏的“See more”，跳转到[opensca.xmirror.cn](https://opensca.xmirror.cn)查看OpenSCA Xcheck 更多相关信息。

<img src="https://opensca.xmirror.cn/docs/img/vscode_02.jpg" alt="xcheck_function" />

### 插件执行流程

<img src="https://opensca.xmirror.cn/docs/assets/img/xcheck_process.7083b869.jpg" alt="xcheck流程图"  />

### 使用插件

点击OpenSCA Xcheck可打开OpenSCA窗口。首先在配置界面中配置服务器参数（参考：插件功能-配置），然后在OpenSCA窗口中点击“Run”（参考：插件功能-运行）

## 友情链接

[悬镜官网](https://www.xmirror.cn/), [OpenSCA官网](https://opensca.xmirror.cn)