Skip to main content

Lua

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.

Scopes

Anonymous function

1. Anonymous function

An anonymous function, eg a lambda function, an arrow function, etc.

Argument list

1. Argument list: Actual empty

An empty list of arguments in a function call. Insertion delimiter should be empty.

2. Argument list: Actual method empty

An empty list of arguments in a method call. Insertion delimiter should be empty.

3. Argument list: Actual method multi line

A multi-line list of arguments in a method call. Insertion delimiter should include a newline.

4. Argument list: Actual method single line

A single-line list of arguments in a method call

5. Argument list: Actual multi line

A multi-line list of arguments in a function call. Insertion delimiter should include a newline.

6. Argument list: Actual single line

A single-line list of arguments in a function call

7. Argument list: Formal empty

An empty list of parameters in a function declaration. Insertion delimiter should be empty.

8. Argument list: Formal lambda empty

An empty list of parameters in an anonymous function. Insertion delimiter should be empty.

9. Argument list: Formal lambda multi line

A multi-line list of parameters in an anonymous function. Insertion delimiter should include a newline.

10. Argument list: Formal lambda single line

A single-line list of parameters in an anonymous function

11. Argument list: Formal method empty

An empty list of parameters in a method declaration. Insertion delimiter should be empty.

12. Argument list: Formal method multi line

A multi-line list of parameters in a method declaration. Insertion delimiter should include a newline.

13. Argument list: Formal method single line

A single-line list of parameters in a method declaration

14. Argument list: Formal multi line

A multi-line list of parameters in a function declaration. Insertion delimiter should include a newline.

15. Argument list: Formal single line

A single-line list of parameters in a function declaration

Argument or parameter

1. Argument: Actual method multi line

A multi-line argument in a method call. Insertion delimiter should include a newline.

2. Argument: Actual method single line

A single-line argument in a method call

3. Argument: Actual multi line

A multi-line argument in a function call. Insertion delimiter should include a newline.

4. Argument: Actual single line

A single-line argument in a function call

5. Argument: Formal lambda multi line

A multi-line parameter in an anonymous function. Insertion delimiter should include a newline.

6. Argument: Formal lambda single line

A single-line parameter in an anonymous function

7. Argument: Formal method multi line

A multi-line parameter in a method declaration. Insertion delimiter should include a newline.

8. Argument: Formal method single line

A single-line parameter in a method declaration

9. Argument: Formal multi line

A multi-line parameter in a function declaration. Insertion delimiter should include a newline.

10. Argument: Formal single line

A single-line parameter in a function declaration

11. Argument: Actual (iteration)

Iteration scope for arguments in a function call: the argument list. The domain should be the entire function call.

12. Argument: Actual method (iteration)

Iteration scope for arguments in a method call: the argument list. The domain should be the entire method call.

13. Argument: Formal (iteration)

Iteration scope for parameters in a function declaration: the parameter list. The domain should be the entire function.

14. Argument: Formal lambda (iteration)

Iteration scope for parameters in an anonymous function: the parameter list. The domain should be the entire anonymous function.

15. Argument: Formal method (iteration)

Iteration scope for parameters in a method declaration: the parameter list. The domain should be the entire method.

Branch

1. Branch: If

An if branch

2. Branch: If elif else

An if-elif-else branch. The removal range for the if branch should include the trailing else keyword.

3. Branch: If else

An if-else branch

4. Branch: If (iteration)

Iteration scope for if/elif/else branches: the if/elif/else statement.

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 a newline.

2. Collection item: Unenclosed single line

An item in a comma-separated single-line list without enclosing delimiters. This could be multi-variable declarations, import statements, etc.

3. 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 in 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: Block

A block comment

2. Comment: Line

A line comment

Condition

1. Condition: Do while

A condition in a do-while loop

2. Condition: For

A condition in a for loop

3. Condition: If

A condition in an if statement

4. Condition: While

A condition in a while loop

Function call

1. Function call

A function call

2. Function call: Chain

A chain of function calls, eg foo().bar()

3. Function call: Method

A method call

Function callee

1. Function callee

The function being called in a function call

2. Function callee: Chain

