Home › Resources & tools › TextMate Grammar Testing Tool

TextMate Grammar Testing Tool

TextMate grammars are used to define syntax highlighting in Visual Studio Code and other editors.

This tool is an online tester for TextMate grammars in the JSON format. If you have a PLIST or YAML grammar, convert it to JSON using the PLIST to JSON or YAML to JSON tool. Note that the grammar must have the scopeName string property.

The preview code is highlighted using the provided grammar. You can edit both the grammar and the preview code.

The example grammar describes the syntax highlighting rules for a made-up language called QuarkScript. This grammar defines four keywords (if, while, for, and return) and supports double-quoted strings with escape sequences like \n.

TextMate grammar

{
  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
  "name": "QuarkScript",
  "patterns": [
    {
      "include": "#keywords"
    },
    {
      "include": "#strings"
    }
  ],
  "repository": {
    "keywords": {
      "patterns": [
        {
          "name": "keyword.control.qs",
          "match": "\\b(if|while|for|return)\\b"
        }
      ]
    },
    "strings": {
      "name": "string.quoted.double.qs",
      "begin": "\"",
      "end": "\"",
      "patterns": [
        {
          "name": "constant.character.escape.qs",
          "match": "\\\\."
        }
      ]
    }
  },
  "scopeName": "source.qs"
}1
{
2
  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
3
  "name": "QuarkScript",
4
  "patterns": [
5
    {
6
      "include": "#keywords"
7
    },
8
    {
9
      "include": "#strings"
10
    }
11
  ],
12
  "repository": {
13
    "keywords": {
14
      "patterns": [
15
        {
16
          "name": "keyword.control.qs",
17
          "match": "\\b(if|while|for|return)\\b"
18
        }
19
      ]
20
    },
21
    "strings": {
22
      "name": "string.quoted.double.qs",
23
      "begin": "\"",
24
      "end": "\"",
25
      "patterns": [
26
        {
27
          "name": "constant.character.escape.qs",
28
          "match": "\\\\."
29
        }
30
      ]
31
    }
32
  },
33
  "scopeName": "source.qs"
34
}

The TextMate grammar to test.

Preview code

for "many, many times":
  if "this is \"true\"":
    return "Hello World"1
for "many, many times":
2
  if "this is \"true\"":
3
    return "Hello World"

The preview of the grammar.

TextMate Grammar Testing Tool

See also