cqcfg

Documentation

Overview

Cqcfg 就是CoolQ Config，用于为插件自动生成app.json

本工具为试验性工具，请按实际需要使用，若有好建议或改进，欢迎提交issue或者pr

本工具将会扫描您的代码，并且自动统计出您调用了哪些API，响应了哪些事件， 并且在生成的app.json中为相应的API注册权限，为事件注册函数

为了让本工具正常工作，你需要以标准的格式使用Go语言SDK：

响应事件时要为cqp包内相应的函数变量赋值
在主函数开头以后文中会介绍的语法声明插件的AppID和版本、作者等信息

在main函数头之前，你需要写以下几个注释：

//go:generate cqcfg -c .
// cqp: 名称: 插件名称
// cqp: 版本: 1.0.0:1
// cqp: 作者: 插件作者姓名
// cqp: 简介: 您插件的简介

其中版本是由插件版本和顺序版本号以冒号分隔形成的，有以下一般形式：

主版本.次版本.修正版本:顺序版本

注释的前半部分均为强制要求的固定格式，空格不能多不能少

若需要在json中添加菜单，以下指令是可用的，但是用于响应的函数目前仍需要您自己编写

// cqp: 菜单: <菜单名> <C函数名>

用法：

cqcfg [-c, -v] <插件main包所在目录>

-c 参数用于自动根据代码提交次数生成版本号 -v 参数用于查询cqcfg版本

推荐配合go generate使用