The function being called in a chain of function calls, including parent objects.

3. Function callee: Method

The function being called in a method call, including parent objects.

If statement

1. If statement

An if statement

Interior

1. Interior: Do while

The body of a do-while loop

2. Interior: For

The body of a for loop

3. Interior: Foreach

The body of a for-each loop

4. Interior: Function

The body of a function declaration

5. Interior: If

The body of an if/elif/else branch

6. Interior: Lambda

The block body of an anonymous function

7. Interior: Method

The body of a method declaration

8. Interior: While

The body of a while loop

List

1. List

A list/array

Map

1. Map

A map/dictionary

Name

1. Name: Argument formal

Name of a parameter in a function declaration

2. Name: Argument formal lambda

Name of a parameter in an anonymous function

3. Name: Argument formal method

Name of a parameter in a method declaration

4. Name: Assignment

Name (LHS) of an assignment statement

5. Name: Assignment destructuring

Name (LHS) of an assignment statement using a destructuring pattern

6. Name: Foreach

Iteration variable name in a for-each loop

7. Name: Function

Name of a function declaration

8. Name: Method

Name of a method declaration

9. Name: Variable destructuring

Name (LHS) of a variable declaration using a destructuring pattern

10. Name: Variable initialized

Name (LHS) of an initialized variable declaration

11. Name: Variable uninitialized

Name (LHS) of an uninitialized variable declaration

12. Name (iteration block)

Iteration scope for names: statement blocks (body of functions/if-statements/for-loops/etc).

13. Name (iteration document)

Iteration scope for names: the entire document including leading and trailing empty lines.

14. Name: Argument formal (iteration)

Iteration scope for names of parameters in a function declaration: the parameter list.

15. Name: Argument formal lambda (iteration)

Iteration scope for names of parameters in an anonymous function: the parameter list.

16. Name: Argument formal method (iteration)

Iteration scope for names of parameters in a method declaration: the parameter list.

Named function

1. Named function

A named function declaration

2. Named function: Method

A method declaration

3. Named function (iteration document)

Iteration scope for named functions: the entire document including leading and trailing empty lines.

Statement

1. Statement: Assignment

An assignment statement

2. Statement: Assignment destructuring

An assignment statement using a destructuring pattern

3. Statement: Break

A break statement

4. Statement: Do while

A do-while loop

5. Statement: For

A for loop

6. Statement: Foreach

A for-each loop

7. Statement: Function

A named function declaration

8. Statement: Function call

A function call statement

9. Statement: If

An if/elif/else statement

10. Statement: Method

A method declaration

11. Statement: Return

A return statement

12. Statement: Variable destructuring

A variable declaration using a destructuring pattern, eg const { x, y } = point

13. Statement: Variable initialized

An initialized variable declaration

14. Statement: Variable uninitialized

An uninitialized variable declaration

15. Statement: While

A while loop

16. Statement (iteration block)

Iteration scope for statements: statement blocks (body of functions/if-statements/for-loops/etc).

17. Statement (iteration document)

Iteration scope for statements: the entire document including leading and trailing empty lines.

Value

1. Value: Assignment

Value (RHS) of an assignment statement

2. Value: Assignment destructuring

Value (RHS) of an assignment statement using a destructuring pattern

3. Value: Foreach

Iterable in a for-each loop

4. Value: Map pair

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

5. Value: Return

Return value of a function

6. Value: Variable

Value (RHS) of a variable declaration

7. Value: Variable destructuring

Value (RHS) of a variable declaration using a destructuring pattern

8. Value (iteration block)

Iteration scope for values: statement blocks (body of functions/if-statements/for-loops/etc).

9. Value (iteration document)

Iteration scope for values: the entire document including leading and trailing empty lines.

10. 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

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

String

1. String: Multi line

A multi-line string

2. String: Single line

A single-line string

Text fragment

1. Text fragment: Comment block

Internally used text fragment consisting of a block comment

2. Text fragment: Comment line

Internally used text fragment consisting of a line comment

3. Text fragment: String multi line

Internally used text fragment consisting of a multi-line string

4. Text fragment: String single line

Internally used text fragment consisting of a single-line string