Wie finden Sie alle Optionen für ein Knotenpaket?

Question

Dies ist eine allgemeine Frage zu Knotenmodulen. Jedes Mal, wenn ich ein Node-Modul herunterlade, kramte ich online nach Hinweisen, welche Optionen ich an das Node-Modul weitergeben kann. Auf github gibt es nur ein paar Beispiele als Beispiel, aber was ist, wenn ich sehen möchte, welche anderen Optionen verfügbar sind und was sie tun? Wie mache ich das? Gibt es einen Weg in der Eingabeaufforderung, um zu sehen, ob alle Optionen existieren? Vordergrund Beispiel ... wie würde ich sehen die Optionen für diese ... https://www.npmjs.com/package/gulp-imagemin

Answer 1

Die Dokumentation für jeden Node-Modul (Paket) auf npm zur Verfügung steht, zB:

• https://www.npmjs.com/package/gulp-imagemin

Standardmäßig wird die Datei README.md im Projekt angezeigt. Manchmal enthält es die gesamte Dokumentation, manchmal enthält es Links zu anderen Dokumenten oder Websites.

Aber manchmal kann es leer oder veraltet sein, weil die Module und ihre Dokumentation in der Regel von Menschen in ihrer Freizeit erstellt werden, ohne die Verpflichtung, sie aufrechtzuerhalten oder gut dokumentiert zu halten.

Wenn keine Dokumentation verfügbar ist oder Sie der Meinung sind, dass die Dokumentation nicht ausreicht, können Sie entweder ein Problem veröffentlichen (normalerweise auf GitHub) oder die Dokumentation aktualisieren und eine Pull-Anforderung senden.

In der Dokumentation eines bestimmten Moduls erfahren Sie, wie Sie Beiträge beisteuern oder Probleme melden können. Es sollte Links zu Problemen geben und Anfragen auf der rechten Seite der Modulseite auf npm ziehen.

Answer 2

Ich stimme dem William in Bezug auf die Usabiity von Knotenmodulen zu. Während die meisten Module "einige" Dokumentationen in npmjs.com und "einige" im Repository des Moduls enthalten (wenn public, meist github), gibt es kein Standardformular, in dem die Fähigkeiten dargestellt werden. In vielen Fällen ist die Dokumentation nicht umfassend.

Idealerweise würde ich erwarten, eine Standardvorlage im npmjs.com mit diesen unten genannten Details zu haben. Dies würde helfen, den Verbrauch und die Wartungsfreundlichkeit des Moduls zu beschleunigen, wenn es in großen und komplexen Softwaresystemen eingesetzt wird.

1. Eine detaillierte Beschreibung des Moduls.
2. Liste der häufigsten Anwendungsfälle.
3. Liste der häufigsten (und gewünschten) Topologien
4. Liste der exponierten APIs mit ihren Eingaben und erwarteten Ergebnissen, Nebenwirkungen, Annahmen.
5. Tipps zum Debuggen der potenziellen Probleme.
6. Mögliche Nebenwirkungen (Cache, Speicher, offen fd die, übrig gebliebene Disc-Dateien, Netzwerkzugriff)

Menschen können hinzufügen/verfeinern Gegenstände, die sie denken, wird an der Verwendbarkeit der Module verbessern, bevor wir es mit dem Anspruch nehmen npm Gemeinschaft.