search

nasa / ogma

Generator of runtime monitors for flight and robotics applications.
Other
338 stars 26 forks source link

`ogma-cli`: Allow customizing the F' application template #185

Open ivanperez-keera opened 3 days ago

ivanperez-keera commented 3 days ago

Description

The F' application generation backend uses a fixed template to generate the f' application. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason.

Allowing users to pick their own F' template would make Ogma more versatile.

Type

Additional context

None.

Requester

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma allows users to pick the custom F' application template they want to use instead of relying on the one provided by default.

Desired result

Ogma allows users to pick the custom F' application template they want to use instead of relying on the one provided by default.

Proposed solution

Modify ogma-core to use variable expansion based on mustache to create the output files.

Modify ogma-core's template to use the variables used by the F' application generation module.

Modify ogma-core to give users the ability to pick a template directory via an optional input argument.

Modify ogma-cli to give users the ability to pick a template directory via an optional input argument (exposing the corresponding argument from ogma-core).

Modify README to demonstrate new capability.

Further notes

None.

ivanperez-keera commented 3 days ago

Change Manager: Confirmed that the issue exists.

ivanperez-keera commented 3 days ago

Technical Lead: Confirmed that the issue should be addressed.

ivanperez-keera commented 3 days ago

Technical Lead: Issue scheduled for fixing in Ogma 1.6.0.

Fix assigned to: @ivanperez-keera .