Skip to content

Israiloff/checkstyle-rules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maven Central

Checkstyle

Code checking rules for matching code conventions of company. Must be used as part of Apache Checkstyle plugin. To configure this plugin you must add Apache Checkstyle plugin into your project (pom.xml/gradle.json). Then just include this plugin into the dependencies of Apache Checkstyle plugin.

Example in pom.xml:

<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    ...
    <build>
        <plugins>
            ...
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>APACHE_CHECKSTYLE_VERSION</version>
                <executions>
                    <execution>
                        <id>validate</id>
                        <phase>validate</phase>
                        <configuration>
                            <configLocation>checkstyle.config.xml</configLocation>
                            <consoleOutput>true</consoleOutput>
                            <failsOnError>true</failsOnError>
                        </configuration>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>io.github.israiloff</groupId>
                        <artifactId>checkstyle-rules</artifactId>
                        <version>CHECKSTYLE_RULES_VERSION</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

APACHE_CHECKSTYLE_VERSION is version of Apache Checkstyle plugin. CHECKSTYLE_RULES_VERSION is version of this plugin.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Languages