turbo-editors/turbo-go · architecture.md

⑂ v1.0.0

architecture.md · 85 lines · 6.0 KBmarkdown    Blame HistoryRaw
   1# Architecture — explication
3## De quoi s'agit-il ?
5Turbo Go est une commande, un profil et un analyseur. Tout le reste — le composant d'édition, les fenêtres, les menus, les dialogues, les thèmes, l'émulateur de terminal, l'arborescence de fichiers, le client LSP — est [turbo-core](https://rickub.com/turbo-editors/turbo-core), la bibliothèque sur laquelle repose chaque éditeur Turbo.
7Cela n'a pas toujours été vrai. Turbo Go était un unique programme d'environ onze mille cinq cents lignes en quatorze paquets jusqu'à ce que l'on veuille un second éditeur ; à ce moment-là, les quatorze ont migré dans une bibliothèque et un seul est resté ici. Cette page parle de la coupure qui en résulte.
9## Ce qu'il y a dans ce dépôt
12main.go              les drapeaux, le terminal, et le câblage
13internal/golang      la totalité de ce qui fait Turbo Go
14  golang.go          le profil : nom, menu, serveur, marqueur de racine
15  scan.go            l'analyseur Go, bâti sur go/scanner
16  templates.go       trois déclarations //go:embed
17  *.toml.tmpl        les trois fichiers de départ qu'un projet reçoit, embarqués
20Environ quatre cents lignes. Il n'y a pas d'`internal/app`, pas d'`internal/ui`, pas d'`internal/buffer` — ceux-là existent une fois, dans la bibliothèque, et chaque éditeur bâti dessus s'en sert sans les modifier.
22## Ce que fait `main`
24Six choses, dans cet ordre :
261. Analyse les drapeaux.
272. Appelle `golang.Register()`, qui apprend à la bibliothèque à colorer les fichiers `.go`.
283. Construit `golang.Profile()` — la valeur qui dit que cet éditeur est Turbo Go.
294. Lit `.turbo-go/settings.toml` dans le répertoire courant, s'il y en a un.
305. Ouvre le terminal et passe l'écran, le nom du thème et le profil à `app.New`.
316. Démarre gopls à la racine du module, et lance la boucle d'événements.
33C'est toute la commande. Chaque décision qu'elle prend — quel thème l'emporte, quels fichiers ouvrir, faut-il démarrer un serveur de langage — porte sur *cette exécution*, pas sur Go.
35## Le profil est la couture
38profile.Profile{
39	Name:        "Turbo Go",
40	Slug:        "turbo-go",
41	Language:    "Go",
42	ToolsMenu:   "~G~o",
43	RootMarkers: []string{"go.mod"},
44	Server:      profile.Server{Command: "gopls", Args: []string{"serve"}, …},
45	Templates:   profile.Templates{Settings: …, Snippets: …, Tools: …},
49Tout ce qui était un `"turbo-go"`, un `"gopls"` ou un `"go.mod"` en dur quelque part dans onze mille lignes est ici un champ. La bibliothèque les lit ; rien dans la bibliothèque ne sait ce qu'ils veulent dire.
51`Slug` porte plus qu'il n'y paraît. Le binaire est `turbo-go`, le répertoire de projet est `.turbo-go`, la configuration de l'utilisateur vit dans `~/.config/turbo-go`, et les variables d'environnement qui la remplacent sont `TURBO_GO_THEME_DIR` et `TURBO_GO_SNIPPET_DIR` — toutes dérivées de ce seul mot. Ces noms sont inchangés par le refactoring, et délibérément : quelqu'un qui a posé `TURBO_GO_THEME_DIR` l'a fait face à un binaire publié.
53## Pourquoi l'analyseur Go est ici et pas dans la bibliothèque
55turbo-core colore huit langages lui-même : TOML, YAML, Markdown, JavaScript, HTML, XML, les Dockerfiles et le shell. Ce sont ceux que tout éditeur rencontre quel que soit son objet — la configuration d'un projet est du TOML ou du YAML, sa documentation du Markdown, ses scripts du shell, sa construction d'image un Dockerfile.
57Go n'en fait pas partie. Le langage qui *définit* un éditeur est enregistré par cet éditeur, ce qui explique qu'un fichier `.rs` s'ouvre ici en texte brut et qu'un fichier `.go` s'ouvre en texte brut dans Turbo Rust.
59L'analyseur Go est aussi celui qui ressemble le *moins* aux autres. Tous les langages de la bibliothèque sont analysés ligne à ligne avec `syntax.LineScanner` ; Go passe par `go/scanner`, l'analyseur lexical qu'utilise la chaîne d'outils Go elle-même, et convertit ses décalages en octets avec `syntax.LineIndex`. Si la bibliothèque accepte les deux formes, c'est à cause de cet analyseur.
61## Ce qui a bougé, et ce qui n'a pas bougé
63| Était | Est |
64| --- | --- |
65| `internal/buffer`, `internal/ui`, `internal/editor`, … | `turbo-core/buffer`, `turbo-core/ui`, `turbo-core/editor`, … |
66| `internal/syntax` — six langages | `turbo-core/syntax` — huit, plus un registre ; Go vit ici |
67| `internal/app` avec une constante `Name` | `turbo-core/app` recevant un `profile.Profile` |
68| `internal/lsp` codant gopls en dur | `turbo-core/lsp` recevant un `profile.Server` |
69| `moduleRoot` dans `main.go` | `app.ProjectRoot(p, files)`, avec `go.mod` dans le profil |
70| `settings.DirName = ".turbo-go"` | `p.ProjectDir()` |
72**Rien du comportement de l'éditeur n'a changé.** Les menus, les touches, les thèmes, les formats de fichiers et les variables d'environnement sont ce qu'ils étaient. Ce qui a changé, c'est l'endroit où le code habite.
74## Pourquoi une bibliothèque plutôt qu'un fork
76L'alternative à l'extraction de turbo-core était de copier Turbo Go et d'en changer les parties Go. Elle a été rejetée avant d'être entreprise : deux copies de onze mille lignes divergent en un mois, et chaque correctif doit être fait deux fois par quelqu'un qui se souvient qu'il y en a deux.
78Le coût, accepté : une modification d'un menu touche désormais tous les éditeurs à la fois, et Turbo Go ne peut plus prendre une décision qui n'arrange que Go sans soit la mettre dans le profil, soit la défendre dans la bibliothèque. C'est une vraie contrainte, et c'est elle qui fait que les éditeurs restent le même éditeur.
80## Comment cela se relie au reste
82- Ce que fait chaque paquet de la bibliothèque : [la référence des paquets de turbo-core](https://rickub.com/turbo-editors/turbo-core/blob/main/docs/fr/reference/packages.md)
83- Comment marche la coloration ici : [Coloration et complétion](colouring-and-completion.md)
84- Pourquoi le menu d'outils est une donnée : [Outils Go](go-tools.md)
85- Les décisions qui ont survécu au refactoring : [Décisions de conception](design-decisions.md)

📦 Turbo Go 3d7798b k33g 16h ago	1	# Architecture — explication
	2
	3	## De quoi s'agit-il ?
	4
	5	Turbo Go est une commande, un profil et un analyseur. Tout le reste — le composant d'édition, les fenêtres, les menus, les dialogues, les thèmes, l'émulateur de terminal, l'arborescence de fichiers, le client LSP — est [turbo-core](https://rickub.com/turbo-editors/turbo-core), la bibliothèque sur laquelle repose chaque éditeur Turbo.
	6
	7	Cela n'a pas toujours été vrai. Turbo Go était un unique programme d'environ onze mille cinq cents lignes en quatorze paquets jusqu'à ce que l'on veuille un second éditeur ; à ce moment-là, les quatorze ont migré dans une bibliothèque et un seul est resté ici. Cette page parle de la coupure qui en résulte.
	8
	9	## Ce qu'il y a dans ce dépôt
	10
	11	```
	12	main.go les drapeaux, le terminal, et le câblage
	13	internal/golang la totalité de ce qui fait Turbo Go
	14	golang.go le profil : nom, menu, serveur, marqueur de racine
	15	scan.go l'analyseur Go, bâti sur go/scanner
	16	templates.go trois déclarations //go:embed
	17	*.toml.tmpl les trois fichiers de départ qu'un projet reçoit, embarqués
	18	```
	19
	20	Environ quatre cents lignes. Il n'y a pas d'`internal/app`, pas d'`internal/ui`, pas d'`internal/buffer` — ceux-là existent une fois, dans la bibliothèque, et chaque éditeur bâti dessus s'en sert sans les modifier.
	21
	22	## Ce que fait `main`
	23
	24	Six choses, dans cet ordre :
	25
	26	1. Analyse les drapeaux.
	27	2. Appelle `golang.Register()`, qui apprend à la bibliothèque à colorer les fichiers `.go`.
	28	3. Construit `golang.Profile()` — la valeur qui dit que cet éditeur est Turbo Go.
	29	4. Lit `.turbo-go/settings.toml` dans le répertoire courant, s'il y en a un.
	30	5. Ouvre le terminal et passe l'écran, le nom du thème et le profil à `app.New`.
	31	6. Démarre gopls à la racine du module, et lance la boucle d'événements.
	32
	33	C'est toute la commande. Chaque décision qu'elle prend — quel thème l'emporte, quels fichiers ouvrir, faut-il démarrer un serveur de langage — porte sur cette exécution, pas sur Go.
	34
	35	## Le profil est la couture
	36
	37	```go
	38	profile.Profile{
	39	Name: "Turbo Go",
	40	Slug: "turbo-go",
	41	Language: "Go",
	42	ToolsMenu: "~G~o",
	43	RootMarkers: []string{"go.mod"},
	44	Server: profile.Server{Command: "gopls", Args: []string{"serve"}, …},
	45	Templates: profile.Templates{Settings: …, Snippets: …, Tools: …},
	46	}
	47	```
	48
	49	Tout ce qui était un `"turbo-go"`, un `"gopls"` ou un `"go.mod"` en dur quelque part dans onze mille lignes est ici un champ. La bibliothèque les lit ; rien dans la bibliothèque ne sait ce qu'ils veulent dire.
	50
	51	`Slug` porte plus qu'il n'y paraît. Le binaire est `turbo-go`, le répertoire de projet est `.turbo-go`, la configuration de l'utilisateur vit dans `~/.config/turbo-go`, et les variables d'environnement qui la remplacent sont `TURBO_GO_THEME_DIR` et `TURBO_GO_SNIPPET_DIR` — toutes dérivées de ce seul mot. Ces noms sont inchangés par le refactoring, et délibérément : quelqu'un qui a posé `TURBO_GO_THEME_DIR` l'a fait face à un binaire publié.
	52
	53	## Pourquoi l'analyseur Go est ici et pas dans la bibliothèque
	54
	55	turbo-core colore huit langages lui-même : TOML, YAML, Markdown, JavaScript, HTML, XML, les Dockerfiles et le shell. Ce sont ceux que tout éditeur rencontre quel que soit son objet — la configuration d'un projet est du TOML ou du YAML, sa documentation du Markdown, ses scripts du shell, sa construction d'image un Dockerfile.
	56
	57	Go n'en fait pas partie. Le langage qui définit un éditeur est enregistré par cet éditeur, ce qui explique qu'un fichier `.rs` s'ouvre ici en texte brut et qu'un fichier `.go` s'ouvre en texte brut dans Turbo Rust.
	58
	59	L'analyseur Go est aussi celui qui ressemble le moins aux autres. Tous les langages de la bibliothèque sont analysés ligne à ligne avec `syntax.LineScanner` ; Go passe par `go/scanner`, l'analyseur lexical qu'utilise la chaîne d'outils Go elle-même, et convertit ses décalages en octets avec `syntax.LineIndex`. Si la bibliothèque accepte les deux formes, c'est à cause de cet analyseur.
	60
	61	## Ce qui a bougé, et ce qui n'a pas bougé
	62
	63	\| Était \| Est \|
	64	\| --- \| --- \|
65	\| `internal/buffer`, `internal/ui`, `internal/editor`, … \| `turbo-core/buffer`, `turbo-core/ui`, `turbo-core/editor`, … \|
66	\| `internal/syntax` — six langages \| `turbo-core/syntax` — huit, plus un registre ; Go vit ici \|
67	\| `internal/app` avec une constante `Name` \| `turbo-core/app` recevant un `profile.Profile` \|
68	\| `internal/lsp` codant gopls en dur \| `turbo-core/lsp` recevant un `profile.Server` \|
69	\| `moduleRoot` dans `main.go` \| `app.ProjectRoot(p, files)`, avec `go.mod` dans le profil \|
70	\| `settings.DirName = ".turbo-go"` \| `p.ProjectDir()` \|
71
72	Rien du comportement de l'éditeur n'a changé. Les menus, les touches, les thèmes, les formats de fichiers et les variables d'environnement sont ce qu'ils étaient. Ce qui a changé, c'est l'endroit où le code habite.
73
74	## Pourquoi une bibliothèque plutôt qu'un fork
75
76	L'alternative à l'extraction de turbo-core était de copier Turbo Go et d'en changer les parties Go. Elle a été rejetée avant d'être entreprise : deux copies de onze mille lignes divergent en un mois, et chaque correctif doit être fait deux fois par quelqu'un qui se souvient qu'il y en a deux.
77
78	Le coût, accepté : une modification d'un menu touche désormais tous les éditeurs à la fois, et Turbo Go ne peut plus prendre une décision qui n'arrange que Go sans soit la mettre dans le profil, soit la défendre dans la bibliothèque. C'est une vraie contrainte, et c'est elle qui fait que les éditeurs restent le même éditeur.
79
80	## Comment cela se relie au reste
81
82	- Ce que fait chaque paquet de la bibliothèque : [la référence des paquets de turbo-core](https://rickub.com/turbo-editors/turbo-core/blob/main/docs/fr/reference/packages.md)
83	- Comment marche la coloration ici : [Coloration et complétion](colouring-and-completion.md)
84	- Pourquoi le menu d'outils est une donnée : [Outils Go](go-tools.md)
85	- Les décisions qui ont survécu au refactoring : [Décisions de conception](design-decisions.md)