[JPA] Donner la possibilité de masque l'annotation @generated

klee-contrib · Jun 25, 2024 · 78cd90a · 78cd90a
1 parent e8fd3bc
commit 78cd90a
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 16 deletions.
diff --git a/TopModel.Generator.Jpa/JpaConfig.cs b/TopModel.Generator.Jpa/JpaConfig.cs
@@ -75,6 +75,11 @@ public class JpaConfig : GeneratorConfigBase
     /// </summary>
     public bool AssociationRemovers { get; set; } = false;
 
+    /// <summary>
+    /// Option pour générer l'annotation @Generated("TopModel : https://github.com/klee-contrib/topmodel")
+    /// </summary>
+    public bool GeneratedHint { get; set; } = true;
+
     /// <summary>
     /// Option pour générer une enum des champs des classes persistées
     /// </summary>

diff --git a/TopModel.Generator.Jpa/JpaMapperGenerator.cs b/TopModel.Generator.Jpa/JpaMapperGenerator.cs
@@ -54,8 +54,12 @@ protected override void HandleFile(string fileName, string tag, IList<(Class Cla
         }
 
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine($@"public class {Config.GetMapperName(mapperNs, modelPath)} {{");
 
         fw.WriteLine();

diff --git a/TopModel.Generator.Jpa/JpaModelGenerator.cs b/TopModel.Generator.Jpa/JpaModelGenerator.cs
@@ -190,8 +190,11 @@ private void WriteAnnotations(JavaWriter fw, Class classe, string tag)
         fw.WriteDocStart(0, classe.Comment);
         fw.WriteDocEnd(0);
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
 
         if (classe.IsPersistent)
         {

diff --git a/TopModel.Generator.Jpa/JpaModelInterfaceGenerator.cs b/TopModel.Generator.Jpa/JpaModelInterfaceGenerator.cs
@@ -41,8 +41,12 @@ protected override void HandleClass(string fileName, Class classe, string tag)
         var extends = Config.GetClassExtends(classe);
         var implements = Config.GetClassImplements(classe);
 
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine($"public interface {classe.NamePascal} {{");
 
         WriteGetters(fw, classe, tag);

diff --git a/TopModel.Generator.Jpa/SpringClientApiGenerator.cs b/TopModel.Generator.Jpa/SpringClientApiGenerator.cs
@@ -46,8 +46,12 @@ protected override void HandleFile(string filePath, string fileName, string tag,
         }
 
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine($"public interface {className} {{");
 
         fw.WriteLine();

diff --git a/TopModel.Generator.Jpa/SpringDataFlowGenerator.cs b/TopModel.Generator.Jpa/SpringDataFlowGenerator.cs
@@ -304,8 +304,12 @@ private void WriteClassFlow(string fileName, DataFlow dataFlow, string tag)
         fw.WriteLine();
         fw.WriteLine("@Configuration");
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteClassDeclaration($"{dataFlow.Name}Flow", null);
         fw.WriteLine();
         fw.WriteLine(1, $@"protected {dataFlow.Name}Flow() {{");
@@ -349,8 +353,12 @@ private void WriteModuleConfig(string module, IEnumerable<DataFlow> flows)
         fw.WriteLine();
         fw.WriteLine("@Configuration");
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine(@$"@Import({{{string.Join(", ", flows.Select(f => $@"{f.Name.ToPascalCase()}Flow.class"))}}})");
 
         var className = configFilePath.Split("\\").Last().Split('.').First();

diff --git a/TopModel.Generator.Jpa/SpringRestTemplateApiGenerator.cs b/TopModel.Generator.Jpa/SpringRestTemplateApiGenerator.cs
@@ -41,8 +41,12 @@ protected override void HandleFile(string filePath, string fileName, string tag,
         fw.WriteLine();
 
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine($"public abstract class {className} {{");
 
         fw.WriteLine();

diff --git a/TopModel.Generator.Jpa/SpringServerApiGenerator.cs b/TopModel.Generator.Jpa/SpringServerApiGenerator.cs
@@ -46,8 +46,12 @@ protected override void HandleFile(string filePath, string fileName, string tag,
         }
 
         var javaOrJakarta = Config.PersistenceMode.ToString().ToLower();
-        fw.AddImport($"{javaOrJakarta}.annotation.Generated");
-        fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        if (Config.GeneratedHint)
+        {
+            fw.AddImport($"{javaOrJakarta}.annotation.Generated");
+            fw.WriteLine("@Generated(\"TopModel : https://github.com/klee-contrib/topmodel\")");
+        }
+
         fw.WriteLine($"public interface {className} {{");
 
         fw.WriteLine();

diff --git a/TopModel.Generator.Jpa/jpa.config.json b/TopModel.Generator.Jpa/jpa.config.json
@@ -192,6 +192,11 @@
       "description": "Option pour générer des méthodes de suppression pour les associations oneToMany et manyToMany. Ces méthodes permettent de synchroniser les objets supprimés",
       "default": "false"
     },
+    "generatedHint": {
+      "type": "boolean",
+      "description": "Option pour générer l'annotation @Generated('TopModel : https://github.com/klee-contrib/topmodel')",
+      "default": "true"
+    },
     "fieldsEnum": {
       "type": "string",
       "description": "Option pour générer une enum des champs des classes persistées",

diff --git a/docs/generator/jpa.md b/docs/generator/jpa.md
@@ -636,6 +636,12 @@ Le générateur créé un fichier de configuration de job par module. Ce job ord
 
   _Valeur par défaut_: `false`
 
+- `generatedHint`
+
+  Option pour générer l'annotation @Generated("TopModel : https://github.com/klee-contrib/topmodel")
+
+  _Valeur par défaut_: `true`
+
 - `persistenceMode`
 
   Mode de génération de la persistence (`"javax"` ou `"jakarta"`).