Accueil › Angular › Créer une librairie Angular
Créer une librairie Angular
Librairies et monoreposavance
Une librairie Angular se crée dans un workspace existant (créé avec ng new mon-workspace --no-create-application s'il n'y a pas déjà d'application), avec :
ng generate library acme-ui
Le CLI ajoute un projet projects/acme-ui avec une configuration dédiée dans angular.json — un builder différent de celui d'une application : @angular/build:ng-packagr au lieu de @angular/build:application. C'est ng-packagr qui compile la librairie, pas esbuild/Vite directement.
Deux fichiers structurent tout : src/public-api.ts, qui définit l'API publique (tout ce qu'il exporte devient accessible aux consommateurs, le reste reste interne), et ng-package.json, qui configure ng-packagr (dossier de sortie, fichier d'entrée, fichiers à copier tels quels).
// projects/acme-ui/ng-package.json
{
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
"dest": "../../dist/acme-ui",
"lib": {
"entryFile": "src/public-api.ts"
}
}
Dans le package.json de la librairie, @angular/core et @angular/common doivent figurer en peerDependencies, jamais en dependencies : c'est l'application consommatrice qui fournit Angular, pas la librairie. On construit avec ng build acme-ui ; le résultat (dans dist/acme-ui) est ce qui sera publié ou consommé.
Les termes à connaître
- ng generate library
Commande CLI (
ng g library <nom>) qui crée un nouveau projet de type librairie dans un workspace Angular existant, sousprojects/<nom>par défaut, avec sa propre configuration dansangular.json.- public-api.ts
Fichier d'entrée de la librairie. Tout ce qui y est exporté (
export * from './...') devient accessible aux applications qui importent la librairie ; tout le reste reste interne.- API publique
Surface exposée par une librairie à ses consommateurs : composants, directives, pipes, services, types, jetons d'injection destinés à être utilisés en dehors de la librairie. Distincte de l'implémentation interne, qui peut changer sans casser les consommateurs.
- ng-package.json
Fichier de configuration lu par ng-packagr : destination de sortie (
dest), fichier d'entrée de l'API publique (lib.entryFile), fichiers à copier tels quels (assets), entre autres.- ng-packagr
Outil de build qui compile une librairie Angular au format de package Angular (APF), utilisé par le builder
@angular/build:ng-packagr— distinct du builder d'application (@angular/build:application, esbuild/Vite) utilisé pourng serve/ng buildd'une application.- peerDependencies
Section du
package.jsonpublié qui déclare une dépendance que le projet consommateur doit fournir lui-même (ex.@angular/core), plutôt qu'une dépendance embarquée et installée automatiquement par npm.- Point d'entrée secondaire
Sous-partie de la librairie importable via un chemin distinct (ex.
acme-ui/testing), avec son proprepublic-api.tset son propreng-package.jsonminimal, dans un sous-dossier de la librairie.- Compilation partielle (partial Ivy)
Mode de compilation (
"compilationMode": "partial") qui produit un code intermédiaire indépendant de la version exacte d'Angular utilisée à la compilation, recompilé par l'application consommatrice. C'est le mode recommandé pour publier une librairie, par opposition à la compilation complète (full Ivy), liée à une version précise.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.