- Documentation
- Contribuer
Travailler sur le SDK
Il vous faut Node 22.12 et pnpm 9. Si votre Node système est plus ancien, dites à pnpm d'utiliser 22.12 pour tous les projets avec echo "use-node-version=22.12.0" >> ~/.npmrc (votre propre fichier, pas celui du dépôt), ou utilisez nvm use (le dépôt a un .nvmrc).
pnpm install
pnpm dev # serveur HTTPS : ouvrez l'adresse Network sur un téléphone du même Wi-Fi
pnpm build # construit tous les paquets
pnpm test # construit, puis tests unitaires (Vitest)
pnpm test:e2e # construit, puis tests navigateur (Playwright, Chrome, fausse caméra)
pnpm lint
pnpm typecheck
pnpm format:check
pnpm check:licenses # échoue sur une licence interdite ou une dépendance absente de NOTICE.md
pnpm size # budgets gzip des bundles
Comment on travaille. Une case de la feuille de route par session. On écrit un plan, on le fait approuver, puis on implémente avec des tests. Le développeur ne coche une case qu'après un test sur un vrai téléphone. examples/ et le Viewer doivent marcher après chaque changement. Un nouvel exemple entre dans examples/library.json dans le même changement, avec les textes français et anglais (un test échoue si une page manque).
Tests. Les tests unitaires couvrent la logique. Les tests navigateur utilisent une vidéo générée comme fausse caméra, donc le vrai suivi d'images tourne sans téléphone, et un téléphone RA émulé (IWER) fait tourner le code du suivi du monde. Ce qu'ils ne peuvent pas tester, ce sont de vrais téléphones dans une vraie lumière : essayez le nouveau travail sur un téléphone et notez les résultats dans docs/device-matrix.md.
Test sur téléphone. pnpm dev affiche une adresse Network. Ouvrez-la sur un téléphone (voir docs/dev-on-phone.md pour l'avertissement de certificat). Ajoutez ?test à n'importe quel exemple pour la console de test.
Déployer le site. pnpm site:build écrit le guide, les exemples et les fichiers du CDN dans site/ ; Vercel publie la branche main.
Publier les paquets. Voir Publier le SDK.