https://github.com/exercism/rust-analyzer

A static analyzer for Rust
https://github.com/exercism/rust-analyzer

community-contributions-paused exercism-analyzer exercism-tooling

Last synced: about 1 month ago
JSON representation

A static analyzer for Rust

• Host: GitHub
• URL: https://github.com/exercism/rust-analyzer
• Owner: exercism
• License: agpl-3.0
• Created: 2019-05-20T14:17:02.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T06:53:56.000Z (10 months ago)
• Last Synced: 2024-05-01T11:25:31.087Z (8 months ago)
• Topics: community-contributions-paused, exercism-analyzer, exercism-tooling
• Language: Rust
• Size: 240 KB
• Stars: 10
• Watchers: 6
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# rust-analyzer

_Not to be confused with the [rust-analyzer of the Rust project][rust-project-rust-analyzer]!_

`rust-analyzer` is a little wrapper around clippy that massages its output to adhere to Exercism's [analyzer interface][analyzer-interface].

It is used to provide clippy's feedback to submissions on [Exercism's Rust track][exercism-rust].

Please find general documentation about Exercism's language analyzers [here][analyzers-doc].

## Usage

To run the utility using Cargo execute the following command:

```shell

cargo run --   

```

In the context of the automatic mentoring the utility is invoked inside the Docker container via the `bin/run.sh` script.

## Building

You should have the latest stable version of Rust [installed][install-rust] on you machine.

Then from the project root run:

```shell

cargo build

```

## Testing

The main tests are run in docker, use the following script:

```shell

./bin/run-tests-in-docker.sh

```

For unit tests:

```shell

cargo test

```

[rust-project-rust-analyzer]: https://github.com/rust-lang/rust-analyzer

[analyzer-interface]: https://exercism.org/docs/building/tooling/analyzers/interface

[exercism-rust]: https://exercism.org/tracks/rust

[analyzers-doc]: https://exercism.org/docs/building/tooling/analyzers

[install-rust]: https://www.rust-lang.org/tools/install