Demo 工具示例

开发指引

1. 修改src/main.py，按需实现工具逻辑。
2. tool.json文件里声明了2个字段，check_cmd和run_cmd，对应src/main.py中需要实现的2个执行命令。
   • check_cmd：
     • 功能：判断当前执行环境是否满足工具要求。

       比如某些工具只能在linux下执行，需要判断当前是否为linux环境。

     • 输出：将判断结果输出到check_result.json文件中，文件内容为{"usable": true}或{"usable": false}。
   • run_cmd：

     • 功能：扫描代码，执行自定义检查器逻辑。

     • 输出：按照指定格式，输出结果到result.json文件中，文件格式：

       [
           {
               "path": "文件绝对路径",
               "line": "行号，int类型",
               "column": "列号, int类型，如果工具没有输出列号信息，可以用0代替",
               "msg": "提示信息",
               "rule": "规则名称,可以根据需要输出不同的规则名",
               "refs": [
                   {
                       "line": "回溯行号", 
                       "msg": "提示信息", 
                       "tag": "用一个词简要标记该行信息，比如uninit_member,member_decl等，如果没有也可以都写成一样的", 
                       "path": "回溯行所在文件绝对路径"
                   },
                   ...
               ]
           },
           ...
       ]
       

       说明： refs：可选，记录问题回溯路径信息。比如当前文件的回溯路径其他的3行代码，可以将这三行的路径及提示信息，按顺序添加到refs数组中。

本地调试步骤

1. 修改test.sh中的SOURCE_DIR环境变量为需要扫描的代码目录。
2. 按需修改task_request.json文件中task_params字段的内容，将工具代码中用到的字段替换为实际值。
3. 命令行cd到项目根目录,执行test.sh脚本：bash test.sh。