Wenn Sie Änderungen als echten Diff anzeigen müssen, bevorzugen Sie das diffs-Tool anstatt einer manuellen Zusammenfassung zu schreiben.
Das diffs-Tool akzeptiert entweder before- + after-Text oder einen einheitlichen patch-String.
Prüfen Sie details.changed: Bei identischer Before/After-Eingabe wird false zurückgegeben, ohne ein Artefakt zu erstellen; gerenderte Ergebnisse geben true zurück.
Verwenden Sie mode=view, wenn Sie einen interaktiven, gateway-gehosteten Viewer wünschen. Nachdem das Tool zurückgekehrt ist, präsentieren Sie details.viewerUrl mit einem verfügbaren Oberflächen-Präsentations-Tool.
Falls die Bereitstellung einen Loopback-Trusted-Proxy verwendet (z. B. Tailscale Serve mit gateway.trustedProxies inklusive 127.0.0.1), können rohe Loopback-Viewer-Anfragen ohne weitergeleitete Client-IP-Header abgelehnt werden. In dieser Topologie bevorzugen Sie mode=file / mode=both, oder verwenden Sie eine konfigurierte viewerBaseUrl / explizite Proxy-/öffentliche baseUrl, wenn Sie eine teilbare Viewer-URL benötigen.
Verwenden Sie mode=file, wenn Sie ein gerendertes Datei-Artefakt benötigen. Setzen Sie fileFormat=png (Standard) oder fileFormat=pdf. Das Tool-Ergebnis enthält details.filePath.
Für große oder hochauflösende Dateien verwenden Sie fileQuality (standard|hq|print) und überschreiben Sie optional fileScale/fileMaxWidth.
Wenn Sie die gerenderte Datei an einen Benutzer oder Kanal ausliefern müssen, verlassen Sie sich nicht auf den rohen Tool-Ergebnis-Renderer. Verwenden Sie stattdessen ein verfügbares Datei-Sende-Tool, um details.filePath als Anhang zu senden.
Verwenden Sie mode=both, wenn Sie sowohl die Gateway-Viewer-URL als auch das gerenderte Artefakt wünschen.
Wenn der Benutzer Standardwerte für das diffs-Plugin konfiguriert hat, verzichten Sie vorzugsweise auf die Angabe von mode, theme, layout und ähnlichen Präsentationsoptionen, es sei denn, Sie müssen sie für diesen speziellen Diff überschreiben.
Geben Sie path für den Before/After-Text an, wenn Sie den Dateinamen kennen.