Aller au contenu principal

Installation

Prérequis​

  • Node.js : >= 22.12.0 (déclaré dans le champ engines du paquet).
  • Un gestionnaire de paquets : npm, yarn ou pnpm.

Le paquet fournit des versions ESM (dist/index.js) et CommonJS (dist/index.cjs), accompagnées des déclarations TypeScript (dist/index.d.ts). Aucun paquet @types supplémentaire n’est nécessaire.

Installation globale (recommandée pour la CLI)​

L’installation globale ajoute l’exécutable openapi-cli à votre PATH :

npm install -g @powerduck/openapi-cli

Vérifiez l’exécutable :

openapi-cli --help

Installation dans le projet (recommandée pour la CI)​

Fixez la version dans le projet pour que la CI utilise une version connue :

npm install --save-dev @powerduck/openapi-cli

Lancez ensuite la commande avec le gestionnaire de paquets :

npx openapi-cli --spec openapi.json
# or
pnpm exec openapi-cli --spec openapi.json

Exécution ponctuelle avec npx​

Sans installation préalable :

npx @powerduck/openapi-cli --spec openapi.json

Structure du paquet​

EntréeChemin
Entrée ESMdist/index.js
Entrée CommonJSdist/index.cjs
Définitions de typesdist/index.d.ts
Entrée CLI (bin)dist/cli.js
Nom de l’exécutableopenapi-cli

Le paquet déclare "type": "module" et n’expose que les sous-chemins . et ./package.json.

Importation dans votre code​

// ESM
import { runTests, resolveConfig } from "@powerduck/openapi-cli";

// CommonJS
const { runTests, resolveConfig } = require("@powerduck/openapi-cli");

Dépendances d’exécution​

Le paquet publié dépend de :

  • @powerduck/openapi-parser (^0.3.12) — déréférencement des $ref internes.
  • @powerduck/openapi-request (0.2.22) — exécution des requêtes des protocoles.
  • commander (^12.1.0) — analyse des arguments de la CLI.
  • https-proxy-agent (^5.0.1) — prise en charge des proxys pour le transport HTTP.

Étapes suivantes​