Skip to content

_template.md

Latest commit

 

History

History
127 lines (84 loc) · 3.95 KB

_template.md

File metadata and controls

127 lines (84 loc) · 3.95 KB
Raw
comment and every _placeholder_ value 
3. Delete this header block before committing

Add the new file to the table in docs/README.md (plugins section). Also update docs/authoring-plugins.md "Reference implementations" table if this is an in-tree or example plugin. ───────────────────────────────────────────────────────────────────────── -->

Plugin: _plugin_id_

Identity

Field Value
Plugin ID _plugin_id_
Package plugins/_plugin_id_
Type Built-in / Example / Community

Injections

_InjectKind_ on _target_question_id_

Injected question ID Type Label Default
_plugin_id_._question_ _ConfirmQuestion / TextQuestion / OptionQuestion_ "label" _default_

Flows affected:

Generators contributed

Generator name Version Description
_plugin_id_._gen_ _0.1.0_ one-line description

_plugin_id_._gen_

Dependencies:

Files written:

Path Description
_path_ description

Validators:

ResolveExtras logic

_plugin_id_._gen_ runs only when:

  1. Answer _key_ equals _value_.
  2. (add more conditions as needed)

If any condition is false, ResolveExtras returns nil.

Answers added to spec

Key Type Added by
_plugin_id_._question_ bool / string InsertAfter injection on _target_

Fixture requirement

Any fixture for a flow that includes _target_question_id_ must also provide:

{
  "answers": {
    "_target_question_id_": _value_,
    "_plugin_id_._question_": _value_
  }
}

Omitting it causes: test-flow: no scripted answer for question "_plugin_id_._question_".

Source

_plugins/plugin_id_/plugin.go_