Merge pull request #5 from Singularity-ng/codex/review-code-for-documentation-and-functionality

Update petgraph and rustler dependencies

Author: mikkihugo

BEAM_SUPPORT.md

@@ -195,7 +195,7 @@ Making singularity-code-analysis one of the most comprehensive BEAM-aware comple
 ## Credits
 
 Implementation based on:
-- Singularity's rust-code-analysis framework
+- Singularity's singularity-code-analysis framework
 - tree-sitter-elixir by @elixir-lang
 - tree-sitter-erlang by @WhatsApp
 - tree-sitter-gleam by @gleam-lang

Cargo.toml

@@ -20,34 +20,34 @@ globset = "0.4"
 num = "0.4"
 num-derive = "0.4"
 num-format = "0.4"
-petgraph = "0.6"
+petgraph = "0.8"
 regex = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 termcolor = "1.2"
 walkdir = "2.0"
 
-tree-sitter = "0.25"
-tree-sitter-java = "0.23"
-tree-sitter-typescript = "0.23"
-tree-sitter-javascript = "0.23"
-tree-sitter-python = "0.23"
-tree-sitter-rust = "0.23"
-tree-sitter-cpp = "0.23"
+tree-sitter = "0.25.10"
+tree-sitter-java = "0.23.5"
+tree-sitter-typescript = "0.23.2"
+tree-sitter-javascript = "0.25.0"
+tree-sitter-python = "0.25.0"
+tree-sitter-rust = "0.24.0"
+tree-sitter-cpp = "0.23.4"
 # BEAM languages
-tree-sitter-elixir = "0.3"
-tree-sitter-erlang = "0.15"
-tree-sitter-gleam = "1.0"
+tree-sitter-elixir = "0.3.4"
+tree-sitter-erlang = "0.15.0"
+tree-sitter-gleam = "1.0.0"
 # Lua
-tree-sitter-lua = "0.2"
+tree-sitter-lua = "0.2.0"
 # Go and C#
-tree-sitter-go = "0.23"
-tree-sitter-c-sharp = "0.23"
+tree-sitter-go = "0.25.0"
+tree-sitter-c-sharp = "0.23.1"
 # Kotlin
-tree-sitter-kotlin-ng = "1.1"
+tree-sitter-kotlin-ng = "1.1.0"
 num-traits = "0.2"
 
 # NIF support (optional - only when used from Elixir)
-rustler = { version = "0.35", optional = true }
+rustler = { version = "0.37", optional = true }
 
 [features]
 default = []

PRODUCTION_READINESS_ASSESSMENT.md

@@ -446,7 +446,7 @@ Grep results for common patterns:
 | regex | 1.12 | ✅ Current | Widely used, well-maintained |
 | serde | 1.0 | ✅ Current | Standard serialization |
 | walkdir | 2.5 | ✅ Current | File traversal |
-| petgraph | 0.6 | ✅ Current | Graph algorithms |
+| petgraph | 0.8 | ✅ Current | Graph algorithms |
 | crossbeam | 0.8 | ✅ Current | Concurrency primitives |
 | tree-sitter-* | 0.2-1.1 | ✅ Current | Grammar parsers |
 | aho-corasick | 1.1 | ✅ Current | String matching |

README.md

@@ -10,7 +10,8 @@ It is based on a parser generator tool and an incremental parsing library
 called
 <a href="https://tree-sitter.github.io/tree-sitter/" target="_blank">Tree Sitter</a>.
 
