Le fichier aarshi.toml
Chaque projet aarshi a un fichier aarshi.toml à sa racine. Il garde les choix faits pendant setup, pour que chaque commande suivante sache comment le projet est construit.
À quoi il ressemble
Après aarshi setup mon-site --languages fr,en --default-language fr --yes, le fichier contient :
languages = ["fr", "en"]
package_manager = "npm"
ui = "shadcn"
icons = "lucide"
cache_components = false
site_url = "http://localhost:3000"
Les clés
| Clé | Valeurs | Ce qu'elle contrôle |
|---|---|---|
languages |
Une liste de codes, par exemple ["fr", "en"] |
Les langues du site. La première est la langue par défaut : elle est servie à /, et son dictionnaire sert de référence pour typer les autres. |
package_manager |
npm, pnpm, yarn, bun |
L'outil qui installe les dépendances, et le fichier de verrouillage attendu par aarshi status. |
ui |
shadcn, base-ui |
shadcn (stylé, construit sur Base UI), ou Base UI seul. |
icons |
lucide, none |
La bibliothèque d'icônes (lucide-react), ou aucune. |
cache_components |
true, false |
Active la fonctionnalité Cache Components de Next.js. Désactivée par défaut. |
site_url |
Une URL complète, par exemple https://example.com |
L'adresse publique du site. Elle est recopiée dans lib/site.ts. |
Les règles
- Chaque clé est facultative. Une clé absente prend sa valeur par défaut :
freten, npm, shadcn, lucide, Cache Components désactivés,http://localhost:3000. - Une clé inconnue arrête aarshi avec une erreur. Vérifiez l'orthographe si cela arrive.
- La configuration utilisateur,
~/.config/aarshi/config.toml, fixe les valeurs par défaut des nouveaux projets. La clélanguagesd'aarshi.tomlremplace la liste de l'utilisateur pour ce projet. - Si une clé de la liste ci-dessus manque,
aarshi statussignale untodo(config.project-file-incomplete). Rien n'est cassé, mais le fichier n'est pas complet.
Faut-il le modifier à la main ?
Modifier site_url ou cache_components à la main ne pose pas de problème. Pour les langues, préférez aarshi add-lang : la commande crée aussi le dictionnaire, les fichiers de configuration et la liste d'aarshi.toml. Ajouter un code à la liste à la main ne crée pas son dictionnaire.
Gardez ce fichier dans votre projet. Versionnez-le avec le reste du code. Chaque commande d'aarshi le lit, et sans lui aarshi ne reconnaît pas le dossier comme un projet.