CodeNavi VSCode IDE自定义规则开发插件

本插件的功能是基于DSL语言编写自定义规则，进行代码扫描，生成自定义规则源码。
DSL编写指南

插件使用指南

1.下载安装VSCode IDE编辑器
2.插件市场找到我们插件并下载安装
3.开始使用

1.下载安装VSCode IDE编辑器

vscode官网

2.插件市场搜索CodeNavi

3.等待下载和安装

4.开始使用

插件功能介绍

1.规则编写（支持语法联想，高亮）

创建.kirin文件，编写DSL查询语句（文件名即为后续的规则名，如：ResourceInjection.kirin）

1.1 语法校验

检查DSL规则编写的语法正确性

1.2 格式化

格式化当前编写的规则，让排版更整齐易读

2.代码扫描

打开.kirin文件，在所写规则上，右击点击kirin -> scan菜单，选择源码路径，点击scan

• 源码支持单文件和文件夹
• lib路径支持java的三方依赖路径
  

3.查看告警结果

在CodeNavi_panel面板中查看告警信息，点击可导航到源码中

4.生成checkerId

用户想自定义填写checkerId时，可在这里生成一个id去使用

5.生成.json规则用于华为云CodeArtsCheck平台在线扫描

• .kirin规则扫描代码后会在同目录下OutputReport文件夹生成.json格式的规则文件，用户上传至华为云平台使用。
• 用户可在生成后json的description字段中根据想要检测的问题类型来修改规则告警时的提示信息。
• .json规则上传codecheck使用要求：文件名和checker字段的值需保持一致，且均为SecH_xxx格式。
  （如用户创建ResourceInjection.kirin文件，检查后生成的json文件名和checker字段值会自动转换为SecH_ResourceInjection.json）。
  

6. json规则格式校验

可检查json规则的字段属性是否符合规范，文件名和checker字段值是否一致。

DSL编写指南

DSL编写指南

上传CodeArtsCheck平台使用

1.进入代码检查首页，点击规则模块，点击新建规则

2.上传规则源码

3.规则集中选用自定义规则

4.配置任务以生效

• 进入代码检查任务设置
• 选中刚才设置的规则集
• 点击检查参数，点击按钮开启编译工具，选择编译工具及其版本，填写扫描项目的编译命令，最后点击确认
• 点击开始检查