尊敬的客户,您好!我们是北京一家专注互联网技术服务公司,可以提供收录效果好,文章排名好的网站进行发文,发得多,各种关键词排名就多,流量越多越稳定,如果您有需要欢迎您前来资讯!可以随意添加图文和视频广告,助您的企业或者项目服务实现推广效果!如需合作欢迎请加微信
前端模块化是前端必备的技能,已经成为前端开发中不可或缺的一部分。模块化导致项目规模不断扩大,项目依赖也越来越多,随着项目的增多,手动复制每个模块无异于饮鸩止渴。我们可以将功能相似的模块或组件提取成一个 npm 包;然后上传到私有 npm 服务器,不断迭代这个 npm 包,更新和管理所有项目的依赖。
对 npm 包的基本了解
首先,我们来看看实现 npm 包需要什么。
盒
通常我们会把一些打包好的模块文件放在一个目录下,统一加载;没错,npm 包也需要打包,虽然我们可以直接写 npm 包模块的代码(不推荐),但是我们在项目中经常会用到诸如、、、代码压缩等功能,所以在发布 npm 包之前,也需要对它进行打包。
在对、、和打包工具进行深入的比较之后,我们得出结论,相比于,它更适合打包一些第三方类库,因此本文主要使用它来进行打包。
npm 域级别包
随着 npm 包数量的增加,包名必须具有唯一性,如果名字被别人占用了,就不能再用了。假设我要开发一个包,但是张三已经发布了一个包,我就不能用同样的名字来命名我的包。这时候我们可以加一些连接符或者其他字符来区分,但是这样会使包名不可读。
在 npm 包管理系统中,有一种机制将一些 npm 包以 @/ 的形式集中在一个命名空间中,实现领域级别的包管理。
领域级包不仅不用担心和其他人的包名重复,还可以将功能相似的包进行统一划分和管理;例如我们使用 Vue 脚手架搭建的项目包含@vue/cli--、@vue/cli-- 等领域级包。
我们可以在初始化项目的时候使用命令行添加:
npm init --scope=username
同一范围内的包将安装在同一个文件路径中,例如 /@/,该路径可以包含任意数量的范围内的包。要安装域级包,您还需要指定其范围:
npm install @username/package
在代码中导入时也需要范围:
require("@username/package")
加载规则
在 npm 包的 .json 文件中,我们经常会看到 main、:main 等字段,这些字段代表什么意思呢?其实这跟 npm 包的工作环境有关。我们知道,npm 包分为以下几种类型的包:
如果我们现在开发一个npm包,需要同时支持浏览器端和服务器端(比如,等),并且需要在不同的环境下加载npm包的不同入口文件,只有一个字段已经不能满足需求了。

首先我们来看 main 字段,它是默认的文件入口,支持范围最广,主要在引用依赖包的时候用到,需要这个属性的支持。如果不使用 main 字段,我们可能需要这样引用依赖:
import('some-module/dist/bundle.js')
所以它的作用就是告诉打包工具哪个是npm包的入口文件,打包的时候让打包工具导入哪个文件;这里的文件一般都是(cjs)模块化的。
有一些打包工具,比如 or,可以直接处理导入的 esm 模块。然后我们可以将模块文件打包成 esm 模块,然后指定字段;如何引用它们则由包的用户决定。
:main 和 含义相同,都可以指定 esm 模块的文件;不过 :main 是社区约定的字段,而非官方约定的字段,而 :main 是官方约定的字段,所以我们经常会同时使用这两个字段。
正如我们在配置完整解析中介绍的那样,它用于解析模块。默认情况下,它会按顺序解析、、和 main 字段。
有时候我们也想写一个既能在浏览器上运行,又能在服务器上运行的 npm 包(举个例子),但这两者的运行环境还是有细微差别的。比如浏览器使用 来请求数据,而服务器使用 http 或者;那么我们该如何区分不同的环境呢?
除了在代码中判断环境参数(比如判断是否是)外,我们还可以使用来替换浏览器环境中的main字段,用法有两种,如果是单个字符串,则将main替换为浏览器环境的入口文件,一般是umd模块:
{ "browser": "./dist/bundle.umd.js" }
也可以是一个对象,用来声明需要替换或忽略的文件;这种形式更适合替换一些文件而不创建新的条目。key 是需要替换的文件名,右边是需要替换的新文件。例如,在 .json 中使用了这个替换:
{ "browser": { "./lib/adapters/http.js": "./lib/adapters/xhr.js" } }
当打包到浏览器环境的时候,打包工具会把./lib//http.js引入的文件内容替换为./lib//xhr.js的内容。
在某些包中,我们还会看到指向 /.d.ts 文件的字段。该字段用于包含此 npm 包的变量和函数的类型信息。例如,我们在使用 -es 包时,有一些函数名我们记不住,只记得大概的名字。例如输入 fi 可以自动联想到编译器中的 fill 或其他函数名,这为包使用者提供了极大的便利,他们不用查看包的内容就能了解导出的参数名称,为用户提供了更好的 IDE 支持。
要发布哪些文件
在npm包中,我们可以选择将哪些文件发布到服务器,比如只发布压缩代码、过滤源代码等;我们都可以通过配置文件来指定,具体又分为以下几种情况:
相当于黑名单,字段是白名单,那么当两个内容发生冲突的时候,哪个优先呢?答案是优先,而且是最高优先级的。
我们可以使用npm pack命令进行本地模拟打包测试,会在项目根目录下生成一个tgz压缩包,里面就是要上传的文件内容。
项目依赖关系

