Vérifier un projet

aarshi status lit votre projet et signale ce qui manque ou ce qui ne va pas. C'est une vérification en lecture seule : elle ne modifie aucun fichier, vous pouvez la lancer aussi souvent que vous voulez. aarshi check est un raccourci qui donne le même rapport.

Lire le rapport

Le rapport contient une section par sujet, dans cet ordre : config, i18n, pages, sections, components et dependencies. Un sujet sans rien à signaler affiche un ✓. Sinon, ses constats sont listés dessous :

error
Quelque chose est cassé ou manque. Le rapport le compte, et le code de sortie est 1.
todo
Quelque chose n'est pas terminé, comme une traduction vide. Le rapport le compte, mais le code de sortie reste 0.

La dernière ligne donne le verdict sur tout le projet : ✓ project is conformant, ✓ project is conformant (N to do) ou error: N errors, M to do.

Codes de sortie

CodeSignification
0Aucune erreur. Des todos seuls donnent encore 0.
1Au moins une erreur a été trouvée.
2Le projet ne peut pas être lu : aarshi.toml est absent, illisible ou invalide. Le message part sur la sortie d'erreur, et rien n'est écrit sur la sortie standard.

Le code de sortie sert dans les scripts et l'intégration continue : un code différent de zéro arrête le pipeline.

Options

--dimension <nom>
N'affiche que certains sujets. Répétez l'option ou séparez les noms par des virgules : --dimension config,i18n. Le filtre ne change que l'affichage : le code de sortie et le résumé couvrent toujours tout le projet, et une ligne indique combien de constats sont masqués.
--errors-only
Masque les lignes todo. Le verdict et le code de sortie ne changent pas.
--json
Affiche un document JSON unique à la place du rapport, pour d'autres outils. Il contient un champ format_version (actuellement 1), un summary global, et la liste des constats avec leur règle, leur gravité et leur emplacement. Avec le code de sortie 2, rien n'est écrit sur la sortie standard.

Les sujets

SujetCe qu'il vérifie
configLes fichiers et dossiers de base, aarshi.toml, le branchement de Tailwind, et les options cohérentes avec les fichiers.
i18nLes dictionnaires : mêmes clés dans chaque langue, valeurs vides, doublons, langues déclarées dans les fichiers de configuration.
pagesQue chaque route a une vue, que chaque vue a une route, et que le plan du site liste les pages.
sectionsQue chaque section est importée et utilisée dans sa vue, et que ses clés existent.
componentsLes imports de vos composants, et que chaque icône a son composant.
dependenciesQue les paquets importés par votre code sont déclarés dans package.json, et que le fichier de verrouillage correspond à package_manager.

Chaque sujet liste ses règles exactes dans le fichier CONVENTIONS.fr.md du dépôt.