Skip to content

Commit eeb7180

Browse files
committed
doc: README
[no ci]
1 parent ea33e61 commit eeb7180

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ And leave a comment for helping evaluations.
2222
2323
<img width="952" alt="image" src="https://github.com/williamfzc/diffctx/assets/13421694/63739d01-b7dc-4947-8e3d-2e6c5ed0530c">
2424
25+
> https://github.com/williamfzc/srctx/pull/52
26+
2527
Based on [LSIF](https://microsoft.github.io/language-server-protocol/overviews/lsif/overview/), diffctx will not only
2628
analyse the lines contained by the diff, but also the full scope of your repo, and understand it well.
2729
@@ -55,22 +57,33 @@ jobs:
5557
- name: diffctx
5658
uses: williamfzc/[email protected]
5759
with:
58-
# currently we officially support:
59-
# - golang
60-
# - python
61-
# - java
62-
# - kotlin
63-
# - node
60+
# see the `Supported Langs` for details
6461
lang: "golang"
6562
```
6663
6764
### Done!
6865
6966
You can create a new PullRequest for test.
7067
71-
### Still have a problem?
68+
## Supported Languages
69+
70+
### Overview
71+
72+
| Language | Ready? | Keyword in yaml | Demo |
73+
|----------|--------|-----------------|-------------------------------------------------------------------------------------------|
74+
| Golang | ✅ | `golang` | [ci.yaml](https://github.com/williamfzc/srctx/blob/test_diffctx/.github/workflows/ci.yml) |
75+
| Java | ✅ | `java` | |
76+
| Kotlin | ✅ | `kotlin` | |
77+
| NodeJs | ✅ | `node` | |
78+
| Python | ✅ | `python` | |
7279

73-
A real example can be found in: https://github.com/williamfzc/srctx/pull/49
80+
### Want more langs?
81+
82+
Thanks to tree-sitter and LSIF, diffctx can support nearly all the popular languages.
83+
84+
https://lsif.dev/
85+
86+
Adding a new language support is not hard. PullRequests are always welcome!
7487

7588
## How it works
7689

@@ -79,12 +92,6 @@ A real example can be found in: https://github.com/williamfzc/srctx/pull/49
7992
3. Generate a summary from sub graph
8093
4. Create a comment
8194

82-
## Supported Languages
83-
84-
Thanks to tree-sitter and LSIF, diffctx can support nearly all the popular languages.
85-
86-
https://lsif.dev/
87-
8895
## Contribution
8996

9097
Issues, PRs and suggestions are always welcome.

0 commit comments

Comments
 (0)