Reson

<p align="center"> <a href="https://nexepic.github.io/reson"> <picture> <source srcset="./docs/static/img/icon-light.svg" media="(prefers-color-scheme: dark)"> <img src="./docs/static/img/icon.svg" alt="icon" width="120" /> </picture> </a> </p> <p align="center"> A high-performance code duplication detector based on Abstract Syntax Tree (AST). </p> <p align="center"> <a href="https://github.com/nexepic/reson/actions/workflows/ci.yml"> <img alt="Build Status" src="https://github.com/nexepic/reson/actions/workflows/ci.yml/badge.svg" /> </a> <a href="https://codecov.io/gh/nexepic/reson"> <img alt="codecov" src="https://codecov.io/gh/nexepic/reson/branch/main/graph/badge.svg" /> </a> <a> <img alt="License" src="https://img.shields.io/github/license/nexepic/reson"> </a> <a> <img alt="GitHub release" src="https://img.shields.io/github/v/release/nexepic/reson"> </a> </p>

Reson is a robust command-line tool designed for detecting code duplication across multiple source files. By leveraging Abstract Syntax Tree (AST) analysis, reson ensures accurate and reliable detection of duplicated code, supporting various programming languages such as C/C++, Java, and Python.

This tool helps maintain high-quality codebases by identifying redundant code blocks, enabling effective refactoring and optimization.

---

Features

• AST-based Analysis: Ensures precise duplication detection by analyzing the code structure rather than plain text.
• Customizable Thresholds: Define the minimum number of lines to consider as duplicates.
• Exclude Directories/Files: Easily exclude specific paths from the analysis.
• Flexible Output Options: Generate detailed reports in JSON and other formats.
• Debug Mode: Access additional logs for debugging and deeper analysis.

---

Supported Languages

| Language | File Extensions | |------------|---------------------------------------| | C | .c, .h | | C++ | .cpp, .cc, .cxx, .hpp, .hxx | | Java | .java | | JavaScript | .js, .jsx | | TypeScript | .ts, .tsx | | Python | .py | | Go | .go | | Rust | .rs |

---

Build from Source

Clone the repository and build the project using Rust's Cargo:

git clone https://github.com/nexepic/reson.git
cd reson
cargo build --release

---

Usage

Run the tool using the following command:

./reson --source-path <path_to_source> [options]

---

Example

Detect code duplication in the src directory, excluding tests and build directories, and output the results to result.json:

./reson \
  --source-path src \
  --excludes tests,build \
  --output-format json \
  --output-file result.json \
  --threshold 10

---

Development

Testing

Run the included test suite to validate functionality:

cargo test

Contributing

We welcome contributions to enhance reson. Feel free to open an issue or submit a pull request.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Acknowledgements

Reson was created by Nexepic to streamline the process of detecting and managing code duplication in diverse codebases. Your feedback and contributions are highly valued!