package
0.1.0
Repository: https://github.com/org-harmony/harmony.git
Documentation: pkg.go.dev

# Functions

CopyAfterParseSetting returns whether the checkbox for copying after parsing should be rendered as checked.
RegisterController registers the controllers as well as the navigation and event listeners.
RuleParsers constructs a new RuleParserProvider with the default rule parsers registered.
RuleReferencesValidator validates that each rule referenced in a variant is defined in the template's 'rules' section.
SegmentMapFromRequest parses the segments from the request and returns a map of segment names to values.
SegmentMapToSegments converts a map of segment names to values into a slice of ParsingSegments.
TemplateDisplayTypes returns a map of rule names to display types.
TemplateFormFromRequest parses the template and variant from the passed in templateID and variantKey and returns a TemplateFormData struct.
TemplateIntoBasicTemplate parses a templates config into a BasicTemplate and validates it.

# Constants

BasicTemplateType is the type name of the basic EIFFEL template used to identify the corresponding parser for a template.
TemplateDisplayInputTypeSingleSelect will display the rule value as an input field with datalist and single select.
TemplateDisplayInputTypeText will display the rule value as a text input.
TemplateDisplayInputTypeTextarea will display the rule value as a textarea.
TemplateDisplayString will display the rule value as text.

# Variables

ErrInvalidVariant is an error that is returned when trying to parse a requirement for an invalid variant.
ErrNotASlice is an error that is returned when trying to cast an any value to a slice of strings but the value is not a slice.
ErrNotAString is an error that is returned when trying to cast an any value to a string but the value is not a string.
ErrTemplateNotFound will be displayed to the user if the template could not be found.
ErrTemplateVariantNotFound will be displayed to the user if the template variant could not be found.

# Structs

BasicRule is a rule to reference in a variant.
BasicTemplate is the basic EIFFEL template.
BasicVariant is a concrete variation of a template to parse requirements.
Cfg is EIFFEL's configuration struct.
EqualsAnyRuleParser is a rule parser for the rule type 'equalsAny'.
EqualsRuleParser is a rule parser for the rule type 'equals'.
No description provided by the author
MissingRuleParserError is an error that is returned when a rule type is not registered in the RuleParserProvider.
PlaceholderRuleParser is a rule parser for the rule type 'placeholder'.
RuleInvalidValueError is an error that is returned when a rule value is of the wrong type or otherwise invalid.
RuleMissingError is an error that is returned when a rule is referenced in a variant but not defined in the template.
RuleParserProvider provides rules for different rule types.
SearchTemplateData contains templates to render as search results and a flag indicating if the query was too short.
TemplateFormData is the data that is passed to the template rendering the elicitation form.

# Interfaces

RuleParser provides the capabilities to validate a rule (after defining it in a template), ideally during the template validation, and to parse a rule during the parsing step of a requirement using a template.

# Type aliases

TemplateDisplayType specifies how a rule should be displayed in the UI.