You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be useful to be able to do something like python -m ffig --list-generators to obtain a list of the registered generators, templates and template aliases.
This would be useful in a number of situations, including
new users exploring the capabilities of FFIG.
the ffig-explorer REST API providing a way to query the generator names available.
developers who want to check that their generator or template has been properly detected by FFIG.
In order to support these use cases, in particular the REST API, the functionality to implement this should be exposed as a Python function in the ffig package, as well as via a command-line argument when FFIG is invoked as the main executable.
Some complications:
Not all templates represent complete binding generation; e.g. the support for Go bindings is split across two templates.
Some templates are used by a generator (Go, Python). As we move more logic into generators, the proportion of these will increase.
Some templates have aliases, e.g. ruby is an aliased generator for rb.tmpl.
Templates, and, in some cases, generators, don't always have very meaningful names. This suggests we should add a description field, at least for the generators, which can be set when a generator registers itself.
Generators now include a description for each binding they register.
These can be used to add a `--list-generators` feature.
This commit contains work for issue #402.
* N402: Add descriptions to binding generators.
Generators now include a description for each binding they register.
These can be used to add a `--list-generators` feature.
This commit contains work for issue #402.
* N402: Add test for generator descriptions.
* N402: Fix test by converting filter(...) output to a list.
It would be useful to be able to do something like
python -m ffig --list-generators
to obtain a list of the registered generators, templates and template aliases.This would be useful in a number of situations, including
In order to support these use cases, in particular the REST API, the functionality to implement this should be exposed as a Python function in the
ffig
package, as well as via a command-line argument when FFIG is invoked as the main executable.Some complications:
ruby
is an aliased generator forrb.tmpl
.Sub-tasks
--list-generators
cmdline option.The text was updated successfully, but these errors were encountered: