Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ics-software-engineering/play-new-passcheckstyle
A default play project that passes checkstyle.
https://github.com/ics-software-engineering/play-new-passcheckstyle
Last synced: about 2 months ago
JSON representation
A default play project that passes checkstyle.
- Host: GitHub
- URL: https://github.com/ics-software-engineering/play-new-passcheckstyle
- Owner: ics-software-engineering
- Created: 2013-09-18T01:22:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-09-23T19:52:38.000Z (over 11 years ago)
- Last Synced: 2024-03-27T04:19:22.663Z (10 months ago)
- Language: Java
- Size: 191 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The default Java Play application generated by running the "play new" command contains a number of
stylistic problems, including:* Wildcard imports.
* Superfluous imports (referencing code not used in class).
* No package-level documentation (i.e. no package-info.java files).
* No class or method level JavaDocs.
* Inconsistent indentation.
* Test code is located in the default package.
* View template names (index.scala.html and main.scala.html) compile into Java classes
that violate best practices (i.e. capitalization) for Java class names.
When such an application is processed using Checkstyle with a reasonable ruleset,
approximately 50 warnings are generated.Play-new-passcheckstyle implements a revised version of the default Java Play application
that does not generate any checkstyle warnings and better conforms to Java best practices.You can use the "diff" feature of GitHub to figure out exactly what changes were made.
It would, of course, be awesome if the Play developers fixed the "new" command in some
future release to generate a default application using [best practices for Java coding style](http://en.wikipedia.org/wiki/The_Elements_of_Java_Style).