mariana-trench icon indicating copy to clipboard operation
mariana-trench copied to clipboard

[Feature Request] - Improving Helper to list custom and built-in definitions

Open serrapa opened this issue 2 years ago • 5 comments

Feature Request

Is your feature request related to a problem? Please describe.

Since Mariana Trench is highly configurable and it is also provided with built-in "attributes" (using the term "features" could be confusing), not visible from the default configuration files (i.e. the features "via-caller-exported" or the filter "always-via-caller-exported"), it would be great to implement a feature that give you an overview of all you have in your mariana "environment".

Describe the solution you'd like Implement the following options:

  • --list-all-rules : list all rules taken from the files and directory defined in the --rules option. If it is not present, list the "default" rules
  • --list-all-model-generators : list all generators taken from the files and directory defined in the --model-generator-search-paths option. If it is not present, list the "default" generators (maybe someone decided to write his/her own definitions of generator, rules, etc. in the "default" files)
  • --list-all-model-generators-in-rules : list all generators taken from the rules file used. So from the kinds used in the rules, derive all generators and list them
  • --list-all-kinds : list all kinds derived from all model generators, even those not defined in any rule
  • --list-all-kinds-in-rules: list all kinds defined in the rules files used.
  • --list-all-filters : list all custom and built-in filters names, giving a description of what is and its purpose
  • --list-all-features: list all custom and built-in features names, giving a description of what is and its purpose
  • --list-all-lifecycles : list all custom and built-in lifecycles names, giving a description of what is and its purpose

Additional context The documentation does not offer all these kind of information. It would be great if all built-in/default information were in the doc, maybe in a specific page where for each information there is a description and its purpose. However, the doc cannot report the user-defined definitions, so the options above remain the best solution.

serrapa avatar Feb 08 '23 12:02 serrapa

That sounds like a good idea. +1

arthaud avatar Feb 08 '23 20:02 arthaud

So looking forward to seeing it!

serrapa avatar Feb 09 '23 14:02 serrapa

Looking forward to seeing it! +1

DavidZhang-7 avatar Jul 06 '23 09:07 DavidZhang-7

@arthaud any updates on it?

serrapa avatar Feb 08 '24 14:02 serrapa

Unfortunately this is not a high priority for our team, and we have other work that comes first. If someone writes a pull request for this I will happily review it.

arthaud avatar Feb 08 '24 14:02 arthaud