Gradle Java Templates

Table of Contents

• How to use
• Project Structure
• License
• Code Quality
• Code Formatting
• Asciidoctor for docs
• IDE
• Git Hooks
• Java

How to use

• Install python and pip

  sudo apt-get install python python-pip -y

• Install cookiecutter

  sudo pip install -U cookiecutter

Then

cookiecutter https://github.com/arulrajnet/cookiecutter-gradle-java-template

The output screen would be

copyright_name [My Dream Inc.,]: JCrawler Inc.,
Select license:
1 - Proprietary
2 - MIT
3 - GNU GPL v3.0
4 - Apache Software License 2.0
Choose from 1, 2, 3, 4 [1]: 1
project_display_name [My Java App]: Crawler App
project_name [myapp]: jcrawler
package_name [com.githup.mydream]: io.jcrawler.app
project_short_description [A cookiecutter template for creating reusable Java projects quickly]: To Be Done

Project Structure

jcrawler
├── gradle (1)
│   ├── config
│   │   ├── git (2)
│   │   └── jdepend (3)
│   └── wrapper
└── src
    ├── docs
    │   └── asciidoc (4)
    │       └── stylesheets
    ├── main
    │   ├── java
    │   │   └── io
    │   │       └── jcrawler
    │   │           └── app (5)
    │   └── resources
    └── test
        ├── java
        │   └── io
        │       └── jcrawler
        │           └── app (6)
        └── resources

1. All gradle related files

2. Git hooks

3. Jdepend style sheet

4. Asciidoc files for the project

5. Source files.

6. Test files.

License

Selecting license for a project is configurable. Supported licenses are

• MIT

• GNU GPL v3.0

• Apache Software License 2.0

• Proprietary.

By default Proprietary is selected.

License text are from https://choosealicense.com/ and https://opensource.org/licenses/

License plugin configured in license.gradle

Code Quality

The following code analysis tools are configured in quality.gradle

• PMD

• CheckStyle

• FindBugs

• JDepend

• JaCoCo

• Sonar

Code Formatting

Code formatting done using Spotless which is configured in spotless.gradle

Asciidoctor for docs

Docs for project can be written in AssciiDoctor

Gradle configuration in doc.gradle

IDE

Both Eclipse and IntelliJ are configured in ide.gradle

Git Hooks

commit-msg and pre-push git hooks are configured in git.gradle

Java

Java 1.8

Gradle 3.5