https://github.com/integrated-application-development/sonar-delphi

Delphi language plugin for SonarQube
https://github.com/integrated-application-development/sonar-delphi

code-quality delphi pascal sonarqube sonarqube-plugin static-analyzer

Last synced: 20 days ago
JSON representation

Delphi language plugin for SonarQube

• Host: GitHub
• URL: https://github.com/integrated-application-development/sonar-delphi
• Owner: integrated-application-development
• License: lgpl-3.0
• Created: 2022-09-16T02:58:33.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2026-01-27T06:05:54.000Z (about 2 months ago)
• Last Synced: 2026-02-18T23:44:19.995Z (about 1 month ago)
• Topics: code-quality, delphi, pascal, sonarqube, sonarqube-plugin, static-analyzer
• Language: Java
• Homepage:
• Size: 15.8 MB
• Stars: 143
• Watchers: 21
• Forks: 29
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.txt
  • Notice: NOTICE.txt

Awesome Lists containing this project

• fucking-static-analysis - SonarDelphi
• static-analysis - SonarDelphi
• awesome-pascal - SonarDelphi

README

          
# ![SonarDelphi](docs/images/sonar-delphi-title-gh.png)

[![quality gate](https://sonarcloud.io/api/project_badges/measure?project=integrated-application-development_sonar-delphi&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=integrated-application-development_sonar-delphi)

[![format](https://github.com/integrated-application-development/sonar-delphi/actions/workflows/format.yml/badge.svg?branch=master&event=push)](https://github.com/integrated-application-development/sonar-delphi/actions/workflows/format.yml)

[![build](https://github.com/integrated-application-development/sonar-delphi/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/integrated-application-development/sonar-delphi/actions/workflows/build.yml)

SonarDelphi is a modern, performant, and fully-featured community code analyzer for the Delphi

language. As a plugin for the [SonarQube](https://www.sonarqube.org) code analysis platform, it can

be easily integrated into existing workflows. It can also be used through the Delphi IDE using the

[DelphiLint](https://github.com/integrated-application-development/delphilint) plugin.

This project has three primary goals:

* **Correctness:** All valid Delphi code should be accepted and understood correctly.

* **Utility:** Analysis results should be easily understandable and immediately actionable.

* **Extensibility:** New rules should be trivial to add and have access to the full power of the analyzer.

This project aims to follow the conventions and best practices of SonarQube's official analyzers. It is actively

maintained by a core team and is [open for community contributions](#contributing).

## Features

With SonarDelphi, you can:

* Analyze Delphi code, identifying issues from more than 120 rules

* Create custom rules in the SonarQube UI from templates

* Import [NUnit](https://docs.nunit.org/articles/nunit/technical-notes/usage/Test-Result-XML-Format.html) test reports (compatible with [DUnitX](https://github.com/VSoftTechnologies/DUnitX))

* Import test coverage reports (compatible with [DelphiCodeCoverage](https://github.com/DelphiCodeCoverage/DelphiCodeCoverage))

* Run on-the-fly analysis in your local development environment using the [DelphiLint](https://github.com/integrated-application-development/delphilint) IDE plugin

### Semantic analysis

SonarDelphi understands what your code *means*, paving the way for powerful rules such as:

   * [Variables must be initialized before being used](delphi-checks/src/main/java/au/com/integradev/delphi/checks/VariableInitializationCheck.java)

   * [Name casing should be kept consistent](delphi-checks/src/main/java/au/com/integradev/delphi/checks/MixedNamesCheck.java)

   * [FreeAndNil must only be passed an instance of a TObject descendant](delphi-checks/src/main/java/au/com/integradev/delphi/checks/FreeAndNilTObjectCheck.java)

   * [Constructors should not be invoked on object variables](delphi-checks/src/main/java/au/com/integradev/delphi/checks/InstanceInvokedConstructorCheck.java)

   * [The Single overloads of the standard math functions should not be used](delphi-checks/src/main/java/au/com/integradev/delphi/checks/MathFunctionSingleOverloadCheck.java)

   * [Redundant casts should not be used](delphi-checks/src/main/java/au/com/integradev/delphi/checks/RedundantCastCheck.java)

   * [Platform-dependent casts should not be used](delphi-checks/src/main/java/au/com/integradev/delphi/checks/PlatformDependentCastCheck.java)

   * [Unicode types should not be cast to ANSI types](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnicodeToAnsiCastCheck.java)

   * ['Format' calls should be supplied arguments of the correct type](delphi-checks/src/main/java/au/com/integradev/delphi/checks/FormatArgumentTypeCheck.java)

   * Your own custom rules to [enforce a naming convention for descendants of specific types](delphi-checks/src/main/java/au/com/integradev/delphi/checks/InheritedTypeNameCheck.java)

   * Your own custom rules to forbid usage of

     [types](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenTypeCheck.java),

     [routines](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenRoutineCheck.java),

     [properties](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenPropertyCheck.java),

     [identifiers](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenIdentifierCheck.java),

     [constants](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenConstantCheck.java),

     [enum values](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenEnumValueCheck.java), or

     [units](delphi-checks/src/main/java/au/com/integradev/delphi/checks/ForbiddenImportFilePatternCheck.java)

### Dead code analysis

Using semantic analysis, SonarDelphi can identify unused code in your project, including:

   * [Unused imports](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedImportCheck.java)

   * [Unused types](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedTypeCheck.java)

   * [Unused routines](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedRoutineCheck.java)

   * [Unused properties](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedPropertyCheck.java)

   * [Unused fields](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedFieldCheck.java)

   * [Unused local variables](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedLocalVariableCheck.java)

   * [Unused constants](delphi-checks/src/main/java/au/com/integradev/delphi/checks/UnusedConstantCheck.java)

### Advanced custom rules

In addition to template rules, SonarDelphi can be extended with custom rules plugins:

  * Leverage the full power of the analysis engine with the SonarDelphi rules API.

  * For more details, see [Writing Custom Delphi Rules](docs/CUSTOM_RULES.md).

## Quickstart

1. Install the following:

    * [SonarQube](https://docs.sonarqube.org/latest/setup/install-server/) (v9.9+)

    * [SonarScanner](https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/)

    * [Delphi](https://www.embarcadero.com/products/delphi)

2. Install the plugin:

    * Download the SonarDelphi plugin

      from [Releases](https://github.com/integrated-application-development/sonar-delphi/releases).

    * [Install the plugin](https://docs.sonarqube.org/latest/setup/install-plugin/) on the SonarQube server.

3. Run analysis on your Delphi project:

    * [Configure](docs/CONFIGURATION.md) your Sonar project, including `sonar.delphi.installationPath`.

    * Execute `sonar-scanner` in your project's directory.

4. View analysis results:

    * Visit the link provided at the end of the scan to view analysis results on SonarQube.

## Read the Manual

The [SonarDelphi Manual](docs/MANUAL.md) provides a comprehensive guide to SonarDelphi and the Sonar ecosystem,

including:

* An introduction to SonarQube

* How to configure SonarDelphi projects and scans

* How to customize analysis rules

> [!TIP]

> It is strongly recommended that first-time SonarQube users read the "SonarQube from first principles"

> section of the manual.

## Contributing

SonarDelphi is open for contributions, from bug reports to new features. For more details, please

read the [contributing guide](docs/CONTRIBUTING.md).

## Development

SonarDelphi can be built with JDK 17+ using [Maven](https://maven.apache.org/).

To build the project and run unit tests, execute the following command from the project's root directory:

```bash

mvn clean install

```

After building, the plugin jar can be found in `sonar-delphi-plugin/target`.

## History

In 2012, [Sabre Airline Solutions](https://www.sabre.com) released SonarDelphi as an open source

project. Over the years, it has been forked and iterated on by various maintainers.

In 2018, it was picked up as a Monash University student project for [IntegraDev](https://www.integradev.com.au).

Since 2019, the project has been actively developed and extensively rewritten by IntegraDev.

## License

Licensed under the [GNU Lesser General Public License, Version 3.0](https://www.gnu.org/licenses/lgpl.txt).