https://github.com/teragrep/mvn_01

Project archetype for Teragrep
https://github.com/teragrep/mvn_01

teragrep

Last synced: about 1 month ago
JSON representation

Project archetype for Teragrep

• Host: GitHub
• URL: https://github.com/teragrep/mvn_01
• Owner: teragrep
• License: agpl-3.0
• Created: 2024-03-25T09:42:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-06T10:26:58.000Z (3 months ago)
• Last Synced: 2025-03-29T15:01:53.285Z (about 2 months ago)
• Topics: teragrep
• Language: Java
• Homepage: https://teragrep.com
• Size: 86.9 KB
• Stars: 0
• Watchers: 2
• Forks: 4
• Open Issues: 13
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= project-archetype

Project archetype for Teragrep projects.

The `pom.xml` examples are added to the main `pom.xml` file under `..` section.

== Mandatory plugins for java projects

=== checkstyle

Enforces certain coding standards, complements both `enforcer` and `formatter` plugins

=== enforcer

The enforcer plugin forces certain standards in pom.xml

=== formatter (spotless)

Will enforce and can automatically apply proper formatting and licensing information to project files.

Also known as `spotless`

=== rat

The rat plugin is used to enforce existence of correct licenses, will complement formatter plugin

== Other java project plugins

=== jacoco

Provides test coverity reports.

=== equalsverifier

The equals verifier dependency is used in tests to verify whether equals and hashcode overrides are implemented correctly

=== testcontainers

Provides containers for testing use. No need to rely on manually installed and configured external services.

== Other files

=== workflows

Contains fully reusable templates or otherwise useful boilerplate for GitHub workflows

=== example-java-project

Contains example java project that uses mandatory plugins as described above