Aller au contenu principal

Installation

Tout ce dont vous avez besoin pour démarrer avec Pithos : TypeScript, tree-shaking et configuration du bundler.

Installer le package​

Ajoutez Pithos à votre projet avec votre gestionnaire de paquets préféré. Un seul package, tous les modules inclus (Arkhe, Kanon, Zygos, Sphalma et Taphos), zéro dépendance transitive.

npm install @pithos/core

Pithos n'a aucune dépendance runtime et ne fournit que des ES modules.

Pas de CDN ?

Pithos n'est pas disponible via CDN. Toute la bibliothèque est conçue autour d'imports granulaires et du tree-shaking : un CDN chargerait l'intégralité du code, annulant le principal avantage de Pithos. Utilisez un bundler pour n'embarquer que ce dont vous avez besoin.

Configuration TypeScript​

  • Ciblez du JavaScript moderne pour préserver les API natives et l'inférence de types complète : 
    {
      "compilerOptions": {
        "target": "ES2020",
        "module": "ESNext",
        "moduleResolution": "bundler",
        "esModuleInterop": true,
        "skipLibCheck": true
      }
    }
astuce

"moduleResolution": "node" fonctionne aussi, mais "bundler" est recommandé pour l'outillage frontend moderne.

  • Aucun path mapping requis : tout est exposé via les exports du package.
  • Gardez esModuleInterop activé si votre projet mélange CJS/ESM.

Tree-shaking et imports optimaux​

  • Importez à la granularité fonction/module pour garder les bundles petits : 
    import { chunk } from "pithos/arkhe/array/chunk";
    import { parse } from "pithos/kanon";
    import { ok, err } from "pithos/zygos/result/result";
  • Évitez import * as Pithos from "pithos" : le package expose des imports granulaires spécifiquement pour le tree-shaking.
  • Tous les exports sont ESM et sans effets de bord ; les bundlers modernes supprimeront automatiquement le code inutilisé.

Compatibilité​

Bundlers : Vite / esbuild / Rollup / webpack 5+ / Turbopack

Fonctionne directement (ESM + package exports). Gardez build.target au minimum es2020 pour éviter un downleveling inutile.

Frameworks : Pithos est agnostique au framework. Il fonctionne avec React, Vue, Angular, Svelte, Astro, Next.js, Nuxt, vanilla JS, ou tout autre environnement JavaScript (Node.js, Deno, Bun, scripts navigateur...).

Checklist rapide​

  • ☐ Installer via votre gestionnaire de paquets.
  • ☐ Si vous utilisez TypeScript : définir module = ESNext et target >= ES2020 dans tsconfig.
  • ☐ Importer à la granularité fichier pour le tree-shaking.

Et ensuite ?​