https://github.com/firebase/scalastyle-maven-plugin

Maven plugin for Scalastyle
https://github.com/firebase/scalastyle-maven-plugin

Last synced: 7 months ago
JSON representation

Maven plugin for Scalastyle

• Host: GitHub
• URL: https://github.com/firebase/scalastyle-maven-plugin
• Owner: firebase
• Archived: true
• Fork: true (scalastyle/scalastyle-maven-plugin)
• Created: 2014-11-25T18:49:28.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-18T18:10:35.000Z (over 11 years ago)
• Last Synced: 2024-09-28T17:01:36.038Z (over 1 year ago)
• Language: Java
• Size: 382 KB
• Stars: 3
• Watchers: 59
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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  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:

 

      

          

          ...

		  

			org.scalastyle

			scalastyle-maven-plugin

			0.1.0

			

			  false

			  true

			  true

			  false

			  ${basedir}/src/main/scala

			  ${basedir}/src/test/scala

			  ${basedir}/lib/scalastyle_config.xml

			

			

			  

				

				  check

				

			  

			

		  

            ...