talon-scripts/community/core/snippets

Snippets

Custom format to represent snippets.

Features

• Custom file ending .snippet.
• Supports syntax highlighting in VSCode via an extension
• Supports auto-formatting in VSCode via an extension
• Support for insertion and wrapper snippets. Note that while the snippet file syntax here supports wrapper snippets, you will need to install Cursorless for wrapper snippets to work.
• Support for phrase formatters.

Format

• A .snippet file can contain multiple snippet documents separated by ---.
• Each snippet document has a context and body separated by -.
• Optionally a file can have a single context at the top with no body. This is not a snippet in itself, but default values to be inherited by the other snippet documents in the same file.
• Some context keys supports multiple values. These values are separated by |.
  • For most keys like language or phrase multiple values means or. You can use phrase 1 or phrase 2. The snippet is active in language A or language B.
  • For insertionFormatter multiple values means that the formatters will be applied in sequence.

Context fields

Key	Required	Multiple values	Example
name	Yes	No	name: ifStatement
description	No	No	description: My snippet
language	No	Yes	language: javascript | java
phrase	No	Yes	phrase: if | if state
insertionScope	No	Yes	insertionScope: statement

• name: Unique name identifying the snippets. Can be referenced in Python to use the snippet programmatically.
• description: A description of the snippet.
• language: Language identifier indicating which language the snippet is available for. If omitted the snippet is enabled globally.
• phrase: The spoken phrase used to insert the snippet. eg "snip if".
• insertionScope: Used by Cursorless to infer scope when inserting the snippet. eg "snip if after air" gets inferred as "snip if after state air".

Variables

It's also possible to set configuration that applies to a specific tab stop ($0) or variable ($try):

Key	Required	Multiple values	Example
insertionFormatter	No	Yes	$0.insertionFormatter: SNAKE_CASE
wrapperPhrase	No	Yes	$0.wrapperPhrase: try | trying
wrapperScope	No	No	$0.wrapperScope: statement

• insertionFormatter: Formatter to apply to the phrase when inserting the snippet. eg "snip funk get value". If omitted no trailing phrase is available for the snippet.
• wrapperPhrase: Used by Cursorless as the spoken form for wrapping with the snippet. eg "if wrap air". Without Cursorless this spoken form is ignored by Talon.
• wrapperScope: Used by Cursorless to infer scope when wrapping with the snippet. eg "if wrap air" gets inferred as "if wrap state air".

Formatting and syntax highlighting

To get formatting, code completion and syntax highlighting for .snippet files: install andreas-talon

Examples

Single snippet definition

Multiple snippet definitions in single file

Default context and multiple values