34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# SonarQubeRule2Excel
|
||
|
||
#### 介绍
|
||
将sonarqube的规则导出到Excel中
|
||
|
||
#### 软件架构
|
||
一个简单的java小程序，用于导出sonarqube的规则
|
||
|
||
|
||
#### 安装教程
|
||
maven中配置了相关依赖，因此建议使用idea打开此程序，根据自己本地的web api接口，修改resources中相关的json文件内获取到的规则数据
|
||
- 如何获取规则数据？
|
||
http://localhost:9000/api/rules/search?languages=xml&p=1&ps=500&activation=no&qprofile=AXbb67SCfA6lW0GcZo8t
|
||
```
|
||
参数说明可以在sonarqube的[web Api接口说明<http://localhost:9000/web_api>](http://localhost:9000/web_api)中看到
|
||
|
||
```
|
||
|
||
**注意：当只需要获取已启用或已关闭的规则时，必须设置qprofile参数，该参数获取可通过<http://localhost:9000/profiles>链接，点选需要获取规则的profile后，再点击左侧激活或未激活的数字，即可在链接中看到该profile的qprofile，一个profile的qprofile是一致的**
|
||
|
||
#### 使用说明
|
||
|
||
1. 手动获取需要获取规则的profile对应的qprofile参数
|
||
2. 将通过示例链接获取的规则json数据拷贝到src/main/resources文件中(可以自己新建对应的文件，按照示例名称命名-<语言-[activation|inactivation].json>)
|
||
3. 修改MainApplication.java中fileList数据，将需要导出的规则文件列入该数组中
|
||
4. 执行MainApplication.java
|
||
5. 生成的Excel文件就在根目录中AndroidApps-rules.xlsx文件
|
||
|
||
#### TODO
|
||
|
||
1. 启用和不启用规则使用配置文件，程序自动请求配置内地址，并生成对应文件
|
||
2. 自动根据配置中对应文件生成Excel
|
||
|