Premiers pas

Générez une documentation de plugin Capacitor qui inclut les membres hérités via extends en TypeScript. Ce fork de @capacitor/docgen d’Ionic est maintenu de manière indépendante.

Essayer dans un petit projet de test

mkdir docgen-demo
cd docgen-demo
npm init -y
npm install --save-dev @rdlabo/capacitor-docgen@0.4.1

N’installez pas le package d’origine @capacitor/docgen dans le même projet ; les deux packages fournissent l’exécutable docgen.

Créez src/definitions.ts :

export interface SharedOptions {
  requestId?: string;
}

export interface CreateOptions extends SharedOptions {
  value: string;
}

export interface MyPlugin {
  create(options: CreateOptions): Promise<void>;
}

Créez tsconfig.json :

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "strict": true
  },
  "files": ["src/definitions.ts"]
}

Créez README.md avec les espaces réservés que docgen met à jour :

<docgen-index></docgen-index>

<docgen-api></docgen-api>

Exécutez :

npx docgen --project tsconfig.json --api MyPlugin --output-readme README.md --output-json dist/docs.json

La documentation générée pour CreateOptions inclut à la fois value et requestId. Modifiez les interfaces TypeScript ou les commentaires JSDoc pour changer le contenu généré ; le texte en dehors des marqueurs est conservé. Après les modifications, relancez la même commande.

Pour intégrer l’outil au processus d’un plugin existant, vous pouvez ajouter un script à package.json, par exemple "docgen": "docgen --api MyPlugin --output-readme README.md". Ce script est facultatif pour ce projet de test.

Documentation

• Différences avec le projet d’origine