We already have dedicated models that represent each element of cli_gen (e.g. CliCommandModel) which is essentially a trimmed down version of the Element/AST model, that can be easily used by any code generator.
It would be very useful to have users tap into these builders to define their own static html / js help docs, similar to the FVM docs which were written by hand:
https://fvm.app/documentation/guides/basic-commands
The above docs include the following details for each command (the table shows what is already supported by cli gen today).
| Detail |
Is Already Supported |
| Command name |
✅ |
| Description |
✅ |
| Usage |
|
| Detailed description |
|
| Examples |
|
| Options |
✅ |
Most of the information, besides the examples, would be easy to support.
The biggest question is how to support html/js generation, as rolling our own generator just for cli_gen would not have much benefit as, say, creating a more general-purpose generator for other packages to use. Dartdoc sort of fits this use case, but likely does not support the amount of customization that developers want.
We already have dedicated models that represent each element of
cli_gen(e.g.CliCommandModel) which is essentially a trimmed down version of the Element/AST model, that can be easily used by any code generator.It would be very useful to have users tap into these builders to define their own static html / js help docs, similar to the FVM docs which were written by hand:
https://fvm.app/documentation/guides/basic-commands
The above docs include the following details for each command (the table shows what is already supported by cli gen today).
Most of the information, besides the examples, would be easy to support.
The biggest question is how to support html/js generation, as rolling our own generator just for
cli_genwould not have much benefit as, say, creating a more general-purpose generator for other packages to use. Dartdoc sort of fits this use case, but likely does not support the amount of customization that developers want.