README.md

java-base-project

Esta es una plantilla de proyecto diseñada para:

• Java 17. ⚠️ Si bien el proyecto no lo limita explícitamente, el comando mvn verify no funcionará con versiones más antiguas de Java.
• JUnit 5. ⚠️ La versión 5 de JUnit es la más nueva del framework y presenta algunas diferencias respecto a la versión "clásica" (JUnit 4). Para mayores detalles, ver:
  • Apunte de herramientas
  • Entrada de Blog (en inglés)
  • Entrada de Blog (en español)
• Maven 3.8.1 o superior

Ejecutar tests

mvn test

Validar el proyecto de forma exahustiva

mvn clean verify

Este comando hará lo siguiente:

1. Ejecutará los tests
2. Validará las convenciones de formato mediante checkstyle
3. Detectará la presencia de (ciertos) code smells
4. Validará la cobertura del proyecto

Entrega del proyecto

Para entregar el proyecto, crear un tag llamado entrega-final. Es importante que antes de realizarlo se corra la validación explicada en el punto anterior. Se recomienda hacerlo de la siguiente forma:

mvn clean verify && git tag entrega-final && git push origin HEAD --tags

Configuración del IDE (IntelliJ)

Usar el SDK de Java 17

1. En File/Project Structure..., ir a Project Settings | Project
2. En Project SDK seleccionar la versión 17 y en Project language level seleccionar 17 - Sealed types, always-strict floating-point semantics

Usar fin de linea unix

1. En File/Settings..., ir a Editor | Code Style.
2. En la lista Line separator, seleccionar Unix and OS X (\n).

Tabular con dos espacios

1. En File/Settings..., ir a Editor | Code Style | Java | Tabs and Indents.
2. Cambiar Tab size, Indent y Continuation indent a 2, 2 y 4 respectivamente:

Ordenar los imports

1. En File/Settings..., ir a Editor | Code Style | Java | Imports.
2. Cambiar Class count to use import with '*' y Names count to use static import with '*' a un número muy alto (ej: 99).
3. En Import Layout, dejarlo como se muestra a continuación:
   • import static all other imports
   • <blank line>
   • import all other imports

Instalar y configurar Checkstyle

1. Instalar el plugin https://plugins.jetbrains.com/plugin/1065-checkstyle-idea:
2. En File/Settings..., ir a Tools | Checkstyle.
3. Configurarlo activando los Checks de Google y la versión de Checkstyle == 9.0.1: