Skip to content

rust-code-analysis-web

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

rust-code-analysis-web

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 

README.md

rust-code-analysis-web

rust-code-analysis-web is a web server that provides source code analysis capabilities via a RESTful API. It enables developers to interact with the code analysis functionality from the rust-code-analysis suite through HTTP requests.

Features

  • Comment Removal: Removes comments from source code to provide a cleaner version of the code.
  • Function Spans: Retrieves the start and end lines of functions in the given source code.
  • Metrics Calculation: Computes static analysis metrics for the source code.

Refer to the REST API documentation for detailed information about the available endpoints and parameters.

Installation

Clone the repository and build the project:

cd rust-code-analysis-web/
cargo build

Usage

Run the server by specifying the host and port:

rust-code-analysis-web [OPTIONS]

Available Options

  • -j, --num-jobs <NUM_JOBS>: Number of parallel jobs to run (optional).
  • --host <HOST>: IP address where the server should run (default is 127.0.0.1).
  • --port <PORT>: Port to be used by the server (default is 8080).
  • -h, --help: Show help information.
  • -v, --version: Show version information.

Examples

To start the server on a specific host and port:

rust-code-analysis-web --host <HOST> --port <PORT> -j <NUM_JOBS>