| 📦 Turbo Go 3d7798b k33g yesterday | 1 | # Référence : langages colorés |
| 2 | |
| 3 | > Description neutre des fichiers que Turbo Go colore, de la façon dont il décide, et de ce que reconnaît chaque scanner. |
| 4 | |
| 5 | ## Reconnaissance |
| 6 | |
| 7 | L'**extension** d'un fichier décide dès qu'elle fait partie de celles-ci : |
| 8 | |
| 9 | | Extension | Langage | |
| 10 | | --- | --- | |
| 11 | | `.go` | Go | |
| 12 | | `.toml` | TOML | |
| 13 | | `.yaml`, `.yml` | YAML | |
| 14 | | `.md`, `.markdown` | Markdown | |
| 15 | | `.js`, `.mjs`, `.cjs` | JavaScript | |
| 16 | | `.html`, `.htm` | HTML | |
| 17 | | `.xml`, `.xsd`, `.xsl`, `.xslt`, `.svg`, `.plist`, `.csproj`, `.pom` | XML | |
| 18 | | `.sh`, `.bash`, `.zsh` | Shell | |
| 19 | | `.dockerfile`, `.containerfile` | Dockerfile | |
| 20 | |
| 21 | Les extensions sont comparées sans tenir compte de la casse, et seule la dernière compte : `main.go.backup` n'est pas du Go. |
| 22 | |
| 23 | Un fichier dont l'extension ne décide de rien est ensuite cherché par son **nom**. Seuls les fichiers sans extension exploitable en ont besoin : |
| 24 | |
| 25 | | Nom | Langage | |
| 26 | | --- | --- | |
| 27 | | `Dockerfile`, `Containerfile` | Dockerfile | |
| 28 | |
| 29 | Un nom correspond sur sa totalité ou sur la partie précédant le premier point, sans tenir compte de la casse — ainsi `Dockerfile`, `dockerfile` et `Dockerfile.dev` sont tous reconnus, tandis que `Dockerfile.md` est du Markdown, puisque l'extension est consultée en premier. |
| 30 | |
| 31 | Un fichier qu'aucun des deux tableaux ne revendique est un **script shell** si sa première ligne est un shebang nommant un shell — `sh`, `bash`, `zsh`, `dash` ou `ksh`, comme élément de chemin ou comme argument d'`env`. C'est ce qui colore `configure`, un hook git, ou un script que quelqu'un a renommé. |
| 32 | |
| 33 | | Première ligne | Résultat | |
| 34 | | --- | --- | |
| 35 | | `#!/bin/sh` | Shell | |
| 36 | | `#!/usr/bin/env bash` | Shell | |
| 37 | | `#!/usr/bin/env -S bash -e` | Shell | |
| 38 | | `#!/usr/bin/env python3` | Non coloré | |
| 39 | | Tout ce qui ne commence pas par `#!` | Non coloré | |
| 40 | |
| 41 | L'ordre est fixe — extension, puis nom, puis première ligne — et le premier qui décide l'emporte : un fichier `.go` commençant par un shebang reste du Go. |
| 42 | |
| 43 | Tout le reste est affiché en texte brut. Ce n'est pas une erreur — ouvrir un PNG dans l'éditeur n'est pas une faute, c'est simplement non coloré. |
| 44 | |
| 45 | ## Classes |
| 46 | |
| 47 | Tous les scanners produisent le même vocabulaire de classes, et chacune correspond à une clé de thème. |
| 48 | |
| 49 | | Classe | Clé de thème | Produite par | |
| 50 | | --- | --- | --- | |
| 51 | | `identifier` | `syntax.identifier` | Go, TOML, JavaScript, shell, YAML, Dockerfile | |
| 52 | | `keyword` | `syntax.keyword` | Go, JavaScript, shell, HTML (doctype), XML, Dockerfile | |
| 53 | | `type` | `syntax.type` | Go, TOML (en-têtes de table), YAML (étiquettes) | |
| 54 | | `builtin` | `syntax.builtin` | Go, JavaScript, shell (builtins et expansions), YAML (ancres et alias), Dockerfile (variables) | |
| 55 | | `constant` | `syntax.constant` | Go, TOML, JavaScript, shell, YAML, HTML et XML (entités) | |
| 56 | | `function` | `syntax.function` | Go, JavaScript, shell (la commande) | |
| 57 | | `string` | `syntax.string` | tous | |
| 58 | | `char` | `syntax.char` | Go | |
| 59 | | `number` | `syntax.number` | Go, TOML, JavaScript, shell, YAML, Dockerfile | |
| 60 | | `comment` | `syntax.comment` | Go, TOML, JavaScript, shell, HTML, YAML, XML, Dockerfile | |
| 61 | | `operator` | `syntax.operator` | Go, TOML, JavaScript, shell, HTML, YAML (en-têtes de scalaire de bloc), XML, Dockerfile | |
| 62 | | `punctuation` | `syntax.punctuation` | Go, TOML, JavaScript, shell, Markdown, YAML, Dockerfile | |
| 63 | | `heading` | `syntax.heading` | Markdown | |
| 64 | | `tag` | `syntax.tag` | HTML, XML | |
| 65 | | `attribute` | `syntax.attribute` | HTML, XML, Dockerfile (options) | |
| 66 | | `emphasis` | `syntax.emphasis` | Markdown | |
| 67 | | `link` | `syntax.link` | Markdown | |
| 68 | |
| 69 | ## Go |
| 70 | |
| 71 | Tokenisé par `go/scanner`, le lexer qu'utilise la chaîne d'outils Go elle-même. Voir [Coloration et complétion](../explanation/colouring-and-completion.md). |
| 72 | |
| 73 | ## TOML |
| 74 | |
| 75 | | Reconnu | Comme | |
| 76 | | --- | --- | |
| 77 | | `# commentaire` | comment | |
| 78 | | `[table]`, `[[array]]` | le nom en type, les crochets en punctuation | |
| 79 | | `clé =` | identifier, puis operator | |
| 80 | | `"basique"`, `'littérale'`, `"""multi-ligne"""`, `'''multi-ligne'''` | string | |
| 81 | | `true`, `false` | constant | |
| 82 | | nombres, dates, heures, `inf`, `nan` | number | |
| 83 | |
| 84 | ## YAML |
| 85 | |
| 86 | Un fichier compose, un manifeste Kubernetes et un workflow d'intégration continue sont tous cela : il n'y a pas de dialecte séparé, parce qu'un dialecte serait le schéma de quelqu'un d'autre à maintenir en phase. |
| 87 | |
| 88 | | Reconnu | Comme | |
| 89 | | --- | --- | |
| 90 | | `# commentaire` | commentaire | |
| 91 | | `clé:` suivie d'une espace ou de la fin de ligne | la clé en identifiant, le deux-points en ponctuation | |
| 92 | | `"entre guillemets": 1`, `'apostrophes': 1` | la clé citée en identifiant | |
| 93 | | `- ` ouvrant une entrée de séquence | ponctuation | |
| 94 | | `"…"`, `'…'` | chaîne | |
| 95 | | `true`, `false`, `yes`, `no`, `on`, `off`, `null` | constante, quelle que soit la casse | |
| 96 | | nombres, dates et heures écrits sans guillemets | nombre | |
| 97 | | `&ancre`, `*alias` | builtin | |
| 98 | | `!!str`, `!Custom` | type | |
| 99 | | `---`, `...` | toute la ligne en ponctuation | |
| 100 | | `{`, `}`, `[`, `]`, `,` | ponctuation | |
| 101 | | `\|`, `>`, avec leurs indicateurs de coupe et d'indentation | l'en-tête en opérateur, le corps en chaîne | |
| 102 | |
| 103 | **Un deux-points n'est un séparateur que si une espace ou la fin de ligne le suit.** `image: nginx:1.27` est une clé et une seule valeur, et `url: http://example.com/x` une clé et une seule URL — colorer les deux-points intérieurs en séparateurs mettrait chaque étiquette d'image et chaque URL en trois couleurs. |
| 104 | |
| 105 | **L'étendue d'un scalaire de bloc est décidée par l'indentation**, pas par un délimiteur. La première ligne de contenu après `|` ou `>` fixe l'indentation du bloc ; toute ligne indentée au moins autant lui appartient, et la première qui ne l'est pas y met fin. **Une ligne vide à l'intérieur d'un bloc y reste** : un scalaire littéral conserve ses lignes vides, et terminer le bloc au premier saut de paragraphe couperait en deux un script shell dans un fichier d'intégration continue. |
| 106 | |
| 107 | **Un `#` a besoin d'une espace devant lui pour ouvrir un commentaire**, si bien que `colour: ff#00aa` est un seul scalaire. |
| 108 | |
| 109 | | Non reconnu | Parce que | |
| 110 | | --- | --- | |
| 111 | | Le schéma d'un fichier compose, d'un manifeste ou d'un workflow | Colorer `services:` autrement qu'une clé quelconque revient à transporter le schéma de quelqu'un d'autre, qui se périme le jour où il ajoute une clé | |
| 112 | | Les flux multi-documents comme documents distincts | `---` est coloré, mais rien n'est réinitialisé à cet endroit ; rien dans la coloration ne dépend des frontières de documents | |
| 113 | | Si un mot nu est une chaîne ou un nombre pour un analyseur | `1.2.3` est une version pour un lecteur et une chaîne pour YAML ; l'analyseur colore ce à quoi cela ressemble | |
| 114 | |
| 115 | ## Markdown |
| 116 | |
| 117 | | Reconnu | Comme | |
| 118 | | --- | --- | |
| 119 | | `# Titre` … `###### Titre` | toute la ligne en heading | |
| 120 | | `**gras**`, `__gras__`, `*italique*`, `_italique_` | emphasis | |
| 121 | | `` `code` `` | string | |
| 122 | | `[texte](cible)`, `` | l'ensemble en link | |
| 123 | | `- `, `* `, `+ `, `1. `, `1) ` | le marqueur en punctuation | |
| 124 | | `>` | punctuation | |
| 125 | | `---`, `***`, `___` | punctuation | |
| 126 | | clôtures ` ``` ` et `~~~` | tout le bloc, lignes d'ouverture et de fermeture comprises, en string | |
| 127 | |
| 128 | Un bloc clôturé est **d'une seule couleur quel que soit le langage annoncé** : ```` ```go ```` ne colore pas son contenu en Go. La suite de marqueurs qui ouvre un bloc doit être fermée par le même caractère : une clôture en accents graves ne se ferme pas par des tildes. Une clôture non fermée colore jusqu'à la fin du fichier. |
| 129 | |
| 130 | La suite de marqueurs qui ouvre une emphase doit être fermée par une suite de même longueur, de sorte que `**gras**` fasse un seul span et non deux italiques. |
| 131 | |
| 132 | ## JavaScript |
| 133 | |
| 134 | | Reconnu | Comme | |
| 135 | | --- | --- | |
| 136 | | `const`, `let`, `function`, `class`, `async`, `await`, `import`, `export`, … | keyword | |
| 137 | | `true`, `false`, `null`, `undefined`, `NaN`, `Infinity`, `this` | constant | |
| 138 | | `console`, `document`, `window`, `Array`, `Object`, `Promise`, `Math`, `JSON`, … | builtin | |
| 139 | | un nom immédiatement suivi de `(` | function | |
| 140 | | `"…"`, `'…'` | string | |
| 141 | | `` `…` ``, interpolations comprises, sur plusieurs lignes | string | |
| 142 | | `//` jusqu'à la fin de la ligne, `/* … */` sur plusieurs lignes | comment | |
| 143 | | `42`, `3.14`, `0x1f`, `0b1010`, `0o777`, `1_000_000`, `1e6`, `10n` | number | |
| 144 | | suites de `+-*/%=<>!&|^~?:` | operator | |
| 145 | | `()[]{},;.` | punctuation | |
| 146 | |
| 147 | **Les littéraux d'expression régulière ne sont pas reconnus.** Distinguer `/x/g` d'une division exige de savoir si le token précédent pouvait terminer une expression ; une mauvaise supposition colore le reste de la ligne comme une chaîne, ce qui est pire que de laisser une regex à la couleur d'un opérateur. |
| 148 | |
| 149 | Les globales sont reconnues par leur nom : un fichier qui masque `Math` la voit quand même colorée comme un builtin — la même règle que les identifiants prédéclarés de Go. |
| 150 | |
| 151 | ## HTML |
| 152 | |
| 153 | | Reconnu | Comme | |
| 154 | | --- | --- | |
| 155 | | `<balise`, `</balise`, `>`, `/>` | tag | |
| 156 | | noms d'attributs, dont `data-*`, `xlink:href`, `@click`, `v-bind.prop` | attribute | |
| 157 | | `=` | operator | |
| 158 | | `"…"`, `'…'` | string | |
| 159 | | `<!-- … -->`, sur plusieurs lignes | comment | |
| 160 | | `&`, `©` | constant | |
| 161 | | `<!DOCTYPE …>` et les autres déclarations | keyword | |
| 162 | |
| 163 | Le texte entre balises n'est pas coloré. Une esperluette isolée sans `;` dans les 32 caractères qui suivent est laissée telle quelle, parce que c'est du texte légal. |
| 164 | |
| 165 | **Le contenu de `<script>` et de `<style>` n'est pas coloré** en JavaScript ni en CSS. |
| 166 | |
| 167 | ## XML |
| 168 | |
| 169 | Son propre analyseur plutôt que celui du HTML, pour une raison qui compte : CDATA. Tout l'intérêt de `<![CDATA[ … ]]>` est que son contenu n'est *pas* du balisage, et colorer les balises qu'il contient comme des balises est exactement l'inverse. |
| 170 | |
| 171 | | Reconnu | Comme | |
| 172 | | --- | --- | |
| 173 | | `<?xml version="1.0"?>` et les autres instructions de traitement | la cible et `?>` en mot-clé, les paires entre les deux en attributs et chaînes | |
| 174 | | `<!DOCTYPE …>` et les autres formes `<!` | mot-clé | |
| 175 | | `<!-- … -->`, sur plusieurs lignes | commentaire | |
| 176 | | `<![CDATA[ … ]]>`, sur plusieurs lignes | chaîne | |
| 177 | | `<balise`, `</balise`, `>`, `/>` | balise | |
| 178 | | `<ns:balise>`, `xsi:type` | le préfixe et le nom local en **un seul** segment | |
| 179 | | les noms d'attributs | attribut | |
| 180 | | `=` | opérateur | |
| 181 | | `"…"`, `'…'` | chaîne | |
| 182 | | `&`, `©` | constante | |
| 183 | |
| 184 | **Un commentaire et une section CDATA se ferment sur des délimiteurs différents**, et sont transportés séparément : un `-->` à l'intérieur d'une section CDATA n'y met pas fin. |
| 185 | |
| 186 | **Une esperluette isolée sans point-virgule dans les 32 caractères suivants est laissée telle quelle**, parce que c'est du texte légal dans bien des documents et qu'avaler le reste de la ligne serait la plus grosse erreur. |
| 187 | |
| 188 | Le texte entre balises n'est pas coloré. |
| 189 | |
| 190 | ## Shell |
| 191 | |
| 192 | S'applique indifféremment à `sh`, `bash` et `zsh` : les mots-clés reconnus sont ceux qu'ils partagent. |
| 193 | |
| 194 | | Reconnu | Comme | |
| 195 | | --- | --- | |
| 196 | | `if`, `then`, `fi`, `for`, `while`, `case`, `esac`, `function`, `return`, … | keyword | |
| 197 | | `true`, `false` | constant | |
| 198 | | `echo`, `printf`, `export`, `local`, `read`, `cd`, `set`, `source`, … | builtin | |
| 199 | | `$NOM`, `${…}`, `$(…)`, `$1`, `$?`, `$@` | builtin | |
| 200 | | le **premier mot nu d'une ligne** | function | |
| 201 | | tout mot nu suivant, et `NOM` dans `NOM=valeur` | identifier | |
| 202 | | `'…'`, sans échappement ni expansion à l'intérieur | string | |
| 203 | | `"…"`, avec les expansions colorées comme telles | string | |
| 204 | | `#` jusqu'à la fin de la ligne | comment | |
| 205 | |
| 206 | `$(a $(b) c)` fait un seul span : l'imbrication est comptée. Une option comme `-euo` est un seul mot, et non un moins suivi d'un mot. |
| 207 | |
| 208 | **Les heredocs ne sont pas reconnus.** `<<EOF` et le texte qui suit sont colorés comme du shell ordinaire. |
| 209 | |
| 210 | ## Dockerfile |
| 211 | |
| 212 | | Reconnu | Comme | |
| 213 | | --- | --- | |
| 214 | | `FROM`, `RUN`, `COPY`, `ADD`, `ARG`, `ENV`, `CMD`, `ENTRYPOINT`, `EXPOSE`, `LABEL`, `USER`, `VOLUME`, `WORKDIR`, `HEALTHCHECK`, `ONBUILD`, `SHELL`, `STOPSIGNAL`, `MAINTAINER` | mot-clé, quelle que soit la casse | |
| 215 | | `AS`, `NONE` | mot-clé | |
| 216 | | `# commentaire`, y compris les directives `# syntax=` et `# escape=` | commentaire | |
| 217 | | `--from=builder`, `--chown=me:me` | le nom de l'option en attribut | |
| 218 | | `$NOM`, `${NOM}`, `${NOM:-defaut}` | builtin, en un seul segment jusqu'à l'accolade fermante | |
| 219 | | `"…"`, `'…'` | chaîne | |
| 220 | | un `\` final | opérateur | |
| 221 | | les nombres | nombre | |
| 222 | | chemins et références d'images — `/usr/local/bin`, `golang:1.26-alpine` | identifiant, en **un seul** segment | |
| 223 | |
| 224 | **Seul le premier mot d'une ligne peut être une instruction**, et un mot qui n'en est pas une est un argument — ce qui garde le premier mot d'une ligne de continuation hors de la couleur des mots-clés. |
| 225 | |
| 226 | **Rien ne traverse un saut de ligne.** Un `\` joint deux lignes pour Docker, mais chaque moitié se lit encore comme une commande et est colorée pour elle-même. |
| 227 | |
| 228 | | Non reconnu | Parce que | |
| 229 | | --- | --- | |
| 230 | | Le shell à l'intérieur d'un `RUN` | Il faudrait passer l'analyseur shell sur une partie de ligne et en remonter les colonnes, et un `RUN` peut contenir n'importe quel langage | |
| 231 | | Les heredocs dans un `RUN` | La même raison que pour l'analyseur shell | |
| 232 | | Quelle étape nomme un `--from` | Rien ici ne lit le reste du fichier | |
| 233 | |
| 234 | ## Voir aussi |
| 235 | |
| 236 | - [Format des fichiers de thème](themes.md) — toutes les clés vers lesquelles ces classes se résolvent |
| 237 | - [Coloration et complétion](../explanation/colouring-and-completion.md) — pourquoi les scanners sont écrits ainsi |
| 238 | - [Écrire son propre thème](../how-to/write-a-theme.md) |