turbo-editors/turbo-pythonpublic Fork 0
v1.0.2
Commits
Clone
git clone https://git.rickub.com/turbo-editors/turbo-python.git
git clone ssh://git@rickub.com/turbo-editors/turbo-python.git

Host key fingerprint (ed25519): SHA256:iycHnxEyq0Q7uyVpB7JlznP0G7JrTPXLYRcAU5CSLhc — verify it before your first connect.

📦 Turbo Python 6fc62ea · on v1.0.2 · k33g · 11h ago
languages.md · 289 lines · 17.8 KBmarkdown
Blame HistoryOpen raw

Reference: languages coloured

Neutral description of which files Turbo Python colours, how it decides, and what each scanner recognises.

Recognition

A file's extension decides whenever it is one of these:

Extension Language
.py, .pyi, .pyw Python
.toml TOML
.yaml, .yml YAML
.md, .markdown Markdown
.js, .mjs, .cjs JavaScript
.html, .htm HTML
.xml, .xsd, .xsl, .xslt, .svg, .plist, .csproj, .pom XML
.sh, .bash, .zsh Shell
.dockerfile, .containerfile Dockerfile

Extensions are matched case-insensitively, and only the last one counts: main.py.backup is not Python.

A file whose extension decides nothing is looked up by name next. Only files that carry no useful extension need this:

Name Language
Dockerfile, Containerfile Dockerfile

A name matches on the whole of it or on the part before the first dot, ignoring case — so Dockerfile, dockerfile and Dockerfile.dev are all recognised, while Dockerfile.md is Markdown, because the extension is consulted first.

A file that neither table claims is read by its first line. A shebang naming python or python3 makes it Python, and one naming a shell — sh, bash, zsh, dash or ksh — makes it a shell script. The interpreter is recognised as a path element or as the argument to env. That is what colours a script in a bin directory, a git hook, or configure.

First line Result
#!/bin/sh Shell
#!/usr/bin/env bash Shell
#!/usr/bin/env -S bash -e Shell
#!/usr/bin/env python3 Python
#!/usr/bin/python Python
#!/usr/bin/env node Not coloured
Anything not starting #! Not coloured

The order is fixed — extension, then name, then first line — and the first to decide wins: a .md file starting with a Python shebang is Markdown.

Everything else is shown in plain text. That is not an error — opening a PNG in the editor is not a mistake, it is just not coloured.

Classes

Every scanner produces the same vocabulary of classes, and each maps to one theme key.

Class Theme key Produced by
identifier syntax.identifier Python, TOML, JavaScript, shell, YAML, Dockerfile
keyword syntax.keyword Python, JavaScript, shell, HTML (doctype), XML, Dockerfile
type syntax.type Python, TOML (table headers), YAML (tags)
builtin syntax.builtin Python (builtins, self, dunders), JavaScript, shell (builtins and expansions), YAML (anchors and aliases), Dockerfile (variables)
constant syntax.constant Python, TOML, JavaScript, shell, YAML, HTML and XML (entities)
function syntax.function Python, JavaScript, shell (the command)
string syntax.string all
char syntax.char nothing here; the class exists for languages that have a character type, and Python has none
number syntax.number Python, TOML, JavaScript, shell, YAML, Dockerfile
comment syntax.comment Python, TOML, JavaScript, shell, HTML, YAML, XML, Dockerfile
operator syntax.operator Python, TOML, JavaScript, shell, HTML, YAML (block scalar headers), XML, Dockerfile
punctuation syntax.punctuation Python, TOML, JavaScript, shell, Markdown, YAML, Dockerfile
heading syntax.heading Markdown
tag syntax.tag HTML, XML
attribute syntax.attribute Python (decorators), HTML, XML, Dockerfile (flags)
emphasis syntax.emphasis Markdown
link syntax.link Markdown

Python

Hand-written, in internal/pythonlang. Only a string crosses a line break, and it does so in two ways: a triple-quoted one runs until the matching three quotes, and a single-quoted one runs on only when the line ends with a backslash. Which quote opened it is carried, because a literal opened with three double quotes and one opened with three apostrophes are different strings.

