variable_string_escaped

Define a variable from another string variable and escape regular expression characters in it.

⚙️ Compatible targets: Linux

Parameters

NameDocumentation
nameThe variable to define, the full name will be prefix.name.

This parameter is required.

Outcome conditions

You need to replace ${name} with its actual canonified value.

  • ✅ Ok: variable_string_escaped_${name}_ok
    • ☑️ Already compliant: variable_string_escaped_${name}_kept
    • 🟨 Repaired: variable_string_escaped_${name}_repaired
  • ❌ Error: variable_string_escaped_${name}_error

Example

method: variable_string_escaped
params:
  name: VALUE

Documentation

To use the generated variable, you must use the form ${<name>_escaped} where is the composed complete name of the variable you want to escape.

Please note that the variable you want to escape must be defined before this method evaluation.

Example:

With a variable defined by the generic method variable_string, named my_prefix.my_variable and valued to:

 something like [] that

Passing my_prefix.my_variable as name parameter to this method will result in a variable named my_prefix.my_variable_escaped and valued to:

something\ like\ \[\]\ that