aac.plugins.generate

The version plugin module.

Functions

register_plugin()

Registers the plugin with the AaC CLI.

run_clean(aac_file, code_output, ...)

Run the AaC clean command.

run_generate(aac_plugin_file, ...)

Run the AaC generate command.

aac.plugins.generate.register_plugin() None[source]

Registers the plugin with the AaC CLI.

Return type:

None

aac.plugins.generate.run_clean(aac_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool) ExecutionResult[source]

Run the AaC clean command.

Parameters:
  • aac_file (str)

  • code_output (str)

  • test_output (str)

  • doc_output (str)

  • no_prompt (bool)

Return type:

ExecutionResult

aac.plugins.generate.run_generate(aac_plugin_file: str, generator_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool, force_overwrite: bool, evaluate: bool) ExecutionResult[source]

Run the AaC generate command.

Parameters:
  • aac_plugin_file (str)

  • generator_file (str)

  • code_output (str)

  • test_output (str)

  • doc_output (str)

  • no_prompt (bool)

  • force_overwrite (bool)

  • evaluate (bool)

Return type:

ExecutionResult

Modules

generate_impl

AaC Plugin implementation module for the Version plugin.

helpers

Helper functions commonly used when generating content.