如何查找節點包的所有選項？

Question

這是關於節點模塊的一般性問題。每次我下載一個節點模塊時，我都會在網上爭取提示我可以將哪些選項傳遞給節點模塊。在github上，似乎只有幾個選項可以作爲示例，但如果我想查看還有哪些其他選項可用以及它們的功能呢？我該怎麼做呢？有沒有在命令提示符中查看是否存在所有選項的方法？ 脫穎而出例子......我怎麼會看到這個選項... https://www.npmjs.com/package/gulp-imagemin

Answer 1

爲每個節點模塊（包）的文檔可在NPM，例如：

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

默認顯示的是項目中的README.md文件。有時它包含整個文檔，有時它包含到其他文檔或網站的鏈接。

但是有時它可能是空的或過時的，因爲模塊及其文檔通常是由人們在空閒時間創建的，沒有義務保持它的維護或記錄良好。

如果沒有可用的文檔或者您認爲文檔不足，那麼您可以發佈問題（通常在GitHub上）或更新文檔併發布拉取請求。

查看給定模塊的文檔以瞭解如何提供或如何發佈問題。在npm上應該有模塊頁面右側的問題鏈接和請求。

Answer 2

我同意威廉關於節點模塊的適用性。雖然大多數模塊在npmjs.com中都有'some'文檔，而模塊的存儲庫中有'some'（如果是公共的，主要是github），但沒有標準形式來表示這些功能。而且，在許多情況下，文檔並不全面。

理想情況下，我希望在npmjs.com有一個標準的模板，具有以下細節。這將有助於在部署在大型複雜軟件系統中時加快模塊的消耗和可維護性。

1. 模塊的高級描述。
2. 其最常見用例列表。
3. 其最常見（和期望的）拓撲列表
4. 暴露的API列表及其輸入和預期輸出，副作用，假設。
5. 調試潛在問題的提示。
6. 潛在的副作用（高速緩存，內存，打開FD的，吃剩的光盤文件，網絡接入）

人們可以添加他們認爲將提高模塊的usabillity，我們把它與前/細化項目npm社區。