spring-configuration-property-documenter icon indicating copy to clipboard operation
spring-configuration-property-documenter copied to clipboard

Option to order the groups and properties by name

Open nandorholozsnyak opened this issue 2 years ago • 4 comments

Is your feature request related to a problem? Please describe. The groups and properties are having a fixed order that the developers are not able to customize, it would be great if there would be two different options:

  • orderGroup
  • orderProperties

nandorholozsnyak avatar Jul 21 '23 04:07 nandorholozsnyak

Not sure if this deserves a different issue, but I would like to be able to sort all properties by name. I have 2 components creating properties in the same name space and spring-configuration-property-documenter is outputting them separately.

roded avatar Sep 04 '23 16:09 roded

Hello @roded

Can you show me some examples and expected outcome? Thank you.

nandorholozsnyak avatar Sep 09 '23 14:09 nandorholozsnyak

Hi @nandorholozsnyak, sorry I don't have examples to share, but I can try to explain the issue. I have 2 Spring Boot starters which share a configuration namespace, e.g.: my.component.config. When creating the documentation for a project which depends on these two starters, the generated configuration document does not sort the configuration properties by name, so my.component.config.b does not necessarily follow my.component.config.a. Hope that makes sense.

Long story short, I think that spring-configuration-property-documenter should sort the properties lexicographically.

roded avatar Sep 09 '23 16:09 roded

Thank you, I think that is enough, I'll see what I can do with it, what are the possibilities :D

nandorholozsnyak avatar Sep 11 '23 07:09 nandorholozsnyak