List of enum values in enum Javadoc (#400)

Author: vojtechhabarta

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java

@@ -67,6 +67,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 
 /**
@@ -143,6 +144,7 @@ public TsModel javaToTypeScript(Model model) {
 
         // enums
         tsModel = applyExtensionTransformers(symbolTable, tsModel, TransformationPhase.BeforeEnums, extensionTransformers);
+        tsModel = addEnumValuesToJavadoc(tsModel);
         if (!settings.areDefaultStringEnumsOverriddenByExtension()) {
             if (settings.mapEnum == null || settings.mapEnum == EnumMapping.asUnion || settings.mapEnum == EnumMapping.asInlineUnion) {
                 tsModel = transformEnumsToUnions(tsModel);
@@ -824,6 +826,37 @@ private TsModel transformEnumsToNumberBasedEnum(TsModel tsModel) {
         return tsModel.withoutEnums(stringEnums).withEnums(new ArrayList<>(enums));
     }
 
+    private static TsModel addEnumValuesToJavadoc(TsModel tsModel) {
+        return tsModel.withEnums(tsModel.getEnums().stream()
+                .map(enumModel -> addEnumValuesToJavadoc(enumModel))
+                .collect(Collectors.toList())
+        );
+    }
+
+    private static TsEnumModel addEnumValuesToJavadoc(TsEnumModel enumModel) {
+        final boolean hasComments = enumModel.getComments() != null && !enumModel.getComments().isEmpty();
+        final boolean hasMemberComments = enumModel.getMembers().stream()
+                .anyMatch(enumMember -> enumMember.getComments() != null && !enumMember.getComments().isEmpty());
+        if (hasComments || hasMemberComments) {
+            return enumModel.withComments(Stream
+                    .of(
+                            Utils.listFromNullable(enumModel.getComments()).stream(),
+                            (hasComments ? Stream.of("") : Stream.<String>empty()),
+                            Stream.of("Values:"),
+                            enumModel.getMembers().stream()
+                                    .map(enumMember -> "- `" + enumMember.getEnumValue() + "`"
+                                            + (enumMember.getComments() != null
+                                            ? " - " + String.join(" ", enumMember.getComments())
+                                            : ""))
+                    )
+                    .flatMap(s -> s)
+                    .collect(Collectors.toList())
+            );
+        } else {
+            return enumModel;
+        }
+    }
+
     private TsModel createAndUseTaggedUnions(final SymbolTable symbolTable, TsModel tsModel) {
         if (settings.disableTaggedUnions) {
             return tsModel;

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/emitter/TsDeclarationModel.java

@@ -3,6 +3,7 @@
 
 import cz.habarta.typescript.generator.compiler.Symbol;
 import java.util.List;
+import java.util.Objects;
 
 
 public class TsDeclarationModel implements Comparable<TsDeclarationModel> {
@@ -15,7 +16,7 @@ public class TsDeclarationModel implements Comparable<TsDeclarationModel> {
     public TsDeclarationModel(Class<?> origin, TsBeanCategory category, Symbol name, List<String> comments) {
         this.origin = origin;
         this.category = category;
-        this.name = name;
+        this.name = Objects.requireNonNull(name);
         this.comments = comments;
     }
 

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/emitter/TsEnumModel.java

@@ -6,6 +6,7 @@
 import cz.habarta.typescript.generator.compiler.Symbol;
 import cz.habarta.typescript.generator.parser.EnumModel;
 import java.util.List;
+import java.util.Objects;
 
 
 public class TsEnumModel extends TsDeclarationModel {
@@ -14,15 +15,10 @@ public class TsEnumModel extends TsDeclarationModel {
     private final List<EnumMemberModel> members;
     private final boolean isNonConstEnum;
 
-    @Deprecated
-    public TsEnumModel(Class<?> origin, Symbol name, EnumKind kind, List<EnumMemberModel> members, List<String> comments) {
-        this(origin, name, kind, members, comments, false);
-    }
-
     public TsEnumModel(Class<?> origin, Symbol name, EnumKind kind, List<EnumMemberModel> members, List<String> comments, boolean isNonConstEnum) {
         super(origin, null, name, comments);
-        this.kind = kind;
-        this.members = members;
+        this.kind = Objects.requireNonNull(kind);
+        this.members = Objects.requireNonNull(members);
         this.isNonConstEnum = isNonConstEnum;
     }
 
@@ -46,4 +42,8 @@ public TsEnumModel withMembers(List<EnumMemberModel> members) {
         return new TsEnumModel(origin, name, kind, members, comments, isNonConstEnum);
     }
 
+    public TsEnumModel withComments(List<String> comments) {
+        return new TsEnumModel(origin, name, kind, members, comments, isNonConstEnum);
+    }
+
 }

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/DummyEnum.java

@@ -6,5 +6,20 @@
  * Documentation for DummyEnum.
  */
 public enum DummyEnum {
-    Red, Green, Blue
+
+    /**
+     * ff0000
+     */
+    Red,
+
+    /**
+     * 00ff00
+     */
+    Green,
+
+    /**
+     * 0000ff
+     */
+    Blue;
+
 }

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JavadocTest.java

@@ -54,9 +54,11 @@ public void testJavadoc() {
             Assert.assertTrue(generated.contains("Documentation for interface getter property."));
             Assert.assertTrue(generated.contains("@return value of getterPropery"));
             Assert.assertTrue(generated.contains("@deprecated replaced by something else"));
-
             Assert.assertTrue(generated.contains(" *     // indentation and line breaks are kept\n * \n *     {@literal @}"));
             Assert.assertTrue(generated.contains(" *     public List<String> generics() {\n"));
+            Assert.assertTrue(generated.contains("ff0000"));
+            Assert.assertTrue(generated.contains("00ff00"));
+            Assert.assertTrue(generated.contains("0000ff"));
         }
         {
             final String generated = new TypeScriptGenerator(settings).generateTypeScript(Input.from(ClassWithBrElements.class));