如何创建一个npm包

发表于 | 更新于 | 分类于
字数统计 273 | 阅读时长 1
如何创建一个npm包

注册npm账号

去 官网 注册一个账号，后面发布npm包时会用到。

创建包

1
➜  mkdir grimoire-tool && cd grimoire-tool

初始化包

带上 –yes 会直接创建一默认的 package.json ，后面可以直接修改文件内容。

1
➜  npm init

或者 

1
➜  npm init --yes

我的 package.json 文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "name": "grimoire-tool",
  "version": "1.0.0",
  "description": "魔法书的工具包 grimoire-tool",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/LeungGeorge/grimoire-tool.git"
  },
  "keywords": [
    "魔法书的工具包"
  ],
  "author": "liangyuanzheng",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/LeungGeorge/grimoire-tool/issues"
  },
  "bin": {
    "grimoire-tool": "./bin/grimoire-tool"
  },
  "homepage": "https://github.com/LeungGeorge/grimoire-tool"
}

编辑包

可以看到，我这个包使用的 git 的一个编译产出：

1
2
3
"bin": {
    "grimoire-tool": "./bin/grimoire-tool"
  },

发布包

发布（版本号 v1.0.0 ）：

1
➜  npm publish

发布后可以继续打补丁（版本号 v1.0.1 ）：

1
➜  npm version patch

查看发布结果

1
2
3
➜  npm search grimoire-tool
NAME                      | DESCRIPTION          | AUTHOR          | DATE       | VERSION  | KEYWORDS
grimoire-tool             | 魔法书工具包           | =liangyuanzheng | 2020-02-04 | 1.0.2    | 魔法书 工具包

20200131220947.png

0%