#1871: README.txt (projectforge-common)

Este README sirve como un documento de orientación mínimo para los desarrolladores que exploran el módulo projectforge-common. Su contenido es intencionadamente breve porque este módulo no es una aplicación independiente, sino una librería consumida como dependencia por otros módulos de ProjectForge.

Texto completo

¡Utilice projectforge-webapp para su desarrollo primero!

Este módulo contiene algunas clases comunes de ProjectForge.

No necesita este módulo para desarrollar la aplicación web de ProjectForge.
Está disponible automáticamente a través del repositorio Maven de ProjectForge.

Propósito del módulo

projectforge-common es un módulo de librería fundamental que contiene clases de utilidad compartidas, estructuras de datos y aspectos transversales utilizados en todo el ecosistema de ProjectForge. Incluye:

• Clases de utilidad: BeanHelper, ClassHelper, DateHelper, FileHelper, NumberHelper, CollectionHelper, CanonicalFileUtils
• Manejo de CSV: CSVParser, CSVWriter — implementación CSV personalizada (no Apache Commons CSV)
• Gestión de versiones: Clase Version para representación y comparación de versiones semánticas
• Tipos de datos: Enumeración DateFormatType, enumeración DatabaseDialect
• Diff/Patch: Puerto del algoritmo diff-match-patch de Google
• Registro: SLF4J, puente Log4j2 a SLF4J, Logback
• Dependencias Apache Commons: commons-lang3, commons-beanutils, commons-collections4

Modelo de dependencia

El módulo se publica en un repositorio Maven y es consumido por otros módulos mediante declaraciones de dependencia de Gradle. En los archivos de construcción de Gradle (por ejemplo, build.gradle.kts en otros módulos), se referencia como:

implementation(project(":projectforge-common"))

Esto significa que es una dependencia de proyecto en la construcción multi-módulo de Gradle, y se publica como un artefacto Maven para consumo externo.

Decisión de diseño clave

La instrucción de "utilice projectforge-webapp para su desarrollo primero" indica que projectforge-webapp es el punto de entrada previsto para el desarrollador — proporciona la pila completa de la aplicación web. El módulo projectforge-common es un bloque de construcción, no un punto de partida. Esta arquitectura en capas separa las preocupaciones: las utilidades comunes están aisladas para que herramientas, scripts y complementos puedan depender de ellas sin incluir toda la pila de la aplicación web.

Configuración de construcción

El módulo utiliza el plugin de convenciones de Gradle buildlogic.pf-module-conventions y el plugin Kotlin JVM. Declara dependencias de API en SLF4J, Logback, Log4j2, librerías Apache Commons y Zip4j para el manejo de archivos ZIP.