Skip to content

Commit 64ae766

Browse files
authored
Merge pull request #11 from codefuse-ai/dev/readme_update
chore: update readme
2 parents 02cc67b + f346d59 commit 64ae766

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ CodeFuse-Query 包括**Sparrow CLI **和CodeFuse-Query**在线服务Query中心*
5454
注:以上语言状态的成熟程度判断标准是根据COREF包含的信息种类和实际落地情况来进行判定,除了OC/C++外,所有语言均支持了完整的AST信息和Documentation信息,以Java为例,COREF for Java还支持了ASG、Call Graph、Class Hierarchy、以及部分CFG信息。
5555
## 使用场景
5656
### 查询代码特征
57-
小开发同学想知道 Repo A 里面使用了哪些 String 型的变量,所以他写了一个 Godel 如下,交给 CodeFuse-Query 系统给他返回了结果。
57+
小开发同学想知道 Repo A 里面使用了哪些 String 型的变量,所以他写了一个 Gödel 如下,交给 CodeFuse-Query 系统给他返回了结果。
5858
```rust
5959
// script
6060
use coref::java::*
@@ -76,7 +76,7 @@ fn main() {
7676
TL 同学发现团队总是写出很多类似的 Bug A**他想针对 Bug A 制定一个代码规则和其检查器**,并在 CodeReview 阶段做个卡点。小 TL 通过在 CodeFuse-Query 平台上面编写了一段分析 Query,在平台上面测试符合要求,把这段分析 Query 固化下来作为一个代码规则,并上线到了 CodeReview/CI 阶段。从此这个 Bug 再也没发生过了。
7777
类似需求:编写静态缺陷扫描规则进行代码风险拦截。
7878
### 获取统计数据
79-
小研究发现传统的代码复杂度指标很难准确地衡量代码的复杂情况,通过学习国际先进经验加上自我灵光一闪,设计了一套复杂度指标和算法。通过 Godel 实现出来以后,**发现不怎么优化就已经性能非常高了**,很快就应用到了 10 几种语言,11+万个仓库当中去了。马上就对代码仓库整体的复杂度有了深入的了解。相比较以前需要自己解析代码,分析语法树,对接系统,**不知道方便了多少。**
79+
小研究发现传统的代码复杂度指标很难准确地衡量代码的复杂情况,通过学习国际先进经验加上自我灵光一闪,设计了一套复杂度指标和算法。通过 Gödel 实现出来以后,**发现不怎么优化就已经性能非常高了**,很快就应用到了 10 几种语言,11+万个仓库当中去了。马上就对代码仓库整体的复杂度有了深入的了解。相比较以前需要自己解析代码,分析语法树,对接系统,**不知道方便了多少。**
8080
类似需求:代码统计,代码度量,算法设计,学术研究。
8181

8282
## 应用领域
@@ -110,14 +110,14 @@ CodeFuse-Query为CodeFuse代码大模型提供了以下数据清洗能力:
110110
- [引言](./doc/1_abstract.md)
111111
- [概述](./doc/2_introduction.md)
112112
- [安装、配置、运行](./doc/3_install_and_run.md)
113-
- [Godel查询语言介绍](./doc/4_godelscript_language.md)
113+
- [Gödel查询语言介绍](./doc/4_godelscript_language.md)
114114
- [VSCode开发插件](./doc/5_toolchain.md)
115115

116116
## 目录结构说明
117117
- `cli`:命令行工具的入口,提供统一的命令行接口,调用其他模块完成具体功能
118118
- `language`:各语言的数据化核心(extractor)和数据建模(lib)。关于开放度的问题,请参见《关于开源范围的一些说明》章节
119119
- `doc`:参考文档
120-
- `examples`:Godel 查询语言示例
120+
- `examples`:Gödel 查询语言示例
121121

122122
## 关于开源范围的一些说明
123123
截止目前,从源码**不能**构建出可执行的程序,原因在于本次开源并没有开放所有的模块,缺少的模块会在之后的一年陆续开源。尽管如此,为保障完整的体验,我们开放了**完整的安装包**下载,请见Release页面。

doc/4_godelscript_language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ fn main() {
1515
}
1616
```
1717

18-
GödelScript 是 CodeQuery 用于查询和数据处理的领域专用语言 (DSL)。GödelScript 使用了类 Rust 的语法,提供了严格的类型检查、方便快捷的类型推导、智能友好的错误提示信息,使用户能够快速上手。
18+
GödelScript 即 Gödel 查询语言。GödelScript 是 CodeQuery 用于查询和数据处理的领域专用语言 (DSL)。GödelScript 使用了类 Rust 的语法,提供了严格的类型检查、方便快捷的类型推导、智能友好的错误提示信息,使用户能够快速上手。
1919

2020
GödelScript 编译器主要应用场景为:
2121

0 commit comments

Comments
 (0)