#1871 : README.txt (projectforge-common)

Ce README sert de document d'orientation minimal pour les développeurs explorant le module projectforge-common. Son contenu est volontairement bref car ce module n'est pas une application autonome — c'est une bibliothèque consommée comme dépendance par d'autres modules ProjectForge.

Texte intégral

Veuillez d'abord utiliser projectforge-webapp pour votre développement !

Ce module contient quelques classes communes de ProjectForge.

Vous n'avez pas besoin de ce module pour développer l'application web de ProjectForge.
Il est automatiquement disponible via le dépôt Maven de ProjectForge.

Objectif du module

projectforge-common est un module de bibliothèque fondamental contenant des classes utilitaires partagées, des structures de données et des préoccupations transversales utilisées dans l'écosystème ProjectForge. Il comprend :

• Classes utilitaires : BeanHelper, ClassHelper, DateHelper, FileHelper, NumberHelper, CollectionHelper, CanonicalFileUtils
• Gestion CSV : CSVParser, CSVWriter — implémentation CSV personnalisée (pas Apache Commons CSV)
• Gestion des versions : classe Version pour la représentation et la comparaison de versions sémantiques
• Types de données : énumération DateFormatType, énumération DatabaseDialect
• Diff/Patch : portage de l'algorithme diff-match-patch de Google
• Journalisation : SLF4J, pont Log4j2 vers SLF4J, Logback
• Dépendances Apache Commons : commons-lang3, commons-beanutils, commons-collections4

Modèle de dépendance

Le module est publié sur un dépôt Maven et consommé par d'autres modules via des déclarations de dépendance Gradle. Dans les fichiers de construction Gradle (par exemple, build.gradle.kts dans d'autres modules), il est référencé comme :

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

Cela signifie qu'il s'agit d'une dépendance de projet dans la construction Gradle multi-modules, et qu'il est publié en tant qu'artefact Maven pour une consommation externe.

Décision de conception clé

L'instruction « utilisez projectforge-webapp pour votre développement en premier » indique que projectforge-webapp est le point d'entrée prévu pour les développeurs — il fournit la pile complète de l'application web. Le module projectforge-common est un élément de base, pas un point de départ. Cette architecture en couches sépare les préoccupations : les utilitaires communs sont isolés afin que les outils, scripts et plugins puissent en dépendre sans entraîner toute la pile de l'application web.

Configuration de construction

Le module utilise le plugin de conventions Gradle buildlogic.pf-module-conventions et le plugin Kotlin JVM. Il déclare des dépendances API sur SLF4J, Logback, Log4j2, les bibliothèques Apache Commons et Zip4j pour la gestion des archives ZIP.