Skip to content

Commit 97c56ae

Browse files
committed
docs: update docs
1 parent 5f99d0f commit 97c56ae

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ScubaTrace is a code analysis toolkit that leverages tree-sitter and LSP (Langua
99

1010
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.
1111

12-
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing) implementations.
12+
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing).
1313

1414
# Features
1515

docs/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ScubaTrace is a code analysis toolkit that leverages tree-sitter and LSP (Langua
66

77
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.
88

9-
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing) implementations.
9+
ScubaTrace serves as a portable analysis solution for IDE development, AI-powered coding tools, and SAST (Static Application Security Testing).
1010

1111

1212
.. image:: _static/ScubaTrace.png
@@ -38,6 +38,19 @@ Install
3838

3939
usage
4040

41+
Features
42+
===================
43+
44+
- **Multi-Language Support**
45+
- **No Need To Compile**
46+
- **Statement-Based AST Abstraction**
47+
- **Code Call Graph**
48+
- **Code Control Flow Graph**
49+
- **Code Data/Control Dependency Graph**
50+
- **References Inference**
51+
- **CPG Based Multi-Granularity Slicing**
52+
- **Built on Tree-sitter and LSP**
53+
4154
Supported Languages
4255
===================
4356

scubatrace/file.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
class File:
2323
"""
24-
Represents a source code file in a project.
24+
A source code file in a project.
2525
"""
2626

2727
project: Project

scubatrace/project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
class Project:
2323
"""
24-
Represents a codebase project with a specified path and language.
24+
A codebase project with a specified path and language.
2525
"""
2626

2727
path: str

0 commit comments

Comments
 (0)