https://github.com/jmecosta/sonar-fsharp-plugin

F# SonarQube (TM) plugin - support for F#
https://github.com/jmecosta/sonar-fsharp-plugin

fsharp metrics sonarqube

Last synced: 4 months ago
JSON representation

F# SonarQube (TM) plugin - support for F#

• Host: GitHub
• URL: https://github.com/jmecosta/sonar-fsharp-plugin
• Owner: jmecosta
• License: lgpl-3.0
• Created: 2015-05-20T17:36:43.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T21:15:03.000Z (over 4 years ago)
• Last Synced: 2026-01-14T07:22:58.203Z (5 months ago)
• Topics: fsharp, metrics, sonarqube
• Language: F#
• Homepage:
• Size: 3.97 MB
• Stars: 51
• Watchers: 4
• Forks: 15
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: License.txt

Awesome Lists containing this project

README

          
# SonarQube F# Code Analyzer Plugin

The plugin enables analysis of F# within SonarQube.

## Builds

[![Build status](https://ci.appveyor.com/api/projects/status/jira637y22trnuc4/branch/master?svg=true)](https://ci.appveyor.com/project/jorgecosta/sonar-fsharp-plugin-wxq94/branch/master)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jmecsoftware.sonarqube.fsharp%3Asonar-communityfsharp-analyzer&metric=alert_status)](https://sonarcloud.io/dashboard?id=jmecsoftware.sonarqube.fsharp%3Asonar-communityfsharp-analyzer)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jmecsoftware.sonarqube.fsharp%3Asonar-communityfsharp-analyzer&metric=coverage)](https://sonarcloud.io/dashboard?id=jmecsoftware.sonarqube.fsharp%3Asonar-communityfsharp-analyzer)

Download latest snapshot from Appveyor: 

## NuGet package

[FsSonarRunner](https://www.nuget.org/packages/FsSonarRunnerCore/) is also available as NuGet package. [![NuGet Status](http://img.shields.io/nuget/v/FsSonarRunnerCore.svg?style=flat)](https://www.nuget.org/packages/dotnet-fsharplint/)

## Description / Features

- Metrics: LOC, number of classes, number of methods

- Code duplication detection

- Based on [FSharpLint](http://fsprojects.github.io/FSharpLint/)

- Runs under .NET 5.0 on Windows and Linux

## Configuration

### Requirements

- Minimal supported version of SonarQube: 7.9.5 LTS

- Working on SonarQube 8.x

- Analyzer uses .NET 5.0, the corresponding depencies of .NET

  needs to be installed (especially on Linux). .NET Core is not

  required to be installed, as the application is _self-contained_.

- NuGet packages still available also as .NET Standard 2.0/2.1 library.

- Operating system (64 bit only): Windows, Linux.

### Installation

- Download the JAR plugin file from releases and copy it to the

_extensions/downloads/_ directory of your SonarQube installation.

  - Delete any  previous plugin `sonarqube-fsharp-plugin-*.jar` or

  `sonar-communityfsharp-plugin-*.jar` from plugins directory.

- Restart SonarQube server.

The plugin will be moved to the directory _extensions/plugins/_ and the previous plugin version will be removed.

The file _logs/sonar.log_ will contain a log line indicating the loaded

plugin or any errors. The installed F# plugin will also be shown

on the Marketplace of your SonarQube installation.

- Review the F# quality profile before running for any updated rule set.

### General Configuration

- `sonar.fs.file.suffixes` - files extensions to import

### Coverage and Tests

Please use generic solutions like

 or