ScorecardGenerator 2.1.2

Service Scorecard Generator

Service Scorecard Generator is a dotnet app that generates Azure Wiki-friendly markdown files with scores for dotnet projects.

For more details on individual checks and their scoring, take a look at the README.md files inside the subdirectories of /Checks.

Usage

dotnet tool install --global ScorecardGenerator

# this assumes you want to scan all .csproj files residing inside `/sources` and subdirectories thereof
cd /sources

# this assumes you want to output the markdown files to `/wiki` and use the default configuration
ScorecardGenerator --output-path /wiki --visualizer azurewiki

Configuration

The Service Scorecard Generator stores and loads configuration from a scorecard.config.json file in the working directory.
If the file is missing when running, it will be created with default values before the tool starts.

Configuration consists of three groups of checks: Gold, Silver and Bronze.
Documentation for all available checks can be found in this repository.
Checks can be also be listed by using ScorecardGenerator list-checks.

Interactive tables

Due to limted HTML support, the table itself can't be made interactive. More info and a workaround can be found in the wiki.

License

GNU General Public License v3.0