ssh-config-ls 0.7.4

An SSH config formatter, usable as a Language Server Protocol (LSP) plugin.

SSH config formatter

Little side project to start learning Rust and explore LSP.

✨ Features

• Formatting of SSH config files via the sshfmt format command
• Language server started with sshfmt server, following the LSP protocol

📦 Installation

You can install the tool easily with pipx or uv:

uv tool install git+https://gitlab.com/nifra/ssh-config-ls

🔧 Configuration

The language server accepts the following options from the client (e.g. Neovim):

{
    formatter = {
        indent = "    ",  -- Indentation for directives inside Host and Match blocks
        separator = " ",  -- Separator between a keyword and its arguments
        sort_directives = true, -- Sort directives within blocks
    }
}

---

Formateur de config SSH — Plan de projet

Étape 1 — Prototype Python

Objectif : valider la logique de parsing et de formatage sans se battre contre un nouveau langage.

Note : Couvrir les cas limites (commentaires inline, blocs Host/Match, lignes vides multiples) et garder les tests sur le comportement observable (entrée/sortie texte) — ils serviront de spec pour la réécriture Rust.

Fonctionnalités à implémenter :

Lexer :

• Ajouter des tests sur le tokenizer
• Implémenter un tokenizer pour le cœur de la config
• Ajouter les commentaires dans le tokenizer
• Écrire tous les tests vicieux imaginables

Parser :

• Ajouter des tests sur le parser
• Implémenter un parser
• Parser les blocs Host et Match
• Écrire tous les tests vicieux imaginables

Formatage :

• Préserver les commentaires et automatises les lignes vides
• Normaliser l'indentation (4 espaces)
• Canonicaliser la casse des clés (hostname → Hostname)
• Écrire tous les tests vicieux imaginables

CLI :

• sshls format <file> — formate en place
• sshls format --check <file> — exit code non-zéro si non formaté (CI)
• sshls format --diff <file> — affiche le diff

LSP :

• Lib : pygls
• Créer le serveur
• Ajouter textDocument/formatting

Hors scope pour l'instant :

• Gérer les directives Include
• Trier les blocs (* en dernier)

---

Étape 2 — Apprentissage Rust

Avant de réécrire, poser les bases du langage.

• Lire les chapitres fondamentaux de The Book, en particulier sur l'ownership et les enums
• Faire quelques exercices Rustlings pour la syntaxe
• Libs à connaître pour ce projet : pest ou winnow (parsing), clap (CLI)

---

Étape 3 — Réécriture en Rust

Réécrire le formateur en Rust en s'appuyant sur les tests Python comme spec.

• Reprendre exactement les mêmes fonctionnalités et la même interface CLI
• Les tests Python guident l'implémentation et valident la parité de comportement

---

Étape 4 — Serveur LSP

Transformer le formateur en serveur LSP avec uniquement la capacité de formatage (textDocument/formatting).

• Lib : tower-lsp pour abstraire le protocole JSON-RPC
• Intégration Neovim via vim.lsp.start() ou nvim-lspconfig — pas de plugin dédié nécessaire

---

Références

• The Rust Book
• Rustlings
• tower-lsp
• LSP Specification — textDocument/formatting