diff --git a/README.md b/README.md index 8c26f8cee07ad1bc4dc7699e335d73532a5cee96..454eb009a58c58ae0504ea4d0668908a14b7119b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ openKylin社区的安全开发阶段的工作内容,包括建立安全编码 * [c语言安全编码研究]() # 安全开发调研 -* [CodeCheck工具调研](./代码检查工具/CodeCheck工具调研.md) +* [CodeCheck工具使用调研](./代码检查工具/CodeCheck工具调研.md) +* [VsCode的CodeCheck插件使用调研](./代码检查工具/vscode插件codecheck使用调研.md) * [安全c库调研](./技术调研/安全c库调研.md) # 安全编码赋能 diff --git a/images/VsCode_CodeCheck_rule_config.png b/images/VsCode_CodeCheck_rule_config.png new file mode 100644 index 0000000000000000000000000000000000000000..f0576b256776a2c68dd7758ab06ad71e7132bb40 Binary files /dev/null and b/images/VsCode_CodeCheck_rule_config.png differ diff --git "a/images/codecheck\346\217\222\344\273\266\351\227\256\351\242\230\346\212\245\345\221\212.png" "b/images/codecheck\346\217\222\344\273\266\351\227\256\351\242\230\346\212\245\345\221\212.png" new file mode 100644 index 0000000000000000000000000000000000000000..99392bf0b71ae8663260e97329687bfea2f9f4e2 Binary files /dev/null and "b/images/codecheck\346\217\222\344\273\266\351\227\256\351\242\230\346\212\245\345\221\212.png" differ diff --git "a/\344\273\243\347\240\201\346\243\200\346\237\245\345\267\245\345\205\267/vscode\346\217\222\344\273\266codecheck\344\275\277\347\224\250\350\260\203\347\240\224.md" "b/\344\273\243\347\240\201\346\243\200\346\237\245\345\267\245\345\205\267/vscode\346\217\222\344\273\266codecheck\344\275\277\347\224\250\350\260\203\347\240\224.md" index 7515e6f0ba72754bcd366ecfe544c2e5f1a700de..d256bf0da64d23fd0e588fd99c0f9b631afea541 100644 --- "a/\344\273\243\347\240\201\346\243\200\346\237\245\345\267\245\345\205\267/vscode\346\217\222\344\273\266codecheck\344\275\277\347\224\250\350\260\203\347\240\224.md" +++ "b/\344\273\243\347\240\201\346\243\200\346\237\245\345\267\245\345\205\267/vscode\346\217\222\344\273\266codecheck\344\275\277\347\224\250\350\260\203\347\240\224.md" @@ -1,12 +1,36 @@ # VsCode中的CodeCheck插件使用调研 ## 安装方法 -在VsCode的插件拓展界面中搜索huawei cloud codecheck,安装插件,并且根据工具指引配置华为云账号和秘钥,即可在VsCode中使用CodeCheck。 +在VsCode的插件拓展界面中搜索Huawei Cloud CodeCheck,安装插件,并且根据工具指引配置华为云账号和AK/SK秘钥,即可在VsCode中使用CodeCheck。 ## 使用方法 +### 单文件检查 +在文件代码编辑区,点击右键,选择CodeCheck文件检查 +### 项目检查 +在文件代码编辑区,点击右键,选择CodeCheck项目检查 + +### 一键格式化 +在文件代码编辑区,点击右键,选择一键格式化 + +一键格式化能够帮助用户自动解决项目里基础的代码风格问题-比如多余的空格或则额外的空行 + +### 问题报告及修复 +扫描完成后,选择查看->输出,调出codecheck问题报告。 + +![输入图片说明](../images/codecheck插件问题报告.png) + +右上角有筛选功能,可以按问题严重等级和问题类型进行筛选 + +右上角有分类功能,可以按问题严重等级、文件、规则三种分类方式对问题进行分类 ## 规则配置 -## 规则导入导出 +- 点击VsCode左侧CodeCheck配置图标,进入规则配置界面。 +- 规则配置界面左侧界面的图标,支持分类查看功能,支持按问题严重等级和问题类型进行筛选。 +- 规则配置界面右侧显示的是筛选出来的规则列表,通过点击对钩,可以关闭某一项或者某一类规则。 +- 规则配置界面右上角有规则导入、导出按钮,可以将当前规则配置导出为json格式的规则文件。也可导入规则文件。 +![输入图片说明](../images/VsCode_CodeCheck_rule_config.png) + +