📜  npm 发布包 (1)

📅  最后修改于: 2023-12-03 15:18:01.520000             🧑  作者: Mango

NPM 发布包

NPM 是一个包管理器,允许开发者共享和重复使用代码。在 NPM 上发布包是非常简单的,本文将指导你上传自己的包至 NPM。

注册 NPM 账号

如果你还没有 NPM 账号,你需要先注册一个。打开 NPM 官网,点击右上角的“注册”按钮。填写相关信息,完成注册。

创建 npm 包

在你的本地机器上创建自己的 npm 包,可以通过以下步骤:

  1. 创建一个新的文件夹
  2. 在该文件夹中,初始化 npm 包:npm init
  3. 填写相应的信息,如包名、版本、作者、许可等

一个基本的 package.json 文件应该长这样:

{
  "name": "my-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}
编写包代码

在上述步骤中,你已经创建了一个名为 'my-app' 的 npm 包,现在你可以开始编写代码了。你的代码可以存放在 'index.js' 或者其他命名你已设定的文件中,然后把该文件导出作为模块,给其他的程序使用。

// index.js
module.exports = function() {
  console.log('Hello world')
}
发布包
  1. 运行以下命令登录 NPM:
npm login

此命令会要求你输入 npm 帐户名、密码和电子邮件地址。

  1. 运行以下命令将你的程序包上传到 NPM:
npm publish

这会将你的包上传至 NPM,且其他开发者可通过执行以下命令安装并使用你的包:

npm install my-app

现在,你已经成功创建、编写和发布了一个 npm 包。你可以前往 NPM 官网 查看自己上传的这个包。

版本管理

在发布之前,我们必须确保正确的管理版本。每次提交之前,你应该确保修改版本号。引用语义化版本控制(Semantic Versioning)遵循以下格式:

<major>.<minor>.<patch>
  • Major 版本变更时表示 API 不向后兼容的更改:1.0.0 -> 2.0.0
  • Minor 版本变更时表示 API 的新增特性,向下兼容:1.0.0 -> 1.1.0
  • Patch 版本变更时表示修复了一些 bug,向下兼容: 1.0.0 -> 1.0.1

按照这个模式,你可以通过以下方式修改版本:

npm version <major|minor|patch>

或者更具体地,使用显式版本号:

npm version 2.0.0
结论

上传 npm 包并不困难,只需要遵循相应规则,按照流程操作。希望本篇文章能对你提供帮助,使你能成功地上传自己的程序包至 NPM。

参考资料