Skip to content

Commit 0e743ff

Browse files
authored
docs: fix some typo (#143)
1 parent d4c14b3 commit 0e743ff

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ see [UniAST Specification](docs/uniast-zh.md)
8282
8383
- You can add more repo ASTs into the AST directory without restarting abcoder MCP server.
8484
85-
- Try to use [the recommened prompt](llm/prompt/analyzer.md) and combine planning/memory tools like [sequential-thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking) in your AI agent.
85+
- Try to use [the recommended prompt](llm/prompt/analyzer.md) and combine planning/memory tools like [sequential-thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking) in your AI agent.
8686
8787
8888
## Use ABCoder as an Agent (WIP)

docs/parser-en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ type LanguageSpec interface {
3838
WorkSpace(root string) (map[string]string, error)
3939

4040
// give an absolute file path and returns its module name and package path
41-
// external path should alse be supported
41+
// external path should also be supported
4242
// FIXEM: some language (like rust) may have sub-mods inside a file, but we still consider it as a unity mod here
4343
NameSpace(path string) (string, string, error)
4444

docs/parser-zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
- CheckRepo():检查用户仓库情况,根据各语言规范额处理工具链等问题,并返回默认打开的第一个文件(用于触发 LSP server),以及等候 sever 初始化完成的时间(根据仓库大小来决定)
3030
- **LanguageSpec interface**: 核心模块,用于处理非 LSP 通用的语法信息、比如判断一个 token 是否是标准库的符号、函数签名解析等:
3131

32-
### LaunguageSpec
32+
### LanguageSpec
3333

3434
用于在 LSP 符号收集过程中转换为 UniAST 所需信息,并且这些信息非 LSP 通用定义
3535

@@ -40,7 +40,7 @@ type LanguageSpec interface {
4040
WorkSpace(root string) (map[string]string, error)
4141

4242
// give an absolute file path and returns its module name and package path
43-
// external path should alse be supported
43+
// external path should also be supported
4444
// FIXEM: some language (like rust) may have sub-mods inside a file, but we still consider it as a unity mod here
4545
NameSpace(path string) (string, string, error)
4646

docs/uniast-en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ An independent code compilation unit, corresponding to ModPath in Identity, cont
154154
- Dependencies: Dictionary of third-party dependency modules for module building {ModName}: {ModPath}
155155

156156

157-
- Packages: Contains subpackages, {PkgPath}: {Pacakge AST} dictionary
157+
- Packages: Contains subpackages, {PkgPath}: {Package AST} dictionary
158158

159159

160160
- Files: Module file information, where the key is the **path relative to the repo**. It is recommended to include all repository files here to facilitate writer rewriting
@@ -638,7 +638,7 @@ const (
638638
FUNC
639639
// Struct、TypeAlias、Enum...
640640
TYPE
641-
// Global Varable or Global Const
641+
// Global Variable or Global Const
642642
VAR
643643
)
644644
```

docs/uniast-zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Universal Abstract-Syntax-Tree 是 ABCoder 建立的一种 LLM 亲和、语言
154154
- Dependencies: 模块构建的第三方依赖模块字典 {ModName}: {ModPath}
155155

156156

157-
- Packages: 包含的子包,{PkgPath}: {Pacakge AST} 字典
157+
- Packages: 包含的子包,{PkgPath}: {Package AST} 字典
158158

159159

160160
- Files: 模块文件信息,key 为**相对 repo 的路径。**这里建议包括仓库所有文件,方便 writer 回写
@@ -638,7 +638,7 @@ const (
638638
FUNC
639639
// Struct、TypeAlias、Enum...
640640
TYPE
641-
// Global Varable or Global Const
641+
// Global Variable or Global Const
642642
VAR
643643
)
644644
```

llm/prompt/analyzer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
You are a code-analysis expert. Based on the Abstract-Syntax-Tree (AST) of a specific code repository and using relevant tools, you will answer user questions.
33

44
# Available Tools
5-
- `list_repos`: check the avaliable repos and their correct name
5+
- `list_repos`: check the available repos and their correct name
66
- `get_repo_structure`: Retrieve the structural information of a specified code repository, including lists of modules and packages.
77
- `get_package_structure`: Obtain the structural information of a specified package, including lists of files and node names.
88
- `get_ast_node`: Fetch the complete AST node information of a specified node, including its type, code, location, and related dependency (dependencies), reference (references), inheritance (inherits), implementation (implements), and grouping (groups) node IDs.

llm/tool/mcp.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828

2929
type MCPConfig struct {
3030
Type MCPType
31-
Comand string
31+
Command string
3232
Args []string
3333
Envs []string
3434
SSEURL string
@@ -50,10 +50,10 @@ func NewMCPClient(opts MCPConfig) (*MCPClient, error) {
5050
var err error
5151
switch opts.Type {
5252
case MCPTypeStdio:
53-
if opts.Comand == "" {
54-
return nil, errors.New("comand is empty")
53+
if opts.Command == "" {
54+
return nil, errors.New("command is empty")
5555
}
56-
cli, err = client.NewStdioMCPClient(opts.Comand, opts.Envs, opts.Args...)
56+
cli, err = client.NewStdioMCPClient(opts.Command, opts.Envs, opts.Args...)
5757
if err != nil {
5858
return nil, err
5959
}
@@ -112,7 +112,7 @@ func GetSequentialThinkingTools(ctx context.Context) ([]Tool, error) {
112112
sync.OnceFunc(func() {
113113
cli, err := NewMCPClient(MCPConfig{
114114
Type: MCPTypeStdio,
115-
Comand: "npx",
115+
Command: "npx",
116116
Args: []string{
117117
"-y",
118118
"@modelcontextprotocol/server-sequential-thinking",
@@ -136,7 +136,7 @@ func GetGitTools(ctx context.Context) ([]Tool, error) {
136136
sync.OnceFunc(func() {
137137
cli, err := NewMCPClient(MCPConfig{
138138
Type: MCPTypeStdio,
139-
Comand: "uvx",
139+
Command: "uvx",
140140
Args: []string{
141141
"mcp-server-git",
142142
},

llm/tool/mcp_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
func TestMCPClient(t *testing.T) {
2727
cli, err := NewMCPClient(MCPConfig{
2828
Type: MCPTypeStdio,
29-
Comand: "npx",
29+
Command: "npx",
3030
Args: []string{
3131
"-y",
3232
"@modelcontextprotocol/server-sequential-thinking",

main.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ func main() {
154154
case "write":
155155
_, uri := parseArgsAndFlags(flags, false, flagHelp, flagVerbose)
156156
if uri == "" {
157-
log.Error("Arguement Path is required\n")
157+
log.Error("Argument Path is required\n")
158158
os.Exit(1)
159159
}
160160

@@ -178,7 +178,7 @@ func main() {
178178
case "mcp":
179179
_, uri := parseArgsAndFlags(flags, false, flagHelp, flagVerbose)
180180
if uri == "" {
181-
log.Error("Arguement Path is required\n")
181+
log.Error("Argument Path is required\n")
182182
os.Exit(1)
183183
}
184184

@@ -198,7 +198,7 @@ func main() {
198198
case "agent":
199199
_, uri := parseArgsAndFlags(flags, false, flagHelp, flagVerbose)
200200
if uri == "" {
201-
log.Error("Arguement Path is required\n")
201+
log.Error("Argument Path is required\n")
202202
os.Exit(1)
203203
}
204204

@@ -239,7 +239,7 @@ func parseArgsAndFlags(flags *flag.FlagSet, needLang bool, flagHelp *bool, flagV
239239
os.Exit(1)
240240
}
241241
if len(os.Args) < 4 {
242-
fmt.Fprintf(os.Stderr, "arguement Path is required\n")
242+
fmt.Fprintf(os.Stderr, "argument Path is required\n")
243243
os.Exit(1)
244244
}
245245
uri = os.Args[3]

0 commit comments

Comments
 (0)