-This library is a fork of [Mozilla rust-code-analysis](https://github.com/mozilla/rust-code-analysis)
+This crate is the Singularity-maintained continuation of
+[Mozilla rust-code-analysis](https://github.com/mozilla/rust-code-analysis),
 with enhanced support for BEAM languages (Elixir, Erlang, Gleam) and additional
 code complexity metrics.
 
@@ -86,17 +87,30 @@ fn calculate(x: i32, y: i32) -> i32 {
 
 ### Supported Languages
 
-| Language | Status | Metrics | Function Detection |
-|----------|--------|---------|-------------------|
-| **Rust** | ✅ Full | ✅ Complete | ✅ Full |
-| **Python** | ✅ Full | ✅ Complete | ✅ Full |
-| **JavaScript/TypeScript** | ✅ Full | ✅ Complete | ✅ Full |
-| **Java** | ✅ Full | ✅ Complete | ✅ Full |
-| **C/C++** | ✅ Full | ✅ Complete | ✅ Full |
-| **Elixir** | ✅ Full | ⚠️ Partial | ✅ Full |
-| **Erlang** | ✅ Full | ⚠️ Partial | ✅ Full |
-| **Gleam** | ✅ Full | ⚠️ Partial | ✅ Full |
-| **Lua** | ✅ Full | ⚠️ Partial | ✅ Full |
+| Language | Parsing & Function Detection | Metrics Coverage | Notes |
+|----------|------------------------------|------------------|-------|
+| **Rust** | ✅ Full | ✅ Full | |
+| **Python** | ✅ Full | ✅ Full | |
+| **JavaScript** | ✅ Full | ✅ Full | |
+| **TypeScript** | ✅ Full | ✅ Full | Covers the `LANG::Typescript` parser. |
+| **TSX (TypeScript + JSX)** | ✅ Full | ✅ Full | Covers the `LANG::Tsx` parser for mixed TS/JSX files. |
+| **Java** | ✅ Full | ✅ Full | Weighted Methods per Class (WMC) implemented only for Java. |
+| **C/C++** | ✅ Full | ✅ Full | See the macro parsing note below for known limitations. |
+| **Kotlin** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **Go** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **C#** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **Elixir** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **Erlang** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **Gleam** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+| **Lua** | ✅ Full | ⚠️ Partial | LOC, exit counting, and WMC metrics are not yet implemented. |
+
+> [!IMPORTANT]
+> ### Known C/C++ limitations
+> Tree-sitter's C/C++ grammars still struggle with Mozilla-style macro expansions.
+> The three unit tests under `c_langs_macros` are expected to fail until the
+> upstream grammar exposes these constructs without parse errors. Function and
+> metrics analysis for typical C/C++ codebases works as expected; only heavily
+> macro-based signatures are affected.
 
 ## Metrics
 
@@ -251,5 +265,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Acknowledgments
 
-This library is a fork of [Mozilla rust-code-analysis](https://github.com/mozilla/rust-code-analysis).
+singularity-code-analysis started as a fork of
+[Mozilla rust-code-analysis](https://github.com/mozilla/rust-code-analysis).
 Special thanks to the Mozilla team for their excellent work on code analysis tools.

rust-code-analysis-book/src/developers/new-language.md

@@ -1,6 +1,6 @@
 [book]
-title = "Rust-Code-Analysis Documentation"
-description = "This book documents rust-code-analysis"
+title = "Singularity-Code-Analysis Documentation"
+description = "This book documents singularity-code-analysis"
 authors = ["Calixte Denizet <cdenizet@singularity.com>"]
 language = "en"
 

rust-code-analysis-book/src/languages.md

@@ -4,7 +4,7 @@
 
 git worktree add -b gh-pages /tmp/book
 rm -rf /tmp/book/* # this won't delete the .git directory
-cp -rp rust-code-analysis-book/book/* /tmp/book/
+cp -rp singularity-code-analysis-book/book/* /tmp/book/
 cd /tmp/book
 git add -A
-git commit -m "Deploy rust-code-analysis"
+git commit -m "Deploy singularity-code-analysis"

rust-code-analysis-book/.gitignore singularity-code-analysis-book/.gitignorerust-code-analysis-book/.gitignore renamed to singularity-code-analysis-book/.gitignore

@@ -1,35 +1,43 @@
-# rust-code-analysis
+# singularity-code-analysis
 
-**rust-code-analysis** is a Rust library to analyze and extract information
-from source codes written in many different programming languages.
+**singularity-code-analysis** is a Rust library to analyze and extract
+information from source codes written in many different programming languages.
+Historical references to the upstream **rust-code-analysis** project remain in
+this book where they describe published research or tooling lineage.
 It is based on a parser generator tool and an incremental parsing library
 called
 <a href="https://tree-sitter.github.io/tree-sitter/" target="_blank">Tree Sitter</a>.
 
 You can find the source code of this software on
-<a href="https://github.com/singularity/rust-code-analysis/" target="_blank">GitHub</a>,
+<a href="https://github.com/mikkihugo/singularity-code-analysis" target="_blank">GitHub</a>,
 while issues and feature requests can be posted on the respective
-<a href="https://github.com/singularity/rust-code-analysis/issues/" target="_blank">GitHub Issue Tracker</a>.
+<a href="https://github.com/mikkihugo/singularity-code-analysis/issues" target="_blank">GitHub Issue Tracker</a>.
 
 ## Supported platforms
 
-**rust-code-analysis** can run on the most common platforms: Linux, macOS,
+**singularity-code-analysis** can run on the most common platforms: Linux, macOS,
 and Windows.
 
+> [!NOTE]
+> The Tree-sitter C/C++ grammars still emit parse errors for several
+> Mozilla-specific macro expansions. The Singularity project tracks these
+> upstream issues and marks the affected unit tests as expected failures until
+> the grammar is improved.
+
 On our
-<a href="https://github.com/singularity/rust-code-analysis/releases" target="_blank">GitHub Release Page</a>
+<a href="https://github.com/mikkihugo/singularity-code-analysis/releases" target="_blank">GitHub Release Page</a>
 you can find the `Linux` and `Windows` binaries already compiled and
 packed for you.
 
 
 ## API docs
 
-If you prefer to use **rust-code-analysis** as a crate, you can find the
+If you prefer to use **singularity-code-analysis** as a crate, you can find the
 `API docs` generated by `Rustdoc`
-<a href="https://docs.rs/rust-code-analysis/*/rust_code_analysis/" target="_blank">here</a>.
+<a href="https://docs.rs/singularity-code-analysis/*/singularity_code_analysis/" target="_blank">here</a>.
 
 
-## How to cite rust-code-analysis
+## How to cite the upstream project
 
 ```
 @article{ARDITO2020100635,
@@ -51,6 +59,6 @@ If you prefer to use **rust-code-analysis** as a crate, you can find the
 
 - Singularity-defined grammars are released under the MIT license.
 
-- **rust-code-analysis**, **rust-code-analysis-cli** and **rust-code-analysis-web**
-are released under the
+- **singularity-code-analysis** and its CLI and web front-ends are released
+under the
 <a href="https://www.singularity.org/MPL/2.0/" target="_blank">Singularity Public License v2.0</a>.