rust-code-analysis-code-split 0.0.26-cs.0

Fork of mozilla/rust-code-analysis bumped to tree-sitter 0.26 for use by code-split. Computes complexity metrics (cyclomatic, cognitive, Halstead, MI, LOC).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# Metrics

Metrics can be displayed or exported in various formats using **rust-code-analysis-cli**.

## Display Metrics

To compute and display metrics for a given file or directory, run:

```bash
rust-code-analysis-cli -m -p /path/to/your/file/or/directory
```

- `-p`: Path to the file or directory to analyze. If a directory is provided, metrics will be computed for all supported files it contains.

## Exporting Metrics

**rust-code-analysis-cli** supports multiple output formats for exporting metrics, including:

- CBOR
- JSON
- TOML
- YAML

Both `JSON` and `TOML` can be exported as pretty-printed.

### Export Command

To export metrics as a JSON file:

```bash
rust-code-analysis-cli -m -p /path/to/your/file/or/directory -O json -o /path/to/output/directory
```

- `-O`: Specifies the output format (e.g., json, toml, yaml, cbor).
- `-o`: Path to save the output file. The filename of the output file is the same as the input file plus the extension associated to the format. If not specified, the result will be printed in the shell. 

### Pretty Print

To output pretty-printed JSON metrics:

```bash
rust-code-analysis-cli -m -p /path/to/your/file/or/directory --pr -O json
```

This command prints the formatted metrics to the console or the specified output path.