Add jdl enum comments #15364

swarajsaaj · 2021-06-17T19:14:14Z

Adds javadocs to Enum types and enum values from JDL.
Related to #14869

Please make sure the below checklist is followed for Pull Requests.

All continuous integration tests are green
Tests are added where necessary
The JDL part is updated if necessary
jhipster-online is updated if necessary
Documentation is added/updated where necessary
Coding Rules & Commit Guidelines as per our CONTRIBUTING.md document are followed

When you are still working on the PR, consider converting it to Draft (bellow reviewers) and adding skip-ci label, you can still see CI build result at your branch.

swarajsaaj · 2021-06-28T04:35:19Z

Can you please have a look over this @MathieuAA whenever you get some time?
Thanks.

Fix jhipster#1486

Fix jhipster#14869

generators/entity-server/templates/src/main/java/package/domain/enumeration/Enum.java.ejs

MathieuAA · 2021-08-14T15:17:25Z

test/jdl/grammar/grammar.spec.js

@@ -1081,24 +1086,31 @@ entity A {

      it('should parse it', () => {
        expect(parsedEnum).to.deep.equal({
+          javadoc: ' country enum ',


I find it weird the comment isn't trimmed, WDYT? I would have expected it to be country enum.

I tried to keep it in sync with how entity comments are being parsed

generator-jhipster/test/jdl/grammar/grammar.spec.js

Line 568 in 87a393d

javadoc: ' field comment ',

generator-jhipster/test/jdl/grammar/grammar.spec.js

Line 521 in 87a393d

javadoc: ' A comment ',

But I agree there is no use of trailing space, I have now fixed this for entities as well by changing regex in jdl-ast-builder-visitor.js trimComment()

test/jdl/models/jdl-enum.spec.js

Co-authored-by: Mathieu ABOU-AICHI <MathieuAA@users.noreply.github.com>

Trim trailing spaces from JDL parser Related to jhipster#14869

…/generator-jhipster into add-jdl-enum-comments

generators/entity-server/templates/src/main/java/package/domain/enumeration/Enum.java.ejs

MathieuAA · 2021-08-15T15:41:35Z

generators/utils.js

@@ -513,10 +513,11 @@ function getEnumInfo(field, clientRootFolder) {
  const customValuesState = getCustomValuesState(enums);
  return {
    enumName: fieldType,
+    javadoc: field.fieldTypeJavadoc && this.getJavadoc(field.fieldTypeJavadoc, 0),


That is the indentSize.
Not sure if this has any effect as overall generated file seems formatted (with prettier?)

you can always test :) try using 2 instead of 0, or see if 0 can be the default

but if I'm not mistaken, the indent level is important

I just tested :), indent level matters only if we are generating without prettier (i.e. with --skip-prettier). by default it prettifies all the files with proper indentation.
To cover that case I changed the indents to 4 for field javadoc and default to zero for class level javadoc.
Thanks for pointing out.

jdl/models/jdl-enum.js

jdl/parsing/jdl-ast-builder-visitor.js

test/jdl/grammar/grammar.spec.js

…n/enumeration/Enum.java.ejs Co-authored-by: Mathieu ABOU-AICHI <MathieuAA@users.noreply.github.com>

MathieuAA

just one comment which you can resolve if you want, but it's approved! thanks for the work!!

Related to jhipster#14869

swarajsaaj · 2021-08-16T19:19:43Z

@MathieuAA Thanks for approving, I also added the indentation for cases when prettier is not run (using --skip-prettier) and the test case update for indented javadoc.
Pipeline seems failing due to unrelated cause (maybe a retrigger fixes it)

DanielFran · 2021-08-16T19:46:29Z

@swarajsaaj Relaunched failing tests...

mshima

Ident adjusts

generators/entity-server/templates/src/main/java/package/domain/enumeration/Enum.java.ejs

DanielFran · 2021-08-31T18:23:16Z

Let's merge this since @mshima fixed lint issues

DanielFran · 2021-08-31T18:23:50Z

Thanks @swarajsaaj for the contribution

swarajsaaj · 2021-09-01T05:52:42Z

Thanks @DanielFran for merging and committing the suggestions.
Thanks @MathieuAA and @mshima for reviews.

pascalgrimaud · 2021-09-11T17:05:48Z

I was on vacations and didn't manage to follow everything.
There is a lot of work done here, so it deserves a bounty.

Plz claim it @swarajsaaj

swarajsaaj · 2021-09-13T17:04:28Z

Thanks @pascalgrimaud 😄 , i claim the bounty at at https://opencollective.com/generator-jhipster/expenses/49963

pascalgrimaud · 2021-09-13T17:05:37Z

@swarajsaaj : approved :-) thanks for your hard work

DanielFran added area: enhancement 🔧 theme: JDL labels Jun 17, 2021

DanielFran requested a review from MathieuAA June 17, 2021 19:26

mshima closed this Jun 17, 2021

mshima reopened this Jun 17, 2021

github-actions bot added the Stale label Jul 29, 2021

github-actions bot closed this Aug 5, 2021

mshima reopened this Aug 5, 2021

swarajsaaj added 5 commits August 8, 2021 23:18

Add enum level javadocs from JDL

18d38be

Fix jhipster#1486

Add comments on enum values from JDL

05dea0a

Fix jhipster#14869

Add enum javadoc to exported JDL

99e7d31

Fix no comment handling in enum [jdl]

733070a

Fix jhipster#14869

Add enum comments test cases

d2e339a

Fix jhipster#14869

swarajsaaj force-pushed the add-jdl-enum-comments branch from 4876866 to d2e339a Compare August 8, 2021 17:48

MathieuAA reviewed Aug 14, 2021

View reviewed changes

swarajsaaj and others added 3 commits August 15, 2021 12:40

Apply suggestions from code review

a56370c

Co-authored-by: Mathieu ABOU-AICHI <MathieuAA@users.noreply.github.com>

Trim javadoc comments from JDL

060c561

Trim trailing spaces from JDL parser Related to jhipster#14869

Merge branch 'add-jdl-enum-comments' of https://github.com/swarajsaaj…

cd3deb4

…/generator-jhipster into add-jdl-enum-comments

swarajsaaj requested a review from MathieuAA August 15, 2021 08:29

MathieuAA reviewed Aug 15, 2021

View reviewed changes

Update generators/entity-server/templates/src/main/java/package/domai…

c3d673c

…n/enumeration/Enum.java.ejs Co-authored-by: Mathieu ABOU-AICHI <MathieuAA@users.noreply.github.com>

swarajsaaj requested a review from MathieuAA August 15, 2021 16:43

MathieuAA removed the Stale label Aug 15, 2021

MathieuAA approved these changes Aug 15, 2021

View reviewed changes

swarajsaaj added 2 commits August 17, 2021 00:01

Fix formatting in Enums without prettier

a910cd6

Related to jhipster#14869

Fix test case for indented comments on enum fields

170401c

Related to jhipster#14869

mshima reviewed Aug 30, 2021

View reviewed changes

Lint

5ab8394

DanielFran merged commit c9b4cc0 into jhipster:main Aug 31, 2021

pascalgrimaud added this to the 7.2.0 milestone Sep 11, 2021

pascalgrimaud added $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ $300 https://www.jhipster.tech/bug-bounties/ labels Sep 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add jdl enum comments #15364

Add jdl enum comments #15364

swarajsaaj commented Jun 17, 2021 •

edited

Loading

swarajsaaj commented Jun 28, 2021

MathieuAA Aug 14, 2021

swarajsaaj Aug 15, 2021

MathieuAA Aug 15, 2021

swarajsaaj Aug 15, 2021

MathieuAA Aug 15, 2021

swarajsaaj Aug 16, 2021

MathieuAA left a comment

swarajsaaj commented Aug 16, 2021

DanielFran commented Aug 16, 2021

mshima left a comment

DanielFran commented Aug 31, 2021

DanielFran commented Aug 31, 2021

swarajsaaj commented Sep 1, 2021

pascalgrimaud commented Sep 11, 2021

swarajsaaj commented Sep 13, 2021

pascalgrimaud commented Sep 13, 2021

Add jdl enum comments #15364

Add jdl enum comments #15364

Conversation

swarajsaaj commented Jun 17, 2021 • edited Loading

swarajsaaj commented Jun 28, 2021

MathieuAA Aug 14, 2021

Choose a reason for hiding this comment

swarajsaaj Aug 15, 2021

Choose a reason for hiding this comment

MathieuAA Aug 15, 2021

Choose a reason for hiding this comment

swarajsaaj Aug 15, 2021

Choose a reason for hiding this comment

MathieuAA Aug 15, 2021

Choose a reason for hiding this comment

swarajsaaj Aug 16, 2021

Choose a reason for hiding this comment

MathieuAA left a comment

Choose a reason for hiding this comment

swarajsaaj commented Aug 16, 2021

DanielFran commented Aug 16, 2021

mshima left a comment

Choose a reason for hiding this comment

DanielFran commented Aug 31, 2021

DanielFran commented Aug 31, 2021

swarajsaaj commented Sep 1, 2021

pascalgrimaud commented Sep 11, 2021

swarajsaaj commented Sep 13, 2021

pascalgrimaud commented Sep 13, 2021

swarajsaaj commented Jun 17, 2021 •

edited

Loading