发布npm包#

发布npm的包的好处是什么#

• 方便团队或者跨团队共享代码，使用npm包就可以方便的管理，并且还可以进行版本控制
• 做开源造轮子必备技术，否则你做完的轮子如何让别人使用难道是U盘拷贝？
• 增加个人IP 让更多的人知道你的技术能力和贡献

发布前准备工作#

1# 1.首先先检查一下是否是 npm源 然后创建一个npm账号
2npm adduser
3# 2.创建完成之后使用 npm login 登录账号
4npm login
5# 3.登录完成之后使用 npm publish 发布npm包
6npm publish

在前端开发中，将自己开发的包发布到 npm 上可以与更多开发者分享成果，同时也能提高开发效率。下面我们将详细介绍发布 npm 包的步骤。

准备账号#

首先去 npm 官网注册一个账号。注意在注册账号的时候，把邮箱也一并设置了，方便之后接收验证码。 账号注册完毕后，就可以在控制台通过 npm login 来进行登录。 还可以通过 npm profile 相关的指令来获取个人账号相关的信息。 如果要退出登录，可以通过 npm logout 指令。 注意事项：由于我们是要向 npm 官方推送包，所以需要将镜像修改为 npm 的镜像源。

配置 package.json#

设置忽略文件：当我们将包发布到 npm 上面的时候，意味着我们发布了哪些文件，最终用户下载安装的时候就会得到哪些文件。因此，我们在发布的时候就要尽量避免上传没有意义的文件，这里就涉及到设置忽略文件。

黑名单方式：在项目根目录下面创建一个 .npmignore 的文件，该文件用于设置哪些文件或者目录不需要上传到 npm。例如：

对于黑名单的方式，在新增了不需要发布的文件后，容易忘记修改 .npmignore 文件，因此我更加推荐使用白名单的方式。

白名单方式：所谓白名单，就是只有出现在名单里面的文件或目录才会被上传。在 package.json 文件里面有一个 files 字段，只有 files 字段里面出现的文件或目录才会被上传。例如：

设置模块类型：通过 type 值来设置模块类型。type 对应的有两个值：

• commonjs：当 type 的值设置为 commonjs 时，node.js 将默认使用 CommonJS 模块系统，这是 node.js 中最常见的模块系统。在这种情况下，可以直接使用 require 函数来导入模块。如果想使用 ECMAScript 模块（即使用 import 和 export 语法），则需要将文件扩展名设置为 .mjs。

• module：当 type 的值设置为 module 时，node.js 将默认使用 ECMAScript 模块系统。在这种情况下，可以直接使用 import 和 export 语法来导入和导出模块。如果你想使用 CommonJS 模块（即使用 require 导入模块），则需要将文件扩展名设置为 .cjs。

说白了现在的 node，你使用哪一种模块规范都无所谓，因为它两种都支持，你只需要通过 type 值来配置一下就可以了。

关于 type 这个配置项，不是 npm 所提供的配置选项，而是 node 提供的配置选项。

node 常见的配置项除了 type 以外，还有一个 exports，该配置项用于定义一个模块的导出映射，通过这个配置项，可以对模块的导入环境以及条件做一个更精细的控制，指定不同的模块的入口文件。例如：

我们在这里为不同的模块系统提供了不同的入口文件。如果使用的是 ESM，那么在导入模块的时候，node.js 会去加载 index.esm.js；如果使用的是 commonjs，那么在导入模块的时候，node.js 会去加载 index.cjs。

打包发布#

首先我们有如下的项目：

package.json 配置如下：

上面的重点配置：type、exports、files。还有一点一定要注意，rollup 打包工具一定要声明为开发依赖。

还有一些命令：

npm whoami：查看当前登录的用户。 npm publish：发布包（如果你是要向 npm 推送包，确定你镜像切换为了 npm 镜像）。