https://github.com/robtimus/checkstyle-extension

Additional Checkstyle checks
https://github.com/robtimus/checkstyle-extension

checkstyle java

Last synced: 2 months ago
JSON representation

Additional Checkstyle checks

• Host: GitHub
• URL: https://github.com/robtimus/checkstyle-extension
• Owner: robtimus
• License: apache-2.0
• Created: 2023-03-12T13:18:20.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-20T12:46:13.000Z (over 1 year ago)
• Last Synced: 2025-01-18T01:45:22.216Z (4 months ago)
• Topics: checkstyle, java
• Language: Java
• Homepage: https://robtimus.github.io/checkstyle-extension/
• Size: 436 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# checkstyle-extension

[![Maven Central](https://img.shields.io/maven-central/v/com.github.robtimus/checkstyle-extension)](https://search.maven.org/artifact/com.github.robtimus/checkstyle-extension)

[![Build Status](https://github.com/robtimus/checkstyle-extension/actions/workflows/build.yml/badge.svg)](https://github.com/robtimus/checkstyle-extension/actions/workflows/build.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.github.robtimus%3Acheckstyle-extension&metric=alert_status)](https://sonarcloud.io/summary/overall?id=com.github.robtimus%3Acheckstyle-extension)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.github.robtimus%3Acheckstyle-extension&metric=coverage)](https://sonarcloud.io/summary/overall?id=com.github.robtimus%3Acheckstyle-extension)

[![Known Vulnerabilities](https://snyk.io/test/github/robtimus/checkstyle-extension/badge.svg)](https://snyk.io/test/github/robtimus/checkstyle-extension)

## Additional Checkstyle checks

| Check                                                                                                            | Description                                                                           |

|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|

| [LicenseComment](https://robtimus.github.io/checkstyle-extension/checks/LicenseComment.html)                     | Checks that Java source files start with a comment with a properly formatted license. |

| [NoBlankLineAfterSymbols](https://robtimus.github.io/checkstyle-extension/checks/NoBlankLineAfterSymbols.html)   | Checks that lines containing only specific symbols are not followed by a blank line.  |

| [NoBlankLineBeforeSymbols](https://robtimus.github.io/checkstyle-extension/checks/NoBlankLineBeforeSymbols.html) | Checks that lines containing only specific symbols are not preceded by a blank line.  |

| [NoSubsequentBlankLines](https://robtimus.github.io/checkstyle-extension/checks/NoSubsequentBlankLines.html)     | Checks that there are no occurrences of two or more blank lines in a row.             |

| [NoTrailingWhitespace](https://robtimus.github.io/checkstyle-extension/checks/NoTrailingWhitespace.html)         | Checks that lines have no trailing whitespace.                                        |

## Maven integration

Add a dependency to your existing `maven-checkstyle-plugin` definition. For instance:

```

  org.apache.maven.plugins

  maven-checkstyle-plugin

  ...

  

    ...

  

  

    

      com.puppycrawl.tools

      checkstyle

      ...

    

    

      com.github.robtimus

      checkstyle-extension

      ...

    

  

  

    ...

  

```

## Eclipse integration

Download the latest JAR file from Maven Central or the [GitHub release page](https://github.com/robtimus/checkstyle-extension/releases), copy it to Eclipse's `dropins` folder, and restart Eclipse.

## IntelliJ integration

First, make sure that you have the [CheckStyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) plugin installed. Next, download the latest JAR file from Maven Central or the [GitHub release page](https://github.com/robtimus/checkstyle-extension/releases). Finally, configure IntelliJ to include it as part of its third-party checks:

* Open `Settings...`

* Open the Checkstyle settings

* Add the JAR under the `Third-Party Checks` section