Recognised As
and, as, assert, async, await, break, class, continue, def, del, elif, else, except, finally, for, from, global, if, import, in, is, lambda, nonlocal, not, or, pass, raise, return, try, while, with, yield keyword
match and case, when they open the line and the line ends with : keyword
True, False, None, NotImplemented, Ellipsis, __debug__ constant
bool, bytearray, bytes, complex, dict, float, frozenset, int, list, memoryview, object, range, set, slice, str, tuple, type type
any other name starting with a capital — ValueError, Measurement type
a name written wholly in capitals — MAX_SIZE, PI, HTTP_PORT constant
__init__, __repr__, __name__ and every other dunder builtin
print, len, open, sorted, isinstance, … and self, cls builtin
any other name immediately before ( function
"…" and '…', with any prefix: r, b, u, f, rb, br, fr, rf, in either case string
"""…""" and '''…''', across as many lines as they take string
a single-quoted string whose line ends with a backslash, onto the next line string
42, 1_000, 0xFF, 0o17, 0b1010, .5, 1., 1.5e-3, 1E+7, 3j number
# to the end of the line, the shebang included comment
@property, @app.route, @pytest.mark.parametrize — the name only attribute
:= operator
: everywhere else — a block, a slice, a dict, an annotation punctuation
@ anywhere but the start of a line operator
a \ ending a line punctuation
runs of +-*/%=<>!&|^~? operator
()[]{},;. punctuation

match and case are keywords only where a match statement puts them. They are reserved in no context at all — match = re.match(pattern, text) is ordinary Python — so the shape of the statement decides: the word opens the line, and the line ends with the colon that opens its block. Both conditions have to hold.

A name written wholly in capitals is a constant, and any other capitalised name is a type. PEP 8 separates the two conventions clearly enough to read them: MAX_SIZE is a constant and Measurement is a class. Turbo Rust has only the second rule and documents SCREAMING_SNAKE_CASE as a known wrong answer; here that answer is worth removing rather than inheriting.

A capitalised name is a type even when it is called. ValueError("nope") and parse("nope") are the same shape, because a class is called exactly the way a function is — so the parenthesis cannot tell them apart and the convention has to. This is the one rule Turbo Python and Turbo Rust order differently.

self and cls are coloured as builtins although the language does not name them. They are a convention: a method may call its first parameter anything. But every Python reader reads self as the language's, the way a Rust reader reads Some, and every other highlighter agrees. The cost is a parameter honestly named self in a plain function being coloured too.

A decorator stops at its arguments. @pytest.mark.parametrize("n", [1, 2]) colours the dotted name as an attribute and the rest as ordinary Python, so the string and the list inside it keep their own colours.

A backslash takes the rune after it out of consideration in a raw string too. r"\"" is one complete string: in a raw string the backslash stays in the value, but it still stops the quote after it from ending the literal. Termination is the same rule for both, which is why rawness is not carried between lines.

A string that reaches the end of a line without either of the two reasons to carry on is dropped there. It is coloured to the end of that line and the next line is code again — because a single-quoted string with no closing quote is source in the middle of being typed, and carrying it would paint the rest of the file.

Not recognised, each for a stated reason:

Not recognised Because
The {expression} inside an f-string Since Python 3.12 it may hold anything — nested quotes, comments, another f-string. One flat run of string is the honest answer; colouring it half-properly ends f"{n:{width}}" at the inner brace
match or case on a line with a trailing comment The colon is found by reading backwards from the end of the line, and a comment hides it, so match value: # dispatch colours match as a name. That is the safe direction to be wrong in
A docstring as anything but a string It is a string — help() reads it back as one — and colouring it as a comment would be wrong the moment one is assigned to a name
A class whose name is all capitals HTTP is coloured as a constant. That is the price of MAX_SIZE being coloured correctly, and the trade goes the way the commoner case does
type as the soft keyword of type Alias = int It is also a builtin type, and reading as the type is right in both of its jobs
Whether a name is bound in this scope Nothing here reads more than one line at a time; that is the language server's question, and F1 answers it

TOML

Recognised As
# comment comment
[table], [[array]] the name as a type, the brackets as punctuation
key = identifier, then operator
"basic", 'literal', """multi-line""", '''multi-line''' string
true, false constant
numbers, dates, times, inf, nan number

YAML

A compose file, a Kubernetes manifest and a CI workflow are all this: there is no separate dialect, because a dialect would be somebody else's schema to keep in step with.

Recognised As
# comment comment
key: before a space or the end of the line the key as an identifier, the colon as punctuation
"quoted": 1, 'quoted': 1 the quoted key as an identifier
- opening a sequence entry punctuation
"…", '…' string
true, false, yes, no, on, off, null constant, whatever their case
numbers, dates and times written without quotes number
&anchor, *alias builtin
!!str, !Custom type
---, ... the whole line as punctuation
{, }, [, ], , punctuation
|, >, with their chomping and indentation indicators the header as an operator, the body as a string

A colon is a separator only when a space or the end of the line follows it. image: nginx:1.27 is a key and one value, and url: http://example.com/x is a key and one URL — colouring the inner colons as separators would put every image tag and every URL in three colours.

A block scalar's extent is decided by indentation, not by a delimiter. The first content line after | or > fixes the block's indentation; every line indented at least that far belongs to it, and the first line that is not ends it. A blank line inside a block stays inside it: a literal scalar keeps its empty lines, and ending the block at the first paragraph break would cut a shell script in a CI file in half.

A # needs a space before it to start a comment, so colour: ff#00aa is one scalar.

Not recognised Because
The schema of a compose file, a manifest or a workflow Colouring services: differently from any other key means carrying somebody else's schema, and it goes stale the day they add a key
Multi-document streams as separate documents --- is coloured, but nothing is reset at it; nothing in the colouring depends on document boundaries
Whether a bare word is a string or a number to a parser 1.2.3 is a version to a reader and a string to YAML; the scanner colours what it looks like

Markdown

Recognised As
# Heading###### Heading the whole line as a heading
**bold**, __bold__, *italic*, _italic_ emphasis
`code` string
[text](target), ![alt](src) the whole thing as a link
- , * , + , 1. , 1) the marker as punctuation
> punctuation
---, ***, ___ punctuation
``` and ~~~ fences the whole block, opening and closing lines included, as a string

A fenced block is one colour whatever language it announces: ```python does not colour its contents as Python. The run of markers that opens a block must be matched by the same character to close it, so a backtick fence is not closed by a tilde one. An unclosed fence colours to the end of the file.

