Skip to content

Commit 123bb1b

Browse files
authored
Merge pull request #558 from yalechen-cyw/feature/tools
📝 update tools readme
2 parents 3338b8f + 860b0bb commit 123bb1b

4 files changed

Lines changed: 23 additions & 94 deletions

File tree

doc/en/quickStarted/tools.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| 官方工具 | 第三方工具 |
66
| :--------: | :-------: |
7-
|[0daychecker](https://github.com/Tencent/CodeAnalysis/tree/main/tools/codedog_0Day_checker)| androidlint |
7+
|[TCA-0Day_Checker(测试版)](https://github.com/TCATools/codedog_0Day_checker)| androidlint |
88
|clangwarning| checkstyle |
99
|codecount| clang |
1010
|customfilescan| cobra |
@@ -13,11 +13,11 @@
1313
|javawarning| cpplint |
1414
|regexfilescan| dart_code_metrics |
1515
|regexscan| dartanalyzer |
16-
|[tca_ql_php_beta](https://github.com/Tencent/CodeAnalysis/tree/main/tools/Hades_Beta)| detekt |
17-
|unusedresource| eslint |
18-
|[collie](https://github.com/Tencent/CodeAnalysis/tree/main/tools/collie/)| eslint_typescript |
19-
|[compass](https://github.com/Tencent/CodeAnalysis/tree/main/tools/compass)| eslint_vue |
20-
|| findbugs |
16+
|[TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory.git)| detekt |
17+
|[TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)| eslint |
18+
|[TCA-Zeus_Beta(测试版)](https://github.com/TCATools/Zeus_Beta)| eslint_typescript |
19+
|[TCA-Hades_Beta(测试版)](https://github.com/TCATools/Hades_Beta)| eslint_vue |
20+
|unusedresource| findbugs |
2121
|| flake8 |
2222
|| [flawfinder](https://github.com/TCATools/flawfinder) |
2323
|| flow |
@@ -45,3 +45,4 @@
4545
|| [sonarqube](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq.py) |
4646
|| [sonarqube_java](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_java.py) |
4747
|| [sonarqube_cs](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_cs.py) |
48+
|| [tca_plugin_sqlcheck](https://github.com/TCATools/tca_plugin_sqlcheck) |

doc/old/tools.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

doc/zh/quickStarted/tools.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| 官方工具 | 第三方工具 |
66
| :--------: | :-------: |
7-
|[0daychecker](https://github.com/Tencent/CodeAnalysis/tree/main/tools/codedog_0Day_checker)| androidlint |
7+
|[TCA-0Day_Checker(测试版)](https://github.com/TCATools/codedog_0Day_checker)| androidlint |
88
|clangwarning| checkstyle |
99
|codecount| clang |
1010
|customfilescan| cobra |
@@ -13,11 +13,11 @@
1313
|javawarning| cpplint |
1414
|regexfilescan| dart_code_metrics |
1515
|regexscan| dartanalyzer |
16-
|[tca_ql_php_beta](https://github.com/Tencent/CodeAnalysis/tree/main/tools/Hades_Beta)| detekt |
17-
|unusedresource| eslint |
18-
|[collie](https://github.com/Tencent/CodeAnalysis/tree/main/tools/collie/)| eslint_typescript |
19-
|[compass](https://github.com/Tencent/CodeAnalysis/tree/main/tools/compass)| eslint_vue |
20-
|| findbugs |
16+
|[TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory.git)| detekt |
17+
|[TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)| eslint |
18+
|[TCA-Zeus_Beta(测试版)](https://github.com/TCATools/Zeus_Beta)| eslint_typescript |
19+
|[TCA-Hades_Beta(测试版)](https://github.com/TCATools/Hades_Beta)| eslint_vue |
20+
|unusedresource| findbugs |
2121
|| flake8 |
2222
|| [flawfinder](https://github.com/TCATools/flawfinder) |
2323
|| flow |
@@ -45,3 +45,4 @@
4545
|| [sonarqube](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq.py) |
4646
|| [sonarqube_java](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_java.py) |
4747
|| [sonarqube_cs](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_cs.py) |
48+
|| [tca_plugin_sqlcheck](https://github.com/TCATools/tca_plugin_sqlcheck) |

tools/README.md

Lines changed: 9 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,17 @@
33
## **注意**
44
以下部分独立工具需要申请授权,具体操作可以参考[CLS使用文档](../server/cls/README.md).
55

6-
## [TCA-Collie(测试版)](https://github.com/TCATools/collie)
7-
一款多语言非编译型静态代码分析工具,支持C/C++/ObjectiveC/C#/CSS/Dart/Java/JavaScript/TypeScript/Kotlin/Lua/PHP/Python/Go/Ruby/Scala/Swift等17门语言,需要申请License。
8-
9-
## [TCA-Compass罗盘(测试版)](https://github.com/TCATools/compass)
10-
一款依赖组件分析工具,支持:
11-
- 分析项目的依赖组件;
12-
- 分析依赖组件是否存在漏洞等问题。
13-
14-
需要申请License。
15-
16-
## TCA-Loong龙(测试版)
17-
Java/Kotlin API和函数调用链分析工具,需要申请License。
6+
## [TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory)
7+
一款多功能的多语言静态代码分析工具,需申请License。
8+
## 功能
9+
- 支持Objective-C/C++代码规范检查;
10+
- 支持分析项目的依赖组件;
11+
- 支持分析依赖组件是否存在漏洞等问题;
12+
- 支持Java/Kotlin API和函数调用链分析;
13+
- 支持代码安全、空指针检查、内存泄漏等规则。
1814

1915
### 如何在TCA上使用
20-
在TCA上勾选以下工具规则:
21-
- [JAAF](../server/projects/main/apps/scan_conf/management/commands/open_source/jaaf.json#L4)
22-
- [JAFC](../server/projects/main/apps/scan_conf/management/commands/open_source/jafc.json#L4)
23-
- [JAFF](../server/projects/main/apps/scan_conf/management/commands/open_source/jaff.json#L4)
24-
25-
### 底层命令行工具
26-
涉及到的底层命令行工具有:
27-
- [TCA-Loong龙(测试版)](https://github.com/TCATools/loong)
16+
在TCA上勾选名称以 `TCA-Armory` 开头的工具的规则。
2817

2918
## TCA-Loong_Beta龙(测试版)
3019
Java/Kotlin API和函数调用链分析工具,无需申请License。
@@ -38,21 +27,6 @@ Java/Kotlin API和函数调用链分析工具,无需申请License。
3827
涉及到的底层命令行工具有:
3928
- [TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)
4029

41-
## TCA-QL(测试版)
42-
一款静态代码分析的解析端,开源测试版仅开放在linux上运行,需要申请License。
43-
44-
### 如何在TCA上使用
45-
在TCA上勾选以下工具规则:
46-
- [TCA_QL_CPP](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_cpp.json#L4)
47-
- [TCA_QL_Go](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_go.json#L4)
48-
- [TCA_QL_PHP](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_php.json#L4)
49-
- [TCA_QL_Python](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_python.json#L4)
50-
51-
### 底层命令行工具
52-
涉及到的底层命令行工具有:
53-
- [TCA-Zeus(测试版)](https://github.com/TCATools/TCA-Zeus-linux)
54-
- [TCA-Hades(测试版)](https://github.com/TCATools/TCA-Hades-linux)
55-
5630
## TCA-QL_Beta(测试版)
5731
一款静态代码分析的解析端,开源测试版仅支持PHP语言,开源测试版仅开放在linux上运行,无需申请License。
5832

0 commit comments

Comments
 (0)