DocsConventions et concepts
Glossaire
Les mots utilisés dans ces documents, une ligne chacun, par ordre alphabétique. Un terme qui nécessite plus qu'une ligne a une page : suivez le lien. Pour savoir comment les notions s'articulent, lisez Concepts de base.
Conditions
| Terme | Sur une seule ligne |
|---|---|
| Action | une fonction Python marquée @Action, servant de POST et appelable depuis le client (actions) |
| ASGI | l'interface Uvicorn parle, implémentée par FastAPI et Starlette |
| Mode client | useCSR = True : les fichiers du framework sont les routes et le navigateur navigue (modes) |
| Composant | un bloc de construction d'interface utilisateur réutilisable utilisé pour composer une vue (vues) |
| CSR | rendu côté client : le navigateur restitue les pages après le premier document (CSR) |
| Dépendance | une fonction FastAPI s'exécute avant un gestionnaire, par route ou par dossier (dépendances) |
| Coquille de document | les <html>, <head> et <body> autour d'une page, appartenant à la mise en page la plus proche ou à Nexy (mises en page) |
| Endpoint | la combinaison unique d'une URL et d'une méthode HTTP (vues) |
| Routage basé sur fichier FBR | : un fichier sous src/routes/ est une route (routage) |
| Frontmatter | le bloc Python entre les deux lignes --- d'un fichier .nexy ou .md (fichiers .nexy) |
| Garder | une dépendance qui refuse une demande en levant HTTPException (gardes) |
| Gestionnaire | une fonction Python qui gère une requête HTTP pour une méthode spécifique (vues) |
| HMR | remplacement de module à chaud : le serveur de développement échange les modules qui ont changé, sans rechargement complet (frontend) |
| Hydratation | le navigateur attachant un framework au HTML que le serveur a déjà envoyé (îles) |
| Island | un composant client monté dans une page rendue par le serveur (îlots) |
| ISR | régénération statique incrémentielle : une page mise en cache par chemin, actualisée en arrière-plan (ISR) |
| Layout | un fichier layout.* qui enveloppe les pages sous son dossier (mises en page) |
| Routeur modulaire | routes déclarées avec @Module et @Controller sous src/apps/ (modulaire) |
| Page | une ressource adressable par URL définie par un fichier sous src/routes/ (vues) |
| Prefetch | chargeant la page derrière un lien avant que le lecteur ne clique dessus (liens) |
| Props | les valeurs qu'un parent transmet à un composant (fichiers .nexy) |
| Revalider | le nombre de secondes après lequel une page ISR est reconstruite en arrière-plan (ISR) |
| Route | un modèle d'URL, produit par le chemin d'un fichier de route (routage) |
| Groupe de routes | un dossier entre parenthèses qui regroupe les routes sans ajouter de segment (routes dynamiques) |
| Gestionnaire de route | la fonction GET, POST, … d'un fichier de route .py (gestionnaires) |
| Mode serveur | useCSR = False, par défaut : le serveur restitue les pages .nexy et .md (modes) |
| Compétence | un dossier avec un SKILL.md qui enseigne à un agent de codage une partie de Nexy (agents de codage) |
| SSG | génération de sites statiques ; pas un mode Nexy : le HTML construit en amont est toujours relu par le serveur (rendu) |
| Rendu côté serveur SSR | : le serveur restitue chaque page pour sa demande, et c'est la valeur par défaut (SSR) |
| Visualiser | le processus de production du corps de réponse d'une page (vues) |
Fichiers et dossiers
| Nom | Sur une seule ligne |
|---|---|
__nexy__/ |
sortie générée : les pages compilées, l'entrée client et l'action client ; jamais édité, jamais commis |
nexyconfig.py |
la configuration du projet, une classe de use* champs (configuration) |
public/ |
fichiers servis à la racine, tels que public/logo.svg → /logo.svg (conventions de fichiers) |
src/apps/ |
contrôleurs et modules du routeur modulaire (modulaire) |
src/components/ |
composants importés par pages ; jamais de routes (conventions de fichiers) |
src/routes/ |
les routes de l'application (conventions de fichiers) |
Prochaines étapes
- Concepts de base : le modèle auquel ces mots appartiennent
- Index de la documentation : la page correspondant à la tâche à accomplir
- Conventions des fichiers : les noms réservés derrière ces définitions
- Pour les agents IA : les mêmes invariants, écrits pour un agent