The run of markers opening emphasis must be matched by a run of the same length, so **bold** is one span rather than two italics.

JavaScript

Recognised As
const, let, function, class, async, await, import, export, … keyword
true, false, null, undefined, NaN, Infinity, this constant
console, document, window, Array, Object, Promise, Math, JSON, … builtin
a name immediately before ( function
"…", '…' string
`…`, interpolations included, across lines string
// to end of line, /* … */ across lines comment
42, 3.14, 0x1f, 0b1010, 0o777, 1_000_000, 1e6, 10n number
runs of `+-*/%=<>!& ^~?:`
()[]{},;. punctuation

Regular-expression literals are not recognised. Telling /x/g from a division needs to know whether the previous token could end an expression; a wrong guess colours the rest of a line as a string, which is worse than leaving a regex the colour of an operator.

Globals are recognised by name, so a file that shadows Math still has it coloured as a builtin — the same rule Python's builtins follow here.

HTML

Recognised As
<tag, </tag, >, /> tag
attribute names, including data-*, xlink:href, @click, v-bind.prop attribute
= operator
"…", '…' string
<!-- … -->, across lines comment
&amp;, &#169; constant
<!DOCTYPE …> and other declarations keyword

Text between tags is not coloured. A bare & with no ; within 32 characters is left alone, because it is legal text.

The contents of <script> and <style> are not coloured as JavaScript and CSS.

XML

Its own scanner rather than HTML's, for one reason that matters: CDATA. The whole point of <![CDATA[ … ]]> is that its contents are not markup, and colouring the tags inside one as tags is exactly backwards.

Recognised As
<?xml version="1.0"?> and other processing instructions the target and ?> as keyword, the pairs between as attributes and strings
<!DOCTYPE …> and the other <! forms keyword
<!-- … -->, across lines comment
<![CDATA[ … ]]>, across lines string
<tag, </tag, >, /> tag
<ns:tag>, xsi:type the prefix and the local name as one span
attribute names attribute
= operator
"…", '…' string
&amp;, &#169; constant

A comment and a CDATA section close on different delimiters, and are carried separately: a --> inside a CDATA section does not end it.

A bare & with no semicolon within 32 characters is left alone, because it is legal text in plenty of documents and swallowing the rest of the line would be the bigger mistake.

Text between tags is not coloured.

Shell

Applies to sh, bash and zsh alike: the keywords recognised are the ones they share.

Recognised As
if, then, fi, for, while, case, esac, function, return, … keyword
true, false constant
echo, printf, export, local, read, cd, set, source, … builtin
$NAME, ${…}, $(…), $1, $?, $@ builtin
the first bare word on a line function
every later bare word, and NAME in NAME=value identifier
'…', with nothing escaped or expanded inside string
"…", with the expansions inside it coloured as expansions string
# to end of line comment

$(a $(b) c) is one span: nesting is counted. An option such as -euo is one word, not a minus and a word.

Heredocs are not recognised. <<EOF and the text after it are coloured as ordinary shell.

Dockerfile

Recognised As
FROM, RUN, COPY, ADD, ARG, ENV, CMD, ENTRYPOINT, EXPOSE, LABEL, USER, VOLUME, WORKDIR, HEALTHCHECK, ONBUILD, SHELL, STOPSIGNAL, MAINTAINER keyword, in any case
AS, NONE keyword
# comment, including the # syntax= and # escape= directives comment
--from=builder, --chown=me:me the flag name as an attribute
$NAME, ${NAME}, ${NAME:-default} builtin, as one span to the closing brace
"…", '…' string
a trailing \ operator
numbers number
paths and image references — /usr/local/bin, golang:1.26-alpine identifier, as one span

Only the first word of a line can be an instruction, and a word that is not one is an argument — which is what keeps a continuation line's first word out of the keyword colour.

Nothing crosses a line break. A \ joins two lines for Docker, but each half still reads as a command and is coloured on its own.

Not recognised Because
The shell inside a RUN It would mean running the shell scanner over part of a line and mapping its columns out, and RUN may hold any language
Heredocs in a RUN The same reason the shell scanner does not recognise them
Which stage a --from names Nothing here reads the rest of the file

See also

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# Reference: languages coloured

> Neutral description of which files Turbo Python colours, how it decides, and what each scanner recognises.

## Recognition

A file's **extension** decides whenever it is one of these:

| Extension | Language |
| --- | --- |
| `.py`, `.pyi`, `.pyw` | Python |
| `.toml` | TOML |
| `.yaml`, `.yml` | YAML |
| `.md`, `.markdown` | Markdown |
| `.js`, `.mjs`, `.cjs` | JavaScript |
| `.html`, `.htm` | HTML |
| `.xml`, `.xsd`, `.xsl`, `.xslt`, `.svg`, `.plist`, `.csproj`, `.pom` | XML |
| `.sh`, `.bash`, `.zsh` | Shell |
| `.dockerfile`, `.containerfile` | Dockerfile |

Extensions are matched case-insensitively, and only the last one counts: `main.py.backup` is not Python.

A file whose extension decides nothing is looked up by **name** next. Only files that carry no useful extension need this:

| Name | Language |
| --- | --- |
| `Dockerfile`, `Containerfile` | Dockerfile |

A name matches on the whole of it or on the part before the first dot, ignoring case — so `Dockerfile`, `dockerfile` and `Dockerfile.dev` are all recognised, while `Dockerfile.md` is Markdown, because the extension is consulted first.

A file that neither table claims is read by its **first line**. A shebang naming `python` or `python3` makes it Python, and one naming a shell — `sh`, `bash`, `zsh`, `dash` or `ksh` — makes it a shell script. The interpreter is recognised as a path element or as the argument to `env`. That is what colours a script in a `bin` directory, a git hook, or `configure`.

| First line | Result |
| --- | --- |
| `#!/bin/sh` | Shell |
| `#!/usr/bin/env bash` | Shell |
| `#!/usr/bin/env -S bash -e` | Shell |
| `#!/usr/bin/env python3` | Python |
| `#!/usr/bin/python` | Python |
| `#!/usr/bin/env node` | Not coloured |
| Anything not starting `#!` | Not coloured |

The order is fixed — extension, then name, then first line — and the first to decide wins: a `.md` file starting with a Python shebang is Markdown.

Everything else is shown in plain text. That is not an error — opening a PNG in the editor is not a mistake, it is just not coloured.

## Classes

Every scanner produces the same vocabulary of classes, and each maps to one theme key.

| Class | Theme key | Produced by |
| --- | --- | --- |
| `identifier` | `syntax.identifier` | Python, TOML, JavaScript, shell, YAML, Dockerfile |
| `keyword` | `syntax.keyword` | Python, JavaScript, shell, HTML (doctype), XML, Dockerfile |
| `type` | `syntax.type` | Python, TOML (table headers), YAML (tags) |
| `builtin` | `syntax.builtin` | Python (builtins, `self`, dunders), JavaScript, shell (builtins and expansions), YAML (anchors and aliases), Dockerfile (variables) |
| `constant` | `syntax.constant` | Python, TOML, JavaScript, shell, YAML, HTML and XML (entities) |
| `function` | `syntax.function` | Python, JavaScript, shell (the command) |
| `string` | `syntax.string` | all |
| `char` | `syntax.char` | nothing here; the class exists for languages that have a character type, and Python has none |
| `number` | `syntax.number` | Python, TOML, JavaScript, shell, YAML, Dockerfile |
| `comment` | `syntax.comment` | Python, TOML, JavaScript, shell, HTML, YAML, XML, Dockerfile |
| `operator` | `syntax.operator` | Python, TOML, JavaScript, shell, HTML, YAML (block scalar headers), XML, Dockerfile |
| `punctuation` | `syntax.punctuation` | Python, TOML, JavaScript, shell, Markdown, YAML, Dockerfile |
| `heading` | `syntax.heading` | Markdown |
| `tag` | `syntax.tag` | HTML, XML |
| `attribute` | `syntax.attribute` | Python (decorators), HTML, XML, Dockerfile (flags) |
| `emphasis` | `syntax.emphasis` | Markdown |
| `link` | `syntax.link` | Markdown |

## Python

Hand-written, in `internal/pythonlang`. **Only a string crosses a line break**, and it does so in two ways: a triple-quoted one runs until the matching three quotes, and a single-quoted one runs on only when the line ends with a backslash. Which quote opened it is carried, because a literal opened with three double quotes and one opened with three apostrophes are different strings.

| Recognised | As |
| --- | --- |
| `and`, `as`, `assert`, `async`, `await`, `break`, `class`, `continue`, `def`, `del`, `elif`, `else`, `except`, `finally`, `for`, `from`, `global`, `if`, `import`, `in`, `is`, `lambda`, `nonlocal`, `not`, `or`, `pass`, `raise`, `return`, `try`, `while`, `with`, `yield` | keyword |
| `match` and `case`, when they open the line and the line ends with `:` | keyword |
| `True`, `False`, `None`, `NotImplemented`, `Ellipsis`, `__debug__` | constant |
| `bool`, `bytearray`, `bytes`, `complex`, `dict`, `float`, `frozenset`, `int`, `list`, `memoryview`, `object`, `range`, `set`, `slice`, `str`, `tuple`, `type` | type |
| any other name starting with a capital — `ValueError`, `Measurement` | type |
| a name written wholly in capitals — `MAX_SIZE`, `PI`, `HTTP_PORT` | constant |
| `__init__`, `__repr__`, `__name__` and every other dunder | builtin |
| `print`, `len`, `open`, `sorted`, `isinstance`, … and `self`, `cls` | builtin |
| any other name immediately before `(` | function |
| `"…"` and `'…'`, with any prefix: `r`, `b`, `u`, `f`, `rb`, `br`, `fr`, `rf`, in either case | string |
| `"""…"""` and `'''…'''`, across as many lines as they take | string |
| a single-quoted string whose line ends with a backslash, onto the next line | string |
| `42`, `1_000`, `0xFF`, `0o17`, `0b1010`, `.5`, `1.`, `1.5e-3`, `1E+7`, `3j` | number |
| `#` to the end of the line, the shebang included | comment |
| `@property`, `@app.route`, `@pytest.mark.parametrize` — the name only | attribute |
| `:=` | operator |
| `:` everywhere else — a block, a slice, a dict, an annotation | punctuation |
| `@` anywhere but the start of a line | operator |
| a `\` ending a line | punctuation |
| runs of `+-*/%=<>!&\|^~?` | operator |
| `()[]{},;.` | punctuation |

**`match` and `case` are keywords only where a match statement puts them.** They are reserved in no context at all — `match = re.match(pattern, text)` is ordinary Python — so the shape of the statement decides: the word opens the line, and the line ends with the colon that opens its block. Both conditions have to hold.

**A name written wholly in capitals is a constant, and any other capitalised name is a type.** PEP 8 separates the two conventions clearly enough to read them: `MAX_SIZE` is a constant and `Measurement` is a class. Turbo Rust has only the second rule and documents `SCREAMING_SNAKE_CASE` as a known wrong answer; here that answer is worth removing rather than inheriting.

**A capitalised name is a type even when it is called.** `ValueError("nope")` and `parse("nope")` are the same shape, because a class is called exactly the way a function is — so the parenthesis cannot tell them apart and the convention has to. This is the one rule Turbo Python and Turbo Rust order differently.

**`self` and `cls` are coloured as builtins although the language does not name them.** They are a convention: a method may call its first parameter anything. But every Python reader reads `self` as the language's, the way a Rust reader reads `Some`, and every other highlighter agrees. The cost is a parameter honestly named `self` in a plain function being coloured too.

**A decorator stops at its arguments.** `@pytest.mark.parametrize("n", [1, 2])` colours the dotted name as an attribute and the rest as ordinary Python, so the string and the list inside it keep their own colours.

**A backslash takes the rune after it out of consideration in a raw string too.** `r"\""` is one complete string: in a raw string the backslash stays in the value, but it still stops the quote after it from ending the literal. Termination is the same rule for both, which is why rawness is not carried between lines.

**A string that reaches the end of a line without either of the two reasons to carry on is dropped there.** It is coloured to the end of that line and the next line is code again — because a single-quoted string with no closing quote is source in the middle of being typed, and carrying it would paint the rest of the file.

**Not recognised**, each for a stated reason:

| Not recognised | Because |
| --- | --- |
| The `{expression}` inside an f-string | Since Python 3.12 it may hold anything — nested quotes, comments, another f-string. One flat run of string is the honest answer; colouring it half-properly ends `f"{n:{width}}"` at the inner brace |
| `match` or `case` on a line with a trailing comment | The colon is found by reading backwards from the end of the line, and a comment hides it, so `match value:  # dispatch` colours `match` as a name. That is the safe direction to be wrong in |
| A docstring as anything but a string | It *is* a string — `help()` reads it back as one — and colouring it as a comment would be wrong the moment one is assigned to a name |
| A class whose name is all capitals | `HTTP` is coloured as a constant. That is the price of `MAX_SIZE` being coloured correctly, and the trade goes the way the commoner case does |
| `type` as the soft keyword of `type Alias = int` | It is also a builtin type, and reading as the type is right in both of its jobs |
| Whether a name is bound in this scope | Nothing here reads more than one line at a time; that is the language server's question, and [F1 answers it](../how-to/ask-about-code.md) |

## TOML

| Recognised | As |
| --- | --- |
| `# comment` | comment |
| `[table]`, `[[array]]` | the name as a type, the brackets as punctuation |
| `key =` | identifier, then operator |
| `"basic"`, `'literal'`, `"""multi-line"""`, `'''multi-line'''` | string |
| `true`, `false` | constant |
| numbers, dates, times, `inf`, `nan` | number |

## YAML

A compose file, a Kubernetes manifest and a CI workflow are all this: there is no separate dialect, because a dialect would be somebody else's schema to keep in step with.

| Recognised | As |
| --- | --- |
| `# comment` | comment |
| `key:` before a space or the end of the line | the key as an identifier, the colon as punctuation |
| `"quoted": 1`, `'quoted': 1` | the quoted key as an identifier |
| `- ` opening a sequence entry | punctuation |
| `"…"`, `'…'` | string |
| `true`, `false`, `yes`, `no`, `on`, `off`, `null` | constant, whatever their case |
| numbers, dates and times written without quotes | number |
| `&anchor`, `*alias` | builtin |
| `!!str`, `!Custom` | type |
| `---`, `...` | the whole line as punctuation |
| `{`, `}`, `[`, `]`, `,` | punctuation |
| `\|`, `>`, with their chomping and indentation indicators | the header as an operator, the body as a string |

**A colon is a separator only when a space or the end of the line follows it.** `image: nginx:1.27` is a key and one value, and `url: http://example.com/x` is a key and one URL — colouring the inner colons as separators would put every image tag and every URL in three colours.

**A block scalar's extent is decided by indentation**, not by a delimiter. The first content line after `|` or `>` fixes the block's indentation; every line indented at least that far belongs to it, and the first line that is not ends it. **A blank line inside a block stays inside it**: a literal scalar keeps its empty lines, and ending the block at the first paragraph break would cut a shell script in a CI file in half.

**A `#` needs a space before it to start a comment**, so `colour: ff#00aa` is one scalar.

| Not recognised | Because |
| --- | --- |
| The schema of a compose file, a manifest or a workflow | Colouring `services:` differently from any other key means carrying somebody else's schema, and it goes stale the day they add a key |
| Multi-document streams as separate documents | `---` is coloured, but nothing is reset at it; nothing in the colouring depends on document boundaries |
| Whether a bare word is a string or a number to a parser | `1.2.3` is a version to a reader and a string to YAML; the scanner colours what it looks like |

## Markdown

| Recognised | As |
| --- | --- |
| `# Heading``###### Heading` | the whole line as a heading |
| `**bold**`, `__bold__`, `*italic*`, `_italic_` | emphasis |
| `` `code` `` | string |
| `[text](target)`, `![alt](src)` | the whole thing as a link |
| `- `, `* `, `+ `, `1. `, `1) ` | the marker as punctuation |
| `>` | punctuation |
| `---`, `***`, `___` | punctuation |
| ` ``` ` and `~~~` fences | the whole block, opening and closing lines included, as a string |

A fenced block is **one colour whatever language it announces**: ```` ```python ```` does not colour its contents as Python. The run of markers that opens a block must be matched by the same character to close it, so a backtick fence is not closed by a tilde one. An unclosed fence colours to the end of the file.

The run of markers opening emphasis must be matched by a run of the same length, so `**bold**` is one span rather than two italics.

## JavaScript

| Recognised | As |
| --- | --- |
| `const`, `let`, `function`, `class`, `async`, `await`, `import`, `export`, … | keyword |
| `true`, `false`, `null`, `undefined`, `NaN`, `Infinity`, `this` | constant |
| `console`, `document`, `window`, `Array`, `Object`, `Promise`, `Math`, `JSON`, … | builtin |
| a name immediately before `(` | function |
| `"…"`, `'…'` | string |
| `` `` ``, interpolations included, across lines | string |
| `//` to end of line, `/* … */` across lines | comment |
| `42`, `3.14`, `0x1f`, `0b1010`, `0o777`, `1_000_000`, `1e6`, `10n` | number |
| runs of `+-*/%=<>!&|^~?:` | operator |
| `()[]{},;.` | punctuation |

**Regular-expression literals are not recognised.** Telling `/x/g` from a division needs to know whether the previous token could end an expression; a wrong guess colours the rest of a line as a string, which is worse than leaving a regex the colour of an operator.

Globals are recognised by name, so a file that shadows `Math` still has it coloured as a builtin — the same rule Python's builtins follow here.

## HTML

| Recognised | As |
| --- | --- |
| `<tag`, `</tag`, `>`, `/>` | tag |
| attribute names, including `data-*`, `xlink:href`, `@click`, `v-bind.prop` | attribute |
| `=` | operator |
| `"…"`, `'…'` | string |
| `<!-- … -->`, across lines | comment |
| `&amp;`, `&#169;` | constant |
| `<!DOCTYPE …>` and other declarations | keyword |

Text between tags is not coloured. A bare `&` with no `;` within 32 characters is left alone, because it is legal text.

**The contents of `<script>` and `<style>` are not coloured** as JavaScript and CSS.

## XML

Its own scanner rather than HTML's, for one reason that matters: CDATA. The whole point of `<![CDATA[ … ]]>` is that its contents are *not* markup, and colouring the tags inside one as tags is exactly backwards.

| Recognised | As |
| --- | --- |
| `<?xml version="1.0"?>` and other processing instructions | the target and `?>` as keyword, the pairs between as attributes and strings |
| `<!DOCTYPE …>` and the other `<!` forms | keyword |
| `<!-- … -->`, across lines | comment |
| `<![CDATA[ … ]]>`, across lines | string |
| `<tag`, `</tag`, `>`, `/>` | tag |
| `<ns:tag>`, `xsi:type` | the prefix and the local name as **one** span |
| attribute names | attribute |
| `=` | operator |
| `"…"`, `'…'` | string |
| `&amp;`, `&#169;` | constant |

**A comment and a CDATA section close on different delimiters**, and are carried separately: a `-->` inside a CDATA section does not end it.

**A bare `&` with no semicolon within 32 characters is left alone**, because it is legal text in plenty of documents and swallowing the rest of the line would be the bigger mistake.

Text between tags is not coloured.

## Shell

Applies to `sh`, `bash` and `zsh` alike: the keywords recognised are the ones they share.

| Recognised | As |
| --- | --- |
| `if`, `then`, `fi`, `for`, `while`, `case`, `esac`, `function`, `return`, … | keyword |
| `true`, `false` | constant |
| `echo`, `printf`, `export`, `local`, `read`, `cd`, `set`, `source`, … | builtin |
| `$NAME`, `${…}`, `$(…)`, `$1`, `$?`, `$@` | builtin |
| the **first bare word on a line** | function |
| every later bare word, and `NAME` in `NAME=value` | identifier |
| `'…'`, with nothing escaped or expanded inside | string |
| `"…"`, with the expansions inside it coloured as expansions | string |
| `#` to end of line | comment |

`$(a $(b) c)` is one span: nesting is counted. An option such as `-euo` is one word, not a minus and a word.

**Heredocs are not recognised.** `<<EOF` and the text after it are coloured as ordinary shell.

## Dockerfile

| Recognised | As |
| --- | --- |
| `FROM`, `RUN`, `COPY`, `ADD`, `ARG`, `ENV`, `CMD`, `ENTRYPOINT`, `EXPOSE`, `LABEL`, `USER`, `VOLUME`, `WORKDIR`, `HEALTHCHECK`, `ONBUILD`, `SHELL`, `STOPSIGNAL`, `MAINTAINER` | keyword, in any case |
| `AS`, `NONE` | keyword |
| `# comment`, including the `# syntax=` and `# escape=` directives | comment |
| `--from=builder`, `--chown=me:me` | the flag name as an attribute |
| `$NAME`, `${NAME}`, `${NAME:-default}` | builtin, as one span to the closing brace |
| `"…"`, `'…'` | string |
| a trailing `\` | operator |
| numbers | number |
| paths and image references — `/usr/local/bin`, `golang:1.26-alpine` | identifier, as **one** span |

**Only the first word of a line can be an instruction**, and a word that is not one is an argument — which is what keeps a continuation line's first word out of the keyword colour.

**Nothing crosses a line break.** A `\` joins two lines for Docker, but each half still reads as a command and is coloured on its own.

| Not recognised | Because |
| --- | --- |
| The shell inside a `RUN` | It would mean running the shell scanner over part of a line and mapping its columns out, and `RUN` may hold any language |
| Heredocs in a `RUN` | The same reason the shell scanner does not recognise them |
| Which stage a `--from` names | Nothing here reads the rest of the file |

## See also

- [Theme file format](themes.md) — every key these classes resolve to
- [Colouring and completion](../explanation/colouring-and-completion.md) — why the scanners are written this way
- [How to write your own theme](../how-to/write-a-theme.md)