Skip to main content

Yaml

Scopes

Below are visualizations of all our scope tests for this language. These were created primarily for testing purposes rather than as documentation. There are quite a few, and they may feel a bit overwhelming from a documentation standpoint.

Collection item

1. Collection item: Unenclosed multi line

An item in a comma-separated multi line list without enclosing delimiters. This could be multi-variable declarations, import statements, etc. Insertion delimiter should include new line.

2. Collection item: Unenclosed (iteration)

Iteration scope for items in a comma-separated list without enclosing delimiters

Collection key

1. Key: Map pair

Key (LHS) of a key-value pair of a map

2. Key: Map pair (iteration)

Iteration scope for keys of key-value pairs in a map: should be between the braces.

Comment

1. Comment: Line

A line comment

List

1. List

A list/array

Map

1. Map

A map/dictionary

String

1. String: Multi line

A multi-line string

2. String: Single line

A single-line string

Value

1. Value: Map pair

Value (RHS) of a key-value pair in a map

2. Value: Map pair (iteration)

Iteration scope for values of key-value pairs in a map: should be between the braces.

Internal scopes

The following are internal scopes. They are not intended for user interaction or spoken use. These scopes exist solely for internal Cursorless functionality.

Disqualify delimiter

1. Disqualify delimiter

Used to disqualify a token from being treated as a surrounding pair delimiter. This will usually be operators containing `>` or `<`, eg `<`, `<=`, `->`, etc

Text fragment

1. Text fragment: Comment line

Text fragment consisting of a line comment

2. Text fragment: String multi line

Text fragment consisting of a multi-line string

3. Text fragment: String single line

Text fragment consisting of a single-line string