# scalastyle-maven-plugin

**Repository Path**: mirrors_neo4j/scalastyle-maven-plugin

## Basic Information

- **Project Name**: scalastyle-maven-plugin
- **Description**: Maven plugin for Scalastyle
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## maven-scalastyle-plugin
Welcome to maven-scalastyle-plugin.
This project is intended to provide maven plugin support for Scalastyle.
For more information about Scalastyle, see [https://github.com/scalastyle/scalastyle](https://github.com/scalastyle/scalastyle)

## Goals Overview
* **scalastyle:check** performs a violation check against the scalastyle config file to see if there are any violations. 
It counts the number of violations found and displays it on the console if verbose is enabled.

## Usage
### Check scalacheck violation part of build cycle
To Configure the Scalastyle Plugin, you need to the add it in the <build> section of your pom.xml as shown in the sample below,
and by default the build will fail if there are any violations of level error found.
Default phase of execution is `verify`. The following is an example of a configuration which would be used in a pom:

```xml
    <build>
        <plugins> 
          ...
          <plugin>
            <groupId>org.neo4j</groupId>
            <artifactId>scalastyle-maven-plugin</artifactId>
            <version>0.8.0</version>
            <configuration>
              <verbose>false</verbose>
              <failOnViolation>true</failOnViolation>
              <includeTestSourceDirectory>true</includeTestSourceDirectory>
              <failOnWarning>false</failOnWarning>
              <sourceDirectory>${project.basedir}/src/main/scala</sourceDirectory>
              <testSourceDirectory>${project.basedir}/src/test/scala</testSourceDirectory>
              <configLocation>${project.basedir}/lib/scalastyle_config.xml</configLocation>
              <testConfigLocation>${project.basedir}/lib/scalastyle_test_config.xml</testConfigLocation>
              <outputFile>${project.basedir}/scalastyle-output.xml</outputFile>
              <outputEncoding>UTF-8</outputEncoding>
            </configuration>
            <executions>
              <execution>
                <goals>
                  <goal>check</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
          ...
        </plugins>
    </build>
```

You can also specify multiple source directories if necessary. Replace the <sourceDirectory> element with <sourceDirectories>:

```xml
    <sourceDirectories>
      <dir>${project.basedir}/src/main/scala</dir>
      <dir>${project.basedir}/src/main/generated-scala</dir>
    </sourceDirectories>
```

and similarly for `testSourceDirectory` & `testSourceDirectories`.