CheckStyle-IDEA

Compatible with: IntelliJ IDEA MPS Android Studio
Feb 28, 2019
2 025 807

This plugin provides both real-time and on-demand scanning of Java files with CheckStyle from within IDEA.

Recent change notes

  • 5.24.3: Fixed: Blatant white areas in the panel when Darcula in use - thanks to @embee1981 (#432).
  • 5.24.2: Fixed: Fixed a synchronisation edge-case (#425).
  • 5.24.1: Fixed: Some tweaks to the supported Checkstyle versions for better compatibility - thanks to @tsjensen (#424).
  • 5.24.0: Fixed: The plugin should now build & run on JDK 11.
  • 5.24.0: Fixed: We now handle exclamation marks in JAR paths (#412).
  • 5.24.0: Fixed: Rules files are more consistently cached in memory to hopefully alleviate Windows file-locking issues (#417).
  • 5.24.0: Fixed: New version dialogue display is now tracked at application level (#415).
  • 5.24.0: New: Several versions of Checkstyle that have no reported compatibility options with newer versions have been dropped so as to reduce plugin size.
  • 5.24.0: New: Added Checkstyle 8.14, 8.16 (#420).
  • 5.23.0: New: Added Checkstyle 8.13.
  • 5.23.0: Fixed: Error highlighting should be better mapped to IDEA settings (#411).
  • 5.22.1: New: Parse error messages are now displayed more sensibly (#409).
  • 5.22.0: New: Added Checkstyle 8.12.
  • 5.21.1: Fixed: Removed project path detokentisation, instead relying on IDEA's built-in support (#404).
  • 5.21.0: Fixed: SAME_PACKAGE(n) is now handled when importing code styles (#377).
  • 5.21.0: New: Rules files can now be loaded from the Checkstyle classpath (i.e. third-party JARs) (#400).
  • 5.20.0: Fixed: Prevents the plugin from crashing when using SuppressionXpathFilter - thanks to @tduehr (#397).
  • 5.20.0: New: Added Checkstyle 8.10.1, 8.11.
  • 5.19.1: Fixed: Exception when rules file deleted (#396).
  • 5.19.0: New: Added Checkstyle 8.9, 8.10.
  • 5.18.6: Fixed: adding a new location should now use the Checkstyle version selected in the configuration panel.
  • 5.18.5: New: extensions to API to support TestRoots Watchdog (#388).
  • 5.18.4: New: added external API class (#388).
  • 5.18.3: Fixed: the CustomImportOrder importer now deals with the absence of customImportOrderRules (#387).
  • 5.18.2: Fixed: JavadocPackageCheck should work again (#385).
  • 5.18.1: Fixed: Exceptions caught by scan action should now appear in the event log (#383).
  • 5.18.1: Fixed: Added missing DTDs (#381).
  • 5.18.0: New: Added Checkstyle 8.8.
  • 5.17.1: Fixed: Moved update tracking to workspace.
  • 5.17.0: New: Now built against IDEA 2016.1 (was 15.0.6).
  • 5.16.3: New: Improved support for CustomImportOrder (#362). Thanks to Joey Lee (@yeoji).
  • 5.16.3: New: Plugin will notify user on update and point at release notes (#373).
  • 5.16.2: Fixed: Violations now include rule name in the static scan only (#371).
  • 5.16.1: Fixed: DTDs pointing at sourceforge no longer trigger a live lookup (#280).
  • 5.16.0: New: Added CheckStyle 8.6, 8.7.
  • 5.16.0: Fixed: Plugin will now work if in the pre-installed plugin dir (#368).
  • 5.15.0: New: Added CheckStyle 8.5 (#366).
  • 5.14.0: New: Libraries can now be copied, to solve locking issues on Windows (#263). Thanks, yet again, to Thomas Jenson (@tsjenson).
  • 5.13.0: New: Project-relative configurations in the default settings aren't loaded until we're in a project (#333).
  • 5.13.0: Fixed: HTTP reader now has a 5s timeout (#360).
  • 5.13.0: Fixed: More errors should be logged to the event log.
  • 5.12.1: Fixed: Class loading issues that broke JavaDoc checks in Android Studio 3 should now be resolved (#352).
  • 5.12.0: New: Added CheckStyle 8.4.
  • 5.12.0: Fixed: Improved feedback when checker cannot be created.
  • 5.11.0: New: Added CheckStyle 8.3.
  • 5.10.2: New: Checkstyle version numbers now descend, leaving the most useful versions at the top - thanks to @tsjensen (#351).
  • 5.10.2: Fixed: Fully qualified checks with paths are now resolved properly (#349).
  • 5.10.2: Fixed: File normalisation was broken on Windows - thanks to @tsjensen (#351).
  • 5.10.2: Fixed: Test paths on newer versions of IntelliJ should be corrected detected - thanks to @tsjensen (#351).
  • 5.10.1: Fixed: Version check should now work on Java 9 (#346).
  • 5.10.1: Fixed: Modified file results not shown when basedir was configured (#345).
  • 5.10.0: New: Added CheckStyle 8.2 (#343).
  • 5.9.1: New: Cleaned up patch releases of Checkstyle (#340). Thanks, again, to Thomas Jenson (@tsjenson).
  • 5.9.0: New: Added CheckStyle 8.1 (#338).
  • 5.8.2: Fixed: Parent of properties dialogue is now correct (#334).
  • 5.8.2: Fixed: Parse stream errors now correctly show the root exception (#331).
  • 5.8.2: Fixed: Property-only changes are now correctly detected when checking configuration modification state (#331).
  • 5.8.2: New: We attempt to resolve rules files as project relative in the configuration dialogue (#333).
  • 5.8.1: Fixed: Resolved cyclic dependency issue. Thanks to Thomas Jensen (@tsjensen) (#327).
  • 5.8.0: New: Bundled Sun/Google checks are now read from selected version of Checkstyle. Thanks to Thomas Jensen (@tsjensen) (#320).
  • 5.7.0: New: Added CheckStyle 8.0.
  • 5.7.0: Fixed: short identifiers are used in temporary file names to assist with path limits on Windows.
  • 5.6.2: New: code style importer now support avoid star imports - thanks to @zentol (#319).
  • 5.6.2: New: temporary files are now created relative to the project base where possible (#321).
  • 5.6.1: New: code style importer now supports import order - thanks to @zentol (#314).
  • 5.6.1: Fixed: code style importer now adds an extra line between leading content and the package declaration (#315).
  • 5.6.1: Fixed: improved housekeeping when Windows projects are not on the system drive (#313).
  • 5.6.0: New: Added CheckStyle 7.8.1.
  • 5.6.0: Fixed: we now try to use a temporary dir in the project folder when the projects is not on the system drive (#302).
  • 5.5.1: New: File paths are now trimmed (#308).
  • 5.5.0: New: Added CheckStyle 7.7 (#305).
  • 5.4.0: New: Added CheckStyle 7.6.1 (#303).
  • 5.3.1: Fixed: Paths from Checkstyle are now normalised (#302).
  • 5.3.0: New: Added CheckStyle 7.6 (#300).
  • 5.3.0: Fixed: Ignored problems are no longer counting for pre-checkin scan (#299).
  • 5.2.0: New: Added CheckStyle 7.5.1 (#296).
  • 5.2.0: Fixed: Ignored problems are excluded from the inspection results (#287).
  • 5.1.4: Fixed: Ignored problems no longer create phantom nodes in the results view (#287).
  • 5.1.3: Fixed: Supporting file lookup should be consistent when adding files (#293).
  • 5.1.2: Fixed: Property defaults should now work again.
  • 5.1.2: Fixed: Logging classes are now included in the local classpath to hopefully avoid oddities such as #294.
  • 5.1.1: Fixed: Improved handling of cached checkers. Thanks to Thomas Jensen (@tsjensen) (#292).
  • 5.1.0: Fixed: Third-party check now work again. Thanks to Thomas Jensen (@tsjensen) (#286).
  • 5.1.0: New: Added CheckStyle 7.5.
  • 5.0.1: Fixed: Improved handling of IOExceptions from rules files (#285).
  • 5.0.0: New: You can now choose the version of Checkstyle to use. All credit to Thomas Jensen (@tsjensen) (#281).
  • For older changes please see the README.