参考文章:[译] 创建并发布一个小而美的 npm 包,没你想的那么难!
今天突发奇想像发布一个自己的npm包,然后在网上找教程,最后找到了这篇《[译] 创建并发布一个小而美的 npm 包,没你想的那么难!》,然后就跟着教程,手把手开始。
npm: www.npmjs.com/package/ima…
创建一个npm账号
创建好账号之后需要在注册的邮箱点邮件确认一下,不然等下推包会报403没权限。
创建好账号后在命令行中登录
$ npm login
如何查看自己是否已经登录?
$ npm whoami
初始npm包
新建一个文件,取一个你喜欢的名字:image-color-tool,然后创建package.json文件
package.json
{
"name": "image-color-tool",
"version": "1.0.0",
"description": "图片颜色处理",
"main": "index.js",
"repository": "https://gitee.com/wongest/image-color-tool",
"keywords": [
"image",
"color"
],
"author": "黄庄妮",
"license": "ISC"
}
说明:
- repository:一般是git的地址
- main:指向 commonjs 模块的入口,使用 require 语法引入
- keywords:关键词
发布
$ npm publish --access=public
public代表这是一个公共的npm包
实现功能
在package.json所在的目录新建一个index.js文件
index.js
export const getImageColor = () => {
// ...
}
确保package.json中的main指向这个index.js文件
然后再次推包,在推包前修改一下版本号,然后再推包
$ npm publish
README.md
完成了上面的操作之后,我们npm包的基本功能就实现了,在npm也能看到我们创建的包,npm网站上是空空的,我们需要搞个说明文档
在根目录上创建README.md文件
这是我的npm上的截图
这两个image-color-tool和minified标签是在www.shields.io/生成的
当完成之后重新推包,npm网站上就会显示你README.md上的内容
es6转es5
loading...