Erste Schritte
Erstellen Sie eine Capacitor-Plugin-Dokumentation, die über TypeScript-extends geerbte Member enthält. Dieser Fork von Ionics @capacitor/docgen wird unabhängig gepflegt.
In einem kleinen Testprojekt ausprobieren
mkdir docgen-demo
cd docgen-demo
npm init -y
npm install --save-dev @rdlabo/capacitor-docgen@0.4.1
Installieren Sie das ursprüngliche @capacitor/docgen nicht im selben Projekt; beide Pakete stellen die ausführbare Datei docgen bereit.
Erstellen Sie src/definitions.ts:
export interface SharedOptions {
requestId?: string;
}
export interface CreateOptions extends SharedOptions {
value: string;
}
export interface MyPlugin {
create(options: CreateOptions): Promise<void>;
}
Erstellen Sie tsconfig.json:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"strict": true
},
"files": ["src/definitions.ts"]
}
Erstellen Sie README.md mit den Platzhaltern, die docgen aktualisiert:
<docgen-index></docgen-index>
<docgen-api></docgen-api>
Führen Sie folgenden Befehl aus:
npx docgen --project tsconfig.json --api MyPlugin --output-readme README.md --output-json dist/docs.json
Die generierte Dokumentation für CreateOptions enthält sowohl value als auch requestId. Ändern Sie die TypeScript-Schnittstellen oder JSDoc-Kommentare, um den generierten Inhalt anzupassen; der Text außerhalb der Marker bleibt erhalten. Führen Sie nach Änderungen denselben Befehl erneut aus.
Für den Workflow eines bestehenden Plugins können Sie ein Skript in package.json ergänzen, zum Beispiel "docgen": "docgen --api MyPlugin --output-readme README.md". Für dieses Testprojekt ist das optional.