Exercism C# analyzer

An analyzer can automatically detect issues with submissions and comment on them.

The C# analyzer implements the analyzer interface. It uses Roslyn to parse the submission's source code into syntax trees, which are then analyzed for known patterns.

Analyzing a solution

To analyze a solution, follow these steps:

1. Open a command prompt in the root directory.
2. Run ./analyze.ps1 <exercise> <directory>. This script will run the analyzer on the specified directory.
3. Once the script has completed, the analysis results will be written to <directory>/analysis.json.

Analyzing multiple solutions

To analyze multiple solutions at once, follow these steps:

1. Open a command prompt in the root directory.
2. Run ./bulk-analyze.ps1 <exercise> <directory>. This script will run the analyzer on each directory sub-directory of <directory>.
3. Once the script has completed, it will:
   1. Output general staticics to the console.
   2. Write detailed analysis results to <directory>/bulk_analysis.json.

Analyzing a solution using Docker

To analyze a solution using a Docker container, follow these steps:

1. Open a command prompt in the root directory.
2. Run ./run-in-docker.ps1 <exercise> <directory>. This script will:
   1. Build the analyzer Docker image (if necessary).
   2. Run the analyzer Docker image (as a container), passing the specified exercise and directory arguments.
3. Once the script has completed, the analysis result can be found at <directory>/analysis.json.

Note that the Docker image is built using the .NET IL Linker, which is why building can be quite slow.

Source code formatting

This repository uses the dotnet-format tool to format the source code. There are no custom rules; we just use the default formatting. You can format the code by running the ./format.ps1 command.

Scripts

The scripts in this repository are written in PowerShell. As PowerShell is cross-platform nowadays, you can also install it on Linux and macOS.