npm 包 pub 使用教程

前言

npm 是 Node.js 平台的包管理器，通过它可以方便地查找、安装、管理和发布 Node.js 包。在前端开发中，使用 npm 包极大地提高了代码的复用性和模块化程度。本文将主要介绍如何使用 npm 包 pub，将前端代码发布到 npm 上供其他开发者使用。

准备工作

1. 安装 Node.js 和 npm

在开始使用 npm 包 pub 之前，必须安装 Node.js 和 npm。Node.js 的官方网站提供了安装包和源码包，地址：https://nodejs.org/，建议选择当前稳定版本进行安装。

1. 注册 npm 账号

如果还没有 npm 账号，需要先创建一个账号。通过以下命令在终端中执行注册：

npm adduser

执行后，依次输入用户名、密码和邮箱，注册成功后就可以使用 npm 包了。

如何使用 npm 包 pub

安装

在开始发布前，可先本地安装 npm 包 pub。

npm install pub -g

-g 参数为全局安装。

初始化项目

使用 pub 时，需要在项目根目录下使用以下命令初始化一个 package.json 文件。

npm init

执行之后，根据提示依次输入项目名称、版本、描述、入口文件、测试命令、Git 仓库、作者信息等，最终将自动生成 package.json 文件，如下所示：

// www.javascriptcn.com code example
{
  "name": "your-package-name",
  "version": "1.0.0",
  "description": "your-package-description",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/your-github-username/your-package-name.git"
  },
  "keywords": ["your-keywords"],
  "author": "your-name <your-email>",
  "license": "MIT"
}

这里注意，name 必须是小写字母、数字和横线的组合。

编写代码

编写前端代码，在 package.json 文件的 main 属性所指定的文件中引用这些代码。

发布

当代码准备好后，就可以将其发布到 npm 上。

1. 到 npm 官网上登陆账号：https://www.npmjs.com/；
2. 打开命令终端或者 Git Bash 终端，进入你的项目根目录；
3. 构建项目，将代码打包成 npm 包：

npm pack

打包构建会在项目根目录下生成一个以项目名称和版本号命名的压缩文件。

1. 发布项目，执行以下命令:

npm publish

由于 npm 包发布的全局性，如果名称已经被占用，将无法发布。

使用你的 npm 包

发布完成以后，就可以在其它项目中使用你发布的 npm 包。使用 npm 命令安装即可：

npm install your-package-name

最后

本文介绍了如何使用 npm 包 pub，将前端代码发布到 npm 上供其他开发者使用。要发布的代码必须具有通用性和共享性，才能被称为有效的 npm 包。祝愿大家能够成功发布自己的 npm 包，加入这个大家庭。

Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/148834