Skip to content

Flux de développement du dépôt

Cette page décrit le flux mainteneur recommandé pour faire évoluer nuxt-feathers-zod sans désynchroniser le code, le CLI et la documentation.

Objectif

Chaque patch doit conserver le même contrat entre :

  • le runtime Nuxt/Feathers généré ;
  • les commandes CLI et les templates produits ;
  • la documentation VitePress ;
  • les scripts de validation et de packaging.

Cycle de travail recommandé

bash
bun install
bun run typecheck
bun run lint:fix
bun run docs:build
bun run verify:all
npm pack

Pour un patch de release, mets aussi à jour :

  • package.json ;
  • README.md et README_fr.md ;
  • CHANGELOG.md ;
  • les notes de version publiques ;
  • les pages VitePress impactées par le changement.

Règles de cohérence

RuntimeConfig

Le contrat runtime officiel utilise :

ts
runtimeConfig._feathers
runtimeConfig.public._feathers

Les anciens chemins runtimeConfig.feathers et runtimeConfig.public.feathers ne doivent plus être introduits dans le code généré.

Client navigateur

Les fichiers runtime servis au navigateur doivent éviter les imports ESM/CJS fragiles depuis @feathersjs/* et feathers-pinia.

Le contrat standard reste :

  • client Feathers natif exposé via $api, $client, $feathersClient ;
  • Pinia utilisé pour la session applicative ;
  • feathers-pinia optionnel, non requis pour l'auth runtime standard.

Documentation

Avant publication, bun docs:build doit passer sans lien mort. Les liens internes doivent pointer vers des pages réellement présentes dans docs/.

Voir aussi

Documentation du module nuxt-feathers-zod