Skip to content

Commit 5f99d0f

Browse files
committed
docs: update README and index.rst
1 parent 5de0dca commit 5f99d0f

File tree

2 files changed

+38
-27
lines changed

2 files changed

+38
-27
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Source Level Code Analysis Toolkit.
55
<br>
66
<img src="https://sunbk201.oss-cn-beijing.aliyuncs.com/img/ScubaTrace.png" width="61.8%">
77

8+
ScubaTrace is a code analysis toolkit that leverages tree-sitter and LSP (Language Server Protocol) to provide parsing, analysis, and context extraction capabilities for multiple programming languages.
9+
10+
Unlike most traditional static analysis tools that rely on compilation to extract Intermediate Representation (IR) for code analysis, ScubaTrace delivers analysis capabilities even when code repositories are incomplete or unable to compile. This resilience makes it particularly valuable for scenarios where traditional analysis approaches would fail, enabling developers and security researchers to gain insights from code that might otherwise be inaccessible to conventional static analysis methodologies.
11+
12+
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing) implementations.
13+
814
# Features
915

1016
- **Multi-Language Support**
@@ -27,18 +33,18 @@ pip install scubatrace
2733

2834
ScubaTrace supports multiple programming languages, including:
2935

30-
| Language | Maturity |
31-
| ---------- | -------- |
32-
| C/C++ | High |
33-
| Java | High |
34-
| Python | High |
35-
| JavaScript | High |
36-
| Go | Medium |
37-
| Rust | Medium |
38-
| Ruby | Medium |
39-
| Swift | Medium |
40-
| C# | Medium |
41-
| PHP | Medium |
36+
| Language | Language Server | Tree-sitter Parser |
37+
| ---------- | -------------------------- | ---------------------- |
38+
| C/C++ | clangd | tree-sitter-cpp |
39+
| Java | Eclipse JDT LS | tree-sitter-java |
40+
| Python | jedi-language-server | tree-sitter-python |
41+
| JavaScript | typescript-language-server | tree-sitter-javascript |
42+
| Go | gopls | tree-sitter-go |
43+
| Rust | Rust Analyzer | tree-sitter-rust |
44+
| Ruby | Solargraph | tree-sitter-ruby |
45+
| Swift | SourceKit-LSP | tree-sitter-swift |
46+
| C# | OmniSharp | tree-sitter-c-sharp |
47+
| PHP | phpactor | tree-sitter-php |
4248

4349
# Usage
4450

docs/index.rst

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
ScubaTrace
33
==========
44

5-
Next-generation codebase analysis toolkit.
5+
ScubaTrace is a code analysis toolkit that leverages tree-sitter and LSP (Language Server Protocol) to provide parsing, analysis, and context extraction capabilities for multiple programming languages.
6+
7+
Unlike most traditional static analysis tools that rely on compilation to extract Intermediate Representation (IR) for code analysis, ScubaTrace delivers analysis capabilities even when code repositories are incomplete or unable to compile. This resilience makes it particularly valuable for scenarios where traditional analysis approaches would fail, enabling developers and security researchers to gain insights from code that might otherwise be inaccessible to conventional static analysis methodologies.
8+
9+
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing) implementations.
10+
611

712
.. image:: _static/ScubaTrace.png
813
:width: 500px
@@ -38,20 +43,20 @@ Supported Languages
3843

3944
ScubaTrace supports multiple programming languages, including:
4045

41-
========== ========
42-
Language Maturity
43-
========== ========
44-
C/C++ High
45-
Java High
46-
Python High
47-
JavaScript High
48-
Go Medium
49-
Rust Medium
50-
Ruby Medium
51-
Swift Medium
52-
C# Medium
53-
PHP Medium
54-
========== ========
46+
=================== =========================== ========================
47+
Language Language Server Tree-sitter Parser
48+
=================== =========================== ========================
49+
C/C++ clangd tree-sitter-cpp
50+
Java Eclipse JDT LS tree-sitter-java
51+
Python jedi-language-server tree-sitter-python
52+
JavaScript typescript-language-server tree-sitter-javascript
53+
Go gopls tree-sitter-go
54+
Rust Rust Analyzer tree-sitter-rust
55+
Ruby Solargraph tree-sitter-ruby
56+
Swift SourceKit-LSP tree-sitter-swift
57+
C# OmniSharp tree-sitter-c-sharp
58+
PHP phpactor tree-sitter-php
59+
=================== =========================== ========================
5560

5661
Reference
5762
==========

0 commit comments

Comments
 (0)