Merge pull request #64 from ZeroErrors/master

Add annotationFilters and displaySerializerWarning settings

Author: vojtechhabarta

.gitignore

@@ -10,3 +10,7 @@ release.properties
 **.classpath
 **.project
 **.settings
+
+# JetBrain IntelliJ
+.idea/
+**.iml

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java

@@ -38,8 +38,10 @@ public class Settings {
     public boolean noFileComment = false;
     public List<File> javadocXmlFiles = null;
     public List<EmitterExtension> extensions = new ArrayList<>();
+    public List<Class<? extends Annotation>> includePropertyAnnotations = new ArrayList<>();
     public List<Class<? extends Annotation>> optionalAnnotations = new ArrayList<>();
     public boolean experimentalInlineEnums = false;
+    public boolean displaySerializerWarning = true;
 
 
     public void loadCustomTypeProcessor(ClassLoader classLoader, String customTypeProcessor) {
@@ -54,6 +56,12 @@ public void loadExtensions(ClassLoader classLoader, List<String> extensions) {
         }
     }
 
+    public void loadIncludePropertyAnnotations(ClassLoader classLoader, List<String> includePropertyAnnotations) {
+        if (includePropertyAnnotations != null) {
+            this.includePropertyAnnotations = loadClasses(classLoader, includePropertyAnnotations, Annotation.class);
+        }
+    }
+
     public void loadOptionalAnnotations(ClassLoader classLoader, List<String> optionalAnnotations) {
         if (optionalAnnotations != null) {
             this.optionalAnnotations = loadClasses(classLoader, optionalAnnotations, Annotation.class);

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Jackson1Parser.java

@@ -45,6 +45,19 @@ protected BeanModel parseBean(SourceType<Class<?>> sourceClass) {
                     if (propertyType == JsonNode.class) {
                         propertyType = Object.class;
                     }
+                    boolean isInAnnotationFilter = settings.includePropertyAnnotations.isEmpty();
+                    if (!isInAnnotationFilter) {
+                        for (Class<? extends Annotation> optionalAnnotation : settings.includePropertyAnnotations) {
+                            if (beanPropertyWriter.getAnnotation(optionalAnnotation) != null) {
+                                isInAnnotationFilter = true;
+                                break;
+                            }
+                        }
+                        if (!isInAnnotationFilter) {
+                            System.out.println("Skipping " + sourceClass.type + "." + beanPropertyWriter.getName() + " because it is missing an annotation from includePropertyAnnotations!");
+                            continue;
+                        }
+                    }
                     boolean optional = false;
                     for (Class<? extends Annotation> optionalAnnotation : settings.optionalAnnotations) {
                         if (beanPropertyWriter.getAnnotation(optionalAnnotation) != null) {

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Jackson2Parser.java

@@ -32,6 +32,19 @@ protected BeanModel parseBean(SourceType<Class<?>> sourceClass) {
                     if (propertyType == JsonNode.class) {
                         propertyType = Object.class;
                     }
+                    boolean isInAnnotationFilter = settings.includePropertyAnnotations.isEmpty();
+                    if (!isInAnnotationFilter) {
+                        for (Class<? extends Annotation> optionalAnnotation : settings.includePropertyAnnotations) {
+                            if (beanPropertyWriter.getAnnotation(optionalAnnotation) != null) {
+                                isInAnnotationFilter = true;
+                                break;
+                            }
+                        }
+                        if (!isInAnnotationFilter) {
+                            System.out.println("Skipping " + sourceClass.type + "." + beanPropertyWriter.getName() + " because it is missing an annotation from includePropertyAnnotations!");
+                            continue;
+                        }
+                    }
                     boolean optional = false;
                     for (Class<? extends Annotation> optionalAnnotation : settings.optionalAnnotations) {
                         if (beanPropertyWriter.getAnnotation(optionalAnnotation) != null) {
@@ -104,7 +117,9 @@ private BeanHelper getBeanHelper(Class<?> beanClass) {
                 return new BeanHelper((BeanSerializer) jsonSerializer);
             } else {
                 final String jsonSerializerName = jsonSerializer.getClass().getName();
-                System.out.println(String.format("Warning: Unknown serializer '%s' for class '%s'", jsonSerializerName, beanClass));
+                if (settings.displaySerializerWarning) {
+                    System.out.println(String.format("Warning: Unknown serializer '%s' for class '%s'", jsonSerializerName, beanClass));
+                }
                 return null;
             }
         } catch (JsonMappingException e) {

typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java

@@ -22,6 +22,7 @@ public class GenerateTask extends DefaultTask {
     public String classesFromJaxrsApplication;
     public boolean classesFromAutomaticJaxrsApplication;
     public List<String> excludeClasses;
+    public List<String> includePropertyAnnotations;
     public JsonLibrary jsonLibrary;
     public boolean declarePropertiesAsOptional;
     public String removeTypeNamePrefix;
@@ -41,6 +42,7 @@ public class GenerateTask extends DefaultTask {
     public List<String> extensionClasses;
     public List<String> optionalAnnotations;
     public boolean experimentalInlineEnums;
+    public boolean displaySerializerWarning = true;
 
     @TaskAction
     public void generate() throws Exception {
@@ -91,8 +93,10 @@ public void generate() throws Exception {
         settings.noFileComment = noFileComment;
         settings.javadocXmlFiles = javadocXmlFiles;
         settings.loadExtensions(classLoader, extensionClasses);
+        settings.loadIncludePropertyAnnotations(classLoader, includePropertyAnnotations);
         settings.loadOptionalAnnotations(classLoader, optionalAnnotations);
         settings.experimentalInlineEnums = experimentalInlineEnums;
+        settings.displaySerializerWarning = displaySerializerWarning;
         settings.validateFileName(new File(outputFile));
 
         // TypeScriptGenerator

typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java

@@ -94,6 +94,13 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private List<String> excludeClasses;
 
+    /**
+     * If this list is not empty then TypeScript will only be generated for
+     * methods with one of the annotations defined in this list
+     */
+    @Parameter
+    private List<String> includePropertyAnnotations;
+
     /**
      * Library used in JSON classes.
      * Supported values are 'jackson1', 'jackson2'.
@@ -237,6 +244,12 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private boolean experimentalInlineEnums;
 
+    /**
+     * Display warnings when bean serializer is not found.
+     */
+    @Parameter(defaultValue = "true")
+    private boolean displaySerializerWarning;
+
     @Parameter(defaultValue = "${project}", readonly = true, required = true)
     private MavenProject project;
 
@@ -278,8 +291,10 @@ public void execute() {
             settings.noFileComment = noFileComment;
             settings.javadocXmlFiles = javadocXmlFiles;
             settings.loadExtensions(classLoader, extensions);
+            settings.loadIncludePropertyAnnotations(classLoader, includePropertyAnnotations);
             settings.loadOptionalAnnotations(classLoader, optionalAnnotations);
             settings.experimentalInlineEnums = experimentalInlineEnums;
+            settings.displaySerializerWarning = displaySerializerWarning;
             settings.validateFileName(outputFile);
 
             // TypeScriptGenerator