Cargando

Cargando...

Aller au contenu
CubicLauncherDocs

Développement local

Prérequis, commandes et flux de travail pour compiler, tester et contribuer à CubicLauncher.

Ce guide décrit comment préparer un environnement de développement complet de CubicLauncher, l'organisation interne du dépôt et le flux de travail attendu pour les contributions de code.

Prérequismodifier

OutilVersion / notes
GitToute version récente
BunPour installer les dépendances et exécuter les scripts du projet
Node.jsUne version LTS en vigueur (solution de repli pour Bun)
Rust>= 1.85, avec prise en charge de l'édition 2024, ainsi que Cargo, rustfmt et Clippy
Tauri v2Dépendances système selon votre plateforme (guide officiel)

La CLI de Tauri fait partie des dépendances du projet et s'installe automatiquement avec bun install ; il n'est pas nécessaire de l'installer séparément.

Environnement localmodifier

bash
git clone https://github.com/CubicLauncherDevs/CubicLauncher.git
cd CubicLauncher
bun install --frozen-lockfile
bun run tauri dev

bun run tauri dev démarre l'application de bureau et le serveur de développement du frontend en parallèle, avec rechargement à chaud. Pour travailler uniquement sur l'interface, bun run dev lance seulement Vite ; gardez à l'esprit que les fonctionnalités qui dépendent du backend (instances, téléchargements, authentification) ne seront pas disponibles dans ce mode.

Environnement avec Nixmodifier

Sur NixOS ou avec Nix installé, le flake du dépôt inclut un devShell avec toutes les dépendances nécessaires (Bun, Rust, cargo-tauri, GTK3, WebKitGTK, GStreamer, entre autres) :

bash
nix develop
bun install --frozen-lockfile
bun run tauri dev

Consultez le guide Nix pour plus de détails sur l'empaquetage et le dépannage.

Commandes principalesmodifier

Toutes les commandes s'exécutent depuis la racine du dépôt.

CommandeDescription
bun run tauri devDémarre l'application de bureau en mode développement.
bun run devDémarre le serveur Vite du frontend.
bun run tauri buildCompile et empaquète l'application pour la plateforme actuelle.
bun run buildGénère la compilation de production du frontend.
bun run lintExécute ESLint sur le frontend.
bun run checkVérifie les types et les diagnostics Svelte.
bun run test:frontendExécute les tests du frontend avec Bun.
bun run test:rustExécute les tests et doctests du workspace Rust.
bun run test:allExécute les suites du frontend et de Rust.
cargo fmt --all --checkVérifie le formatage du code Rust.
cargo clippy --workspace -- -D warningsExécute l'analyse statique du workspace Rust.
Compilation rapide pour tester des changements du backend

Si vous souhaitez seulement valider des changements Rust sans empaqueter d'installateurs, cargo build dans src-tauri/ produit un binaire de développement bien plus rapidement que bun run tauri build.

Structure du dépôtmodifier

plaintext
src/                  # Interface, état et services du frontend
src-tauri/            # Application Tauri, commandes et services natifs
  src/tests/          # Tests unitaires du backend de l'application
crates/               # Bibliothèques internes du workspace Rust
  <crate>/src/tests/  # Tests unitaires de chaque bibliothèque avec leurs propres suites
tests/frontend/       # Tests du frontend regroupés par domaine
static/               # Ressources statiques de l'interface
dist/                 # Fichiers d'empaquetage pour les distributions
.github/              # Intégration continue et flux de publication

Le backend est organisé comme un workspace de crates internes qui encapsulent des domaines indépendants (instances, téléchargements, gestion de Java, authentification, etc.). Cela permet de tester chaque service de manière isolée et de le réutiliser entre les binaires.

Testsmodifier

Le projet maintient des suites séparées pour le frontend et le backend :

  • Frontend (tests/frontend/) : tests unitaires et d'intégration exécutés avec Bun. Le guide de tests documente les exigences de Chromium pour les tests de navigateur, les mesures de performance et les flux de vérification manuelle.
  • Rust (src-tauri/src/tests/ et crates/<crate>/src/tests/) : tests unitaires et doctests par crate, exécutés avec Cargo.

Avant d'ouvrir une pull request, exécutez bun run test:all pour valider les deux suites.

Flux de travail recommandémodifier

  1. Fork et branche : créez un fork du dépôt et une branche descriptive depuis develop :
    bash
    git checkout develop
    git pull
    git checkout -b feat/nom-du-changement
  2. Commits atomiques : gardez des changements petits et ciblés, avec des messages décrivant l'intention du changement.
  3. Validation locale : avant d'ouvrir la PR, assurez-vous que toutes les vérifications passent :
    bash
    bun run lint
    bun run check
    bun run test:all
    cargo fmt --all --check
    cargo clippy --workspace -- -D warnings
  4. Pull request : ouvrez la PR contre develop en décrivant clairement le problème qu'elle résout et, le cas échéant, en liant l'issue associée.
  5. Révision : un mainteneur examinera le changement. Répondez aux commentaires avec de nouveaux commits sur la même branche ; évitez de forcer l'historique sauf demande explicite.

Conventions de codemodifier

  • Rust : le formatage est appliqué avec rustfmt et l'analyse statique avec Clippy ; les deux s'exécutent en CI avec -D warnings, donc tout avertissement bloque l'intégration.
  • TypeScript / Svelte : le frontend suit les règles ESLint et la configuration svelte-check du dépôt.
  • Commentaires et nommage : il est recommandé d'écrire les identifiants et les commentaires en anglais, en suivant le style déjà présent dans le code.
CI bloquante

Les vérifications de formatage, de lints et de tests s'exécutent dans l'intégration continue de GitHub Actions. Une PR ne passera pas en revue complète tant que tous les checks ne sont pas au vert.

Ressources pour les contributeursmodifier

Dépannagemodifier

bun run tauri dev ne démarre pasmodifier

Vérifiez que vous avez installé les dépendances système de Tauri v2 pour votre plateforme. Sur Linux, il s'agit généralement des paquets de développement WebKitGTK et GTK3 ; sur Windows, des Build Tools de Visual Studio et du runtime WebView2.

Erreurs de compilation Rust après une mise à jour du toolchainmodifier

Assurez-vous d'être sur le canal stable avec prise en charge de l'édition 2024 et mettez à jour les dépendances du lockfile :

bash
rustup update stable
bun install --frozen-lockfile

L'interface n'affiche aucune donnée du backendmodifier

Si vous avez démarré uniquement le frontend avec bun run dev, les fonctionnalités qui dépendent de Tauri (IPC) ne sont pas disponibles. Lancez l'application complète avec bun run tauri dev.