本篇文章可以作为你掌握npm的简易指南
你写了很多优秀的代码,心中总是憋着一股劲,不知道怎么施展拳脚。现在,你就将之发布到npm上吧,让你的代码得到更多的曝光,也能让更多的人使用上你的代码!
新建目录
让我们新建一个文件夹,这个文件夹就是源码存放的地方,打开控制台:
# 创建并进入 'wonderful-bundle' 目录
$ mkdir wonderful-bundle
$ cd wonderful-bundle
初始化
现在我们已经在项目的文件夹中了,使用npm的命令快速初始化一个项目
npm init
运行这个命令后,会有一系列的问题(包名、包描述等),如实填写即可。
如果你先填写信息比较麻烦,可以使用回车键快速的使用默认回答。甚至你可以直接使用npm init -y将所有的问题都设置为默认回答。
执行完init命令后,会自动在文件夹中创建package.json文件:
{
"name": "wonderful-bundle",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
package.json 文件的作用
package.json包含了你的库的所有信息,你可以简单的理解成是你库的说明书。
让我们为package.json添加个描述description和作者author:
{
"name": "wonderful-bundle",
"version": "1.0.0",
"description": "outputs an uplifting message",
"main": "index.js",
"author": "徐晓倩 <416876921@qq.com>",
"license": "ISC"
}
其中name、version、main是必须字段,分别代表着库的名字,版本和入口文件。scripts字段也是很常用的,后面会提到。我们先来创建入口文件index.js:
$ touch index.js
简单的编辑下入口文件index.js:
module.exports = function() {
console.log("you're wonderful!");
return;
};
创建README
通常,我们也会为库提供使用文档或者介绍性的资料,这不止于让别人用起来一脸懵逼,或者还没开始使用就望而却步。基于此,README文件是个很好的选择,基本上所有的库都会提供README,你可以去github上随意点开几个有名或者无名的库,都会有README文件,而且README文件会被github等源码托管网站使用成首页:
# create the README file
$ touch README
# put some text into README
$ echo "## Wonderful Bundle \n\n Get an uplifting message!" > README
发布
到目前为止,我们的库wonderful-bundle,应该像这样了:
wonderful-bundle
|_ index.js
|_ README
|_ package.json
通常,这就是最简单的一个npm包了,其实就是这么简单。让我们来发布它吧:
$ npm publish
这里需要注意下,你得首先有个npm账号,没有的话,直接去官网注册一个。其次,你要是未登录状态的话,会提示你怎么登陆。最后一点,这个包名是不能重名的哦!
总结
是不是很简单,就这么几步就能将你的代码发布到npm上了。概括起来,其实只需要三步:
- 初始化:
npm init - 添加源码:
index.js和README - 发布:
npm publish
现在,要是有人想使用你的库,只需要使用npm安装一下:
$ npm install wonderful-bundle
最后,希望本文能够帮助到你,就是这么简单,你开始为开源做贡献啦!