如何查找节点包的所有选项?

问题描述:

这是关于节点模块的一般性问题。每次我下载一个节点模块时,我都会在网上争取提示我可以将哪些选项传递给节点模块。在github上,似乎只有几个选项可以作为示例,但如果我想查看还有哪些其他选项可用以及它们的功能呢?我该怎么做呢?有没有在命令提示符中查看是否存在所有选项的方法? 脱颖而出例子......我怎么会看到这个选项... https://www.npmjs.com/package/gulp-imagemin如何查找节点包的所有选项?

+0

你是什么意思的选项?如果您需要文档,通常可以在项目官方网站上或github页面的'README'中找到。 - 在你的情况下,options对象是要使用的插件数组 – nicovank

为每个节点模块(包)的文档可在NPM,例如:

默认显示的是项目中的README.md文件。有时它包含整个文档,有时它包含到其他文档或网站的链接。

但是有时它可能是空的或过时的,因为模块及其文档通常是由人们在空闲时间创建的,没有义务保持它的维护或记录良好。

如果没有可用的文档或者您认为文档不足,那么您可以发布问题(通常在GitHub上)或更新文档并发布拉取请求。

查看给定模块的文档以了解如何提供或如何发布问题。在npm上应该有模块页面右侧的问题链接和请求。

我同意威廉关于节点模块的适用性。虽然大多数模块在npmjs.com中都有'some'文档,而模块的存储库中有'some'(如果是公共的,主要是github),但没有标准形式来表示这些功能。而且,在许多情况下,文档并不全面。

理想情况下,我希望在npmjs.com有一个标准的模板,具有以下细节。这将有助于在部署在大型复杂软件系统中时加快模块的消耗和可维护性。

  1. 模块的高级描述。
  2. 其最常见用例列表。
  3. 其最常见(和期望的)拓扑列表
  4. 暴露的API列表及其输入和预期输出,副作用,假设。
  5. 调试潜在问题的提示。
  6. 潜在的副作用(高速缓存,内存,打开FD的,吃剩的光盘文件,网络接入)

人们可以添加他们认为将提高模块的usabillity,我们把它与前/细化项目npm社区。