diff --git a/.golangci.yaml b/.golangci.yaml deleted file mode 100644 index d8844c70..00000000 --- a/.golangci.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Options for analysis running. -run: - # include `vendor` `third_party` `testdata` `examples` `Godeps` `builtin` - skip-dirs-use-default: true -# output configuration options -output: - # Format: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions - formats: colored-line-number -# All available settings of specific linters. -# Refer to https://golangci-lint.run/usage/linters -linters-settings: - gofumpt: - # Choose whether to use the extra rules. - # Default: false - extra-rules: true - govet: - # Disable analyzers by name. - # Run `go tool vet help` to see all analyzers. - disable: - - stdmethods -linters: - enable: - - gofumpt - - goimports - - gofmt - disable: - - errcheck - - typecheck - - deadcode - - varcheck - - staticcheck -issues: - exclude-use-default: true - exclude-files: - - ".*\\.mock\\.go$" - exclude-dirs: diff --git a/README.md b/README.md index f5b123d9..08119dee 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,25 @@ ![ABCoder](images/ABCoder.png) # Overview -ABCoder, an AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-coding applications. +ABCoder, an general AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-programming applications. ## Features -- Universal Abstract Syntax Tree (UniAST), an language-independent, AI-friendly specification of code information, providing a flexible and structrual coding context for both AI and hunman. +- Universal Abstract-Syntax-Tree (UniAST), an language-independent, AI-friendly specification of code information, providing a boundless, flexible and structrual coding context for both AI and hunman. - General Parser, parses abitary-language codes to UniAST. - General Writer, transforms UniAST back to codes. -- (Comming Soon) General Iterator, a framework for visiting the UniAST easily and implementing batch-code-processing workflows. +- (Comming Soon) General Iterator, a framework for visiting the UniAST and implementing code-batch-processing workflows. -- (Comming Soon) Code RAG, provides a set of tools and functions to help the LLM understand your codes much deeper than ever. +- (Comming Soon) Code Retrieval-Augmented-Generation (RAG), provides a set of tools and functions to help the LLM understand your codes much deeper than ever. -Based on these features, developers can easily implement or enhance their AI-assisted-coding applications, such as reviewing, optimizing, translating, etc. +Based on these features, developers can easily implement or enhance their AI-assisted-programming applications, such as reviewing, optimizing, translating, etc. -## Universal-Abstract-Syntax-Tree Specification +## Universal Abstract-Syntax-Tree Specification see [UniAST Specification](docs/uniast-zh.md) @@ -37,7 +37,7 @@ go install github.com/cloudwego/abcoder@latest abcoder parse {language} {repo-path} > ast.json ``` 3. Do your magic with UniAST... -4. Use ABCoder to write a UniAST back to codes +4. Use ABCoder to write an UniAST back to codes ```bash abcoder write {language} ast.json ``` @@ -58,7 +58,7 @@ ABCoder currently supports the following languages: # Getting Involved We encourage developers to contribute and make this tool more powerful. If you are interested in contributing to ABCoder -project, kindly check out our Getting Involved Guide: +project, kindly check out our guide: - [Parser Extension](docs/parser-zh.md) > Note: This is a dynamic README and is subject to changes as the project evolves. diff --git a/_typos.toml b/_typos.toml deleted file mode 100644 index 47b5bead..00000000 --- a/_typos.toml +++ /dev/null @@ -1,4 +0,0 @@ -# Typo check: https://github.com/crate-ci/typos - -[files] -extend-exclude = ["go.mod", "go.sum", "check_branch_name.sh"]