如何发布模块到NPM

创建项目

首先，先用 init 命令创建一个自己的项目。

npm init

name: (my-npm)
version: (1.0.0)
description: 0.0.1
entry point: (index.js)
test command:
git repository:
keywords:
author: Awe
license: (ISC) MIT
About to write to F:\github\my-npm\package.json:
{
  "name": "my-npm",
  "version": "1.0.0",
  "description": "0.0.1",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Awe",
  "license": "MIT"
}
Is this ok? (yes)

接着就依次填写, 不想填写的话也可以一路Enter

名词解释

name:

模块名，之后发布之后就可以让用户npm install xxxx来引用你的开源模块了

version:

版本号，语义版本号分为X.Y.Z三位，分别代表主版本号、次版本号和补丁版本号。当代码变更时，版本号按以下原则更新。

description:

简单介绍自己的模块

main:

入口文件，必要，当通过require(‘xxx’)时，是读取main里声明的文件

test command:

测试命令

git repository:

git仓库地址

keywords:

关键词，可以通过npm搜索你天蝎的关键词找到你的模块

author:

作者信息，可以之后编辑更详细一些

license(ISC);

代码授权许可证

以上放心可以大胆写，因为之后都可以修改。

package.json

初始化项目完成，可以看到目录中出现了一个叫 package.json 的文件

{
  "name": "my-npm",
  "version": "1.0.0",
  "description": "0.0.1",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Awe",
  "license": "MIT"
}

更多配置信息可以参考一下vue的package.json的https://github.com/vuejs/vue/blob/dev/package.json

发布模块

在npm注册用户
在本地登录自己的npm账号
1
npm login

发布模块

1
2
3

npm publish
//返回下面的信息就是发布成功了
+ qarticles@0.3.4

其他一些命令

npm update <package>
//可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。
npm cache clear
//可以清空NPM本地缓存，用于对付使用相同版本号发布新版本代码的人。
npm unpublish <package>@<version>
//可以撤销发布自己发布过的某个版本代码。

Sayings

经常在GitHub上看到项目的readme中写有 npm install XXX –save ，后来引用的多了便想：我们install的模块又是哪里来的呢？

又是查看资料(万能的Google)后，发现了npmjs，了解到了npm更多的知识。