首先是要有一个npm 账号
因为你的包是要放在npm上的,所以,首先要注册一个npm账号。
直接在npm官网注册就可以了
复制代码
初始化文件夹
进入到文件夹以后执行npm init 命令,执行命令之后会出现几个填写的字段
复制代码
- name:填写你这个包的名字,默认是你这个文件夹的名字。不过这里要着重说一下,最好先去npm上找一下有没有同名的包。最好的测试方式就是,在命令行里面输入npm install 你要取的名字,如果报错,那么很好,npm上没有跟你同名的包,你可以放心大胆地把包发布出去。如果成功下载下来了。。。那么很不幸,改名字吧。。。
- version:你这个包的版本,默认是1.0.0
- description:其实我也不知道是什么,按回车就好了。。。,这个用一句话描述你的包是干嘛用的,比如我就直接:‘a plugin for express.register routes base on file path’
- entry point:入口文件,默认是Index.js,你也可以自己填写你自己的文件名
- test command:测试命令,这个直接回车就好了,因为目前还不需要这个。
- git repository:这个是git仓库地址,如果你的包是先放到github上或者其他git仓库里,这时候你的文件夹里面会存在一个隐藏的.git目录,npm会读到这个目录作为这一项的默认值。如果没有的话,直接回车继续。
- keyword:这个是一个重点,这个关系到有多少人会搜到你的npm包。尽量使用贴切的关键字作为这个包的索引。我这个包嘛,第一是在express下工作的,然后又是一个插件plugin,然后又是一个注册路由route用的,而这个路由又是基于文件目录dir,所以很好就得出我的包的索引关键字。
- author:写你的账号或者你的github账号吧
- license:这个直接回车,开源文件来着。。。
准备lib文件夹
在当前文件夹建一个名为 lib的文件夹,这是规定,只能改成这个名字,然后建一个index.js 的文件,这个文件就是你要发布的包,在这个文件的最后要加上一个到处语句
module.exports=require('./lib')
这样别人久能require 你写的模块来在项目中使用
最后的操作
在你的目录下使用 *npm publish* 命令,输入账号密码,那这样就发布了一个 npm 包,是不是非常简单呢,赶紧来试试吧!
复制代码