1、知道模块名,寻找模块的文档
在看别人的代码或者文章的时候,经常会遇到自己没用过的第三方模块,怎么办呢?
其实很简单,你只要在浏览器中输入网址 https://npmjs.org/package/模块名称
,即可
进入这个模块的介绍页面。比如,别人的源码中出现一行 var xss = require('xss')
,
说明这里使用到了 xss
这个模块,在浏览器中打开 https://npmjs.org/package/xss
,即可进入这个模块在 NPM 上的主页:
模块主页中显示这个模块的简介、作者、当前版本号、最后更新时间、模块源码链接、 报告 Bug 的链接和 README 页面。一般 README 页面都会简要地写出了模块的用途、用法 等等信息,大多数模块也都是托管在 Github 上的,直接点模块源码链接(Repository) 即可跳到其在 Github 上的主页,可以通过这里获得更多的帮助。
2、不知道模块名,根据关键字搜索需要的模块
我们可以通过 NPM 来寻找自己需要的模块。打开 NPM 的首页 https://npmjs.org/
,
在 Logo 的右边,有一个搜索框,只要在上面输入关键字,即可搜索出相应的模块。比如
我们要搜索“模板”相关的模块,在搜索框输入 template
并按回车:
页面中显示出了相应的模块名称、简介、作者和当前版本,直接点击模块名称即可进入这个 模块的主页。
但是, NPM 的搜索结果中,我们没法直接看到这个模块有多少人用,最后更新时间是什么 时候了(有些模块可能已经是几年前的了),怎么办?这就要用到我压箱底多年的工具了, 一般人我不告诉他的:
在浏览器中打开 http://eirikb.github.io/nipster/
(由于要加载所模块的信息,可能
要等一阵才能完全显示出来):
在搜索栏中输入关键字,会自动筛选出相应的模块。模块信息包括了模块名称、简介、 作者、最后更新时间、Fork 数量和收藏数量。默认按照 Fork 数量降序排序,基本上 最前面的结果是最多人用的。
上面简单介绍了两种寻找 Node.js 模块的方法,学会了这两招之后,妈妈基本上再也不用 担心你找不到好模块了。