☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

root_boundary

Table of contents

Description:

This key defines the boundary tokens required for key-value segments when parsing snippet parameters.

The value is an object that contains start and end properties, each specifying a string token. This defines paired tokens that enclose the root parameter structure.

Appears in:
└── Snippet Format
    └── root_boundary
Type:
Object
Properties:
endstring#

This key defines the end token for root-level boundaries when parsing snippet parameters.

The value is a string that specifies the token that marks the end of the root-level structure in snippet parameter parsing. This works together with root_boundary.start to define paired tokens that enclose the root parameter structure.

Defaults to:

Show examplesHide examples

In this example, we have configured root boundaries to use angle brackets.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            root_boundary:
              start: '<<'
              end: '>>'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "root_boundary": {
                "start": "<<",
                "end": ">>"
              }
            }
          }
        }
      }
    }
  }
}
startstring#

This key defines the start token for root-level boundaries when parsing snippet parameters.

The value is a string that specifies the token that marks the start of the root-level structure in snippet parameter parsing. This works together with root_boundary.end to define paired tokens that enclose the root parameter structure.

Defaults to:

Show examplesHide examples

In this example, we have configured root boundaries to use angle brackets.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            root_boundary:
              start: '<<'
              end: '>>'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "root_boundary": {
                "start": "<<",
                "end": ">>"
              }
            }
          }
        }
      }
    }
  }
}
Examples:

In this example, we have configured root boundaries to use angle brackets.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            root_boundary:
              start: '<<'
              end: '>>'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "root_boundary": {
                "start": "<<",
                "end": ">>"
              }
            }
          }
        }
      }
    }
  }
}
Open in a new tab