在 .json 文件中,所有依赖包都在 和 字段中进行配置和管理:
字段指定了项目上线后运行所依赖的模块,可以理解为我们的项目在生产环境需要用到的;比如vue等等,这些都是项目上线后需要用到的依赖。
字段指定了项目开发需要的模块,以及开发环境中会用到的东西;比如等等。我们在打包的时候会用到,但是项目上线的时候用不到,所以就放进去吧。
除了和字段之外,我们还会在部分 npm 包中看到字段,没有写过 npm 插件的朋友可能对这个字段比较陌生,它和上面两个依赖有什么区别呢?
假设我们的项目有一个依赖项,并且它的.json指定了这个依赖项,所以我们的项目结构是这样的:
MyProject |- node_modules |- PackageA |- node_modules |- PackageB
然后我们可以直接在 中引用该依赖,但是如果想直接使用,抱歉,这是不可能的;即使已经安装了,node 也只会在 / 目录中寻找。
为了解决这个问题,引入了 。通俗的解释就是:如果你安装了我,你最好也安装下面的依赖。例如,我们在上面的 .json 中添加如下代码:
{ "peerDependencies": { "PackageB": "1.0.0" } }
如果你安装它,它会自动安装并形成以下目录结构:
MyProject |- node_modules |- PackageA |- PackageB
我们可以在我们的项目中愉快地使用这两个依赖项。
比如我们熟悉的 vue3 组件库就无法单独运行,必须依赖 vue3 环境才能运行;因此在它的 .json 中我们看到了它对宿主环境的要求:
{ "peerDependencies": { "vue": "^3.2.0" }, }
这样我们就可以看出组件中引入的vue依赖其实都是宿主环境提供的vue3依赖:
import { ref, watch, nextTick } from 'vue'
执照
许可证字段允许我们定义适用于 .json 文件描述的代码的许可证。同样,这在将项目发布到 npm 注册表时非常重要,因为许可证可能会限制某些开发人员或组织对该软件的使用。拥有明确的许可证有助于明确定义可以使用该软件的条款。

我先用一张知乎上Max Law的图来解释一下所有的许可证:
版本号
npm 包的版本号也有标准要求,一般的都是遵循语义化版本规范,版本格式为:..,各个字母含义如下:
主版本号 (): 当您进行不兼容的 API 更改时 次版本号 (): 当您添加向后兼容的功能时 补丁版本号 (): 当您进行向后兼容的错误修复时
提前版本号是添加到修订号中作为版本号的扩展;当需要发布主要版本或核心功能,但不能保证该版本完全正常时,必须先发布提前版本。
预发布版本号的格式是在修订号后添加一个连字符(-),后面跟着一系列用点(.)分隔的标识符,标识符可以由英文字母、数字和连字符([0-9A-Za-z-])组成。例如:
1.0.0-alpha 1.0.0-alpha.1 1.0.0-0.3.7
常见的先前版本号有:
:不稳定版本,一般来说,此版本bug较多,需要修改,为测试版本。 Beta:基本稳定,与正式版相比,有很大进步,消除了严重错误。 RC:与正式版基本一致,基本不会出现错误。 最终版本
每个npm包的版本号都是唯一的,我们每次更新npm包的时候都需要更新版本号,否则会报错提醒:
当主版本号升级时,需要将次版本号和修订号重置为0。当次版本号升级时,需要将修订号重置为0。
但如果每次都要手动更新版本号的话,就太麻烦了;有没有可以自动更新版本号的命令行呢?由于版本号的确定取决于根据内容决定的主观行为,所以不可能完全自动化更新,谁知道你改的是大版本还是小版本呢?所以只能通过命令行半自动化;命令值对应语义版本,对应版本就会加1:
在 .json 中某些依赖项的版本号中,我们还会看到 ^、~ 或 >= 等标识符,或者没有标识符。这些是什么意思?
无符号:100%匹配,必须使用当前版本号来比较符号:>(大于)>=(大于等于)