lakesoul-io/LakeSoul

Adopt treefmt for repository-wide code formatting

Fermée

#791 ouverte le 23 juin 2026

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (1 personne assignée)Java (432 forks)batch import
good first issue

Métriques du dépôt

Stars
 (2 236 étoiles)
Métriques de merge PR
 (Merge moyen 3j 4h) (10 PRs mergées en 30 j)

Description

Motivation

LakeSoul is a multi-language repository containing Rust, Java, Scala, Python, TOML, YAML, and other configuration files.

Currently, formatting behavior depends on individual developer tooling (IntelliJ IDEA, VS Code, Zed, Neovim, etc.), which can lead to:

  • Inconsistent code style
  • Formatter-related diffs in pull requests
  • Different formatting results across editors
  • Additional review noise

Proposal

Adopt treefmt as the single entry point for repository formatting.

The goal is to define a consistent formatting policy for all supported languages and configuration files:

Language Formatter
Rust rustfmt
Java google-java-format
Scala scalafmt
Python ruff format
TOML taplo
YAML prettier
JSON prettier

Developers can continue using their preferred editor, but formatting behavior should be defined centrally in the repository.

Example

treefmt

Guide contributeur

Direction de recherche
Lisez la documentation de treefmt, créez un fichier treefmt.toml spécifiant les formateurs pour chaque langage (rustfmt, google java format, scalafmt, ruff, taplo, prettier), exécutez treefmt pour vérifier et ajoutez éventuellement une vérification CI.
Stack technique
rustjavascalapython
Domaine
tooling
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitbasic knowledge of code formatting tools
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70