A yeoman generator for Java projects.
java-bones
is a yeoman-generator for Java
-projects using maven
. java-bones
creates a project that uses
- a GPL3 license,
- static code analysis and reports using
pmd
andcheckstyle
, - a unit-test suite using
JUnit
and logging usinglog4j/slf4j
, - badges for the project status, build status using Travis CI and code coverage using Jacoco,
- custom README.md, TODO.md and VERSIONS.md files and
- a prototype
Main.java
+TestSuite.java
.
The resulting folder-structure looks like this:
|____.codecov.yml
|____.gitattributes
|____.gitignore
|____.travis.yml
|____.yo-rc.json
|____build.sh
|____checkstyle.xml
|____emptyproject4j
|____LICENSE
|____pom.xml
|____README.md
|____ruleset.xml
|____src
| |____main
| | |____java
| | | |____net
| | | | |____groupID
| | | | | |____emptyproject4j
| | | | | | |____Main.java
| |____test
| | |____java
| | | |____net
| | | | |____groupID
| | | | | |____tests
| | | | | | |____emptyproject4j
| | | | | | | |____TestSuite.java
|____TODO.md
|____VERSIONS.md
Yeoman comes with npm
, so install it first and then call:
npm install -g yo
npm install -g generator-java-bones
Once you have the package, you can create a scaffold using:
yo java-bones
This builds the skeleton. Afterwards modify the sources and build the package with:
./${artifactID}
where ${artifactID}
will be the name of your package.
- Simon Dirmeier mail@simon-dirmeier.net