Skip to content

Commit 3ccce84

Browse files
committed
chore: README
[no ci]
1 parent 8779b69 commit 3ccce84

File tree

1 file changed

+17
-32
lines changed

1 file changed

+17
-32
lines changed

README.md

+17-32
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# diffctx = diff context
22

3-
A GitHub action for automatically evaluating the function level impacts of Pull Requests.
3+
A GitHub action for automatically evaluating the logic level impacts of Pull Requests.
44

55
## Showcase
66

@@ -20,7 +20,7 @@ comments for indicating which part you should care most:
2020
2121
And leave a comment for helping evaluations.
2222
23-
<img width="697" alt="image" src="https://user-images.githubusercontent.com/13421694/236666915-5d403e4a-9cc1-4364-afbe-363cf82e5e49.png">
23+
<img width="952" alt="image" src="https://github.com/williamfzc/diffctx/assets/13421694/63739d01-b7dc-4947-8e3d-2e6c5ed0530c">
2424
2525
Based on [LSIF](https://microsoft.github.io/language-server-protocol/overviews/lsif/overview/), diffctx will not only
2626
analyse the lines contained by the diff, but also the full scope of your repo, and understand it well.
@@ -47,40 +47,30 @@ jobs:
4747
steps:
4848
- uses: actions/checkout@v3
4949
with:
50+
# at least
5051
fetch-depth: 2
5152

5253
# ...
5354

5455
- name: diffctx
55-
uses: williamfzc/diffctx@v0.2.3
56+
uses: williamfzc/diffctx@v0.3.1
5657
with:
57-
# currently we officially support: golang/python
58+
# currently we officially support:
59+
# - golang
60+
# - python
61+
# - java
62+
# - kotlin
63+
# - node
5864
lang: "golang"
5965
```
6066
6167
### Done!
6268
6369
You can create a new PullRequest for test.
6470
65-
### What about other languages?
66-
67-
Currently, diffctx can also support java/kotlin.
68-
But you have to generate LSIF file ([this link](https://github.com/williamfzc/diffctx/blob/main/index.py) might help) by
69-
yourself because of the complexity of the compilation process.
70-
71-
```yml
72-
- name: diffctx
73-
uses: williamfzc/[email protected]
74-
with:
75-
lang: "java"
76-
lsif_file: "./dump.lsif"
77-
```
78-
79-
Help wanted :)
80-
8171
### Still have a problem?
8272
83-
A real example can be found in: https://github.com/williamfzc/srctx/tree/test_diffctx
73+
A real example can be found in: https://github.com/williamfzc/srctx/pull/49
8474
8575
## How it works
8676
@@ -93,23 +83,18 @@ A real example can be found in: https://github.com/williamfzc/srctx/tree/test_di
9383
9484
Thanks to tree-sitter and LSIF, diffctx can support nearly all the popular languages.
9585
96-
| Languages | Status |
97-
|-------------|---------|
98-
| Golang | Done |
99-
| Python | Done |
100-
| Java/Kotlin | Working |
101-
| JavaScript | Working |
86+
https://lsif.dev/
10287
10388
## Contribution
10489
105-
Issues, PRs and suggestions are welcome.
90+
Issues, PRs and suggestions are always welcome.
10691
10792
- [diffctx](https://github.com/williamfzc/diffctx): for the whole workflow
10893
- [srctx](https://github.com/williamfzc/srctx): the core analyzer
10994
11095
## Roadmap
11196
112-
- More languages
113-
- Better comment format
114-
- Extract more meaningful columns (like function definition) from code
115-
- Display graph in comment also
97+
- [ ] More languages
98+
- [ ] Better comment format
99+
- [ ] Extract more meaningful columns (like function definition) from code
100+
- [ ] Display graph in comment also

0 commit comments

Comments
 (0)