Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: #377 update mdbook readme #1118

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: #377 update mdbook readme #1118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b26bbb
docs: #377 update mdbook readme
miguelcsx Sep 18, 2024
d021420
Merge branch 'master' into docs/commands-readme
miguelcsx Sep 18, 2024
ffcdefa
Merge branch 'master' into docs/commands-readme
miguelcsx Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions rust-code-analysis-book/src/commands/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
# Commands

With the term **command**, we define any procedure used by
**rust-code-analysis-cli** to extract information from source codes.
At each command **may** be associated parameters depending on the task
it needs to carry out.
In this page we have grouped the principal **types** of commands implemented in
**rust-code-analysis-cli**.
The **rust-code-analysis-cli** offers a range of **commands** to analyze source code and extract valuable insights. Each command **may** include parameters specific to the task it performs. Below, we describe the core types of commands available in **rust-code-analysis-cli**.

## Metrics

Metrics are a series of measures that can be used to:
Metrics provide quantitative measures about source code, which can help in:

- Compare different programming languages
- Provide information on the quality of a code
- Tell developers where their code is more tough to handle
- Discover errors earlier
- Discovering potential issues early in the development process

**rust-code-analysis** calculates the metrics starting from the
source code of a program. These kind of metrics are called *static metrics*.
Expand All @@ -37,7 +32,4 @@ Nodes can be used to:

## REST API

**rust-code-analysis-cli** can be run as a server which accepts requests sent
through `REST API`.
The server receives in input the filename of a source code file and returns the
relative metrics formatted as a `json` file.
The **rust-code-analysis-web** can function as a server using a REST API. This allows users to send source code via HTTP and receive corresponding metrics in `JSON` format, enabling easy integration into web applications or other services.