Project icon

com.io7m.checkstyle_rules

Build status Maven Central

The checkstyle_rules package provides a common set of Checkstyle rules for io7m projects.

Contents

Features

  • ISC license

Releases

The most recently published version of the software is 1.2.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 1.2.0 release is available for reading online.

Documentation for current and older releases is archived in the repository.

Documentation

Configure the maven-checkstyle-plugin:

<plugin>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>2.17</version>
  <executions>
    <execution>
      <id>validate</id>
      <phase>process-sources</phase>
      <goals>
        <goal>check</goal>
      </goals>
      <configuration>
        <configLocation>/com/io7m/checkstyle_rules/checkstyle.xml</configLocation>
        <encoding>UTF-8</encoding>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
      </configuration>
    </execution>
  </executions>
  <dependencies>
    <dependency>
      <groupId>com.io7m.checkstyle_rules</groupId>
      <artifactId>com.io7m.checkstyle_rules</artifactId>
      <version>0.0.1</version>
    </dependency>
    <dependency>
      <groupId>com.puppycrawl.tools</groupId>
      <artifactId>checkstyle</artifactId>
      <version>8.5</version>
    </dependency>
  </dependencies>
</plugin>

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.checkstyle_rules</groupId>
  <artifactId>com.io7m.checkstyle_rules</artifactId>
  <version>1.2.0</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2021-05-02 Release: com.io7m.checkstyle_rules 1.2.0
2021-05-02 Change: Ensure missing JavaDoc checks apply only to public methods
2021-05-02 Release: com.io7m.checkstyle_rules 1.1.0
2021-05-02 Change: Enable checks for missing JavaDoc
2020-04-03 Release: com.io7m.checkstyle_rules 1.0.0
2019-06-15 Release: com.io7m.checkstyle_rules 0.0.3
2019-06-15 Change: Allow camelCase in variable names (tickets: 1 )
2018-03-06 Release: com.io7m.checkstyle_rules 0.0.2
2018-03-06 Change: Only check headers in Java source files
2018-02-13 Release: com.io7m.checkstyle_rules 0.0.1
2018-02-13 Change: Require commas at EOL, require dots on new lines

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/checkstyle_rules

$ git clone https://github.com/io7m/checkstyle_rules

License

Copyright © 2021 Mark Raynsford <code@io7m.com> http://io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.