别再搞混了!package.json中dependencies和devDependencies的5个实际应用场景

package.json 中的 dependencies 和 devDependencies:如何正确区分与应用 本文详细解析了package.json中dependencies和devDependencies的区别与应用场景,帮助开发者正确分类依赖包。通过实际案例和黄金法则,指导如何避免常见错误,提升项目性能和安全性,同时分享高级场景下的特殊处理方法和工具链最佳实践。 阅读详情

别再搞混了!package.json中dependencies和devDependencies的5个实际应用场景

每次接手一个新项目,或者准备把代码部署上线时,你是不是也对着 package.json 里那一长串依赖项感到一丝困惑?哪些是运行时必需的,哪些只是开发工具?这个问题看似基础,却实实在在地影响着项目的构建、部署和团队协作。很多开发者凭感觉或习惯来划分依赖,结果往往导致本地运行一切正常,一到CI/CD流水线就构建失败,或者生产环境的包体积莫名臃肿。今天,我们不谈枯燥的定义,而是深入到五个真实且容易踩坑的场景里,帮你彻底厘清这两者的边界,让你的项目依赖管理既清晰又高效。

1. 环境隔离:从本地开发到CI/CD流水线

依赖管理的首要原则是环境隔离。dependencies 和 devDependencies 最直观的区别,就在于它们所服务的环境不同。但“环境”这个词太宽泛了,我们需要把它拆解到具体的操作环节中。

想象一下典型的开发流程:你在本地编写代码,会用到代码格式化工具(如Prettier)、测试框架(如Jest)、打包工具(如Webpack)。这些工具帮助你产出最终要运行的代码,但它们本身并不会出现在线上服务器。这就是 devDependencies 的典型成员。

而你的应用代码,比如一个Express服务器,它需要 express 这个包才能处理HTTP请求。无论在生产环境还是测试环境,这个能力都是必需的。因此,express 必须放在 dependencies 中。

为什么严格区分如此重要? 核心在于 npm install 命令的 --production 标志。当你在服务器或CI/CD环境中执行 npm install --production 时,NPM只会安装 dependencies 下列出的包,完全跳过 devDependencies。这带来了几个关键好处:

  • 更快的部署速度:无需下载和安装庞大的开发工具链,显著缩短部署时间。
  • 更小的生产镜像体积:Docker镜像、服务器目录会更精简,安全性也更高(减少了潜在的攻击面)。
  • 避免环境冲突:有些开发工具(如特定版本的TypeScript编译器)可能与生产环境的Node版本不兼容,不安装它们就避免了这类问题。

一个常见的反例是把 webpack 放入了 dependencies。这会导致生产环境也安装了这个可能超过100MB的构建工具,但它除了占用空间外毫无用处。

提示:你可以通过 npm list --production 快速查看在生产模式下会安装哪些包,这是一个很好的自查习惯。

2. 构建工具链:谁该为最终产物负责?

现代前端开发离不开复杂的构建工具链。Babel转译、TypeScript编译、SCSS预处理、代码打包和压缩……这些工具在开发阶段至关重要,但它们的工作在代码部署前就已经完成了。

关键判断标准是:这个包是否会被打包进最终的发布产物(bundle)中?

  • 属于 devDependencies:所有处理源代码的工具。

    • 编译器/转译器:@babel/core, typescript
    • 打包器:webpack, vite, rollup
    • 代码处理器:sass, postcss
    • 代码质量工具:eslint, prettier 这些工具就像工厂里的机床和模具,产品出厂后,机床本身并不会跟着产品一起发货。
  • 属于 dependencies:所有成为最终产物一部分的库。

    • 框架/库运行时:react, vue, lodash
    • 样式库:bootstrap, antd (虽然它们可能被构建工具处理,但其CSS/JS代码需要被引入最终bundle)
    • Polyfill:core-js (如果通过import方式引入) 这些是构成产品本身的“原材料”或“零部件”。

让我们看一个Vue项目的典型依赖划分示例:

{
  "name": "my-vue-app",
  "dependencies": {
    "vue": "^3.3.0",
    "vue-router": "^4.2.0",
    "pinia": "^2.1.0",
    "axios": "^1.5.0"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^4.4.0",
    "typescript": "^5.2.0",
    "vite": "^4.5.0",
    "eslint": "^8.50.0",
    "@types/node": "^20.8.0"
  }
}

这里,vue 等是应用运行的核心,而 vite、typescript 只是构建阶段的助手。混淆它们,尤其是在配置Dockerfile时,会导致构建阶段缺失关键工具,或者运行阶段镜像臃肿。

3. 测试与质量保障:何时需要,何时不需要?

测试是保证代码质量的核心环节,但测试代码和测试框架本身的生命周期与业务代码截然不同。

  • 测试框架与断言库:jest, mocha, chai, @testing-library/react。这些是编写和运行测试的工具,它们只在开发或CI环境中使用,以验证 dependencies 中的业务代码是否正确。因此,它们毫无争议地属于 devDependencies。

  • 测试工具/模拟库:sinon (用于创建spy、stub), nock (模拟HTTP请求), jsdom (在Node中模拟浏览器环境)。同理,它们也是开发阶段的辅助工具。

  • 一个需要仔细斟酌的灰色地带:端到端(E2E)测试工具,如 cypress 或 puppeteer。它们的情况更复杂一些:

    • 如果你的E2E测试是开发流程的一部分(例如在 npm run test:e2e 中运行),用于在合并代码前验证功能,那么它们应放在 devDependencies。
    • 但在某些监控或生产环境健康检查的场景下,可能会有专门的、独立于应用的服务来运行E2E测试。这种情况下,运行这些测试的服务需要将 cypress 作为其自身的 dependencies,但这已经属于另一个独立项目了。

核心原则:测试是为了验证生产代码,而不是生产代码的一部分。 将测试相关依赖误放入 dependencies,是新手常犯的错误,这会让你的生产镜像平白无故多出几百MB的内容。

4. 微服务与Monorepo架构下的依赖隔离

在单体应用中,依赖划分相对简单。但当项目演进为微服务或采用Monorepo(如使用 pnpm workspaces, Lerna, Turborepo)管理多个包时,依赖管理就变成了一个需要精心设计的架构问题。

场景:共享工具包的依赖类型 假设你有一个Monorepo,包含一个共享的 @my-company/eslint-config 配置包,和一个业务应用包 app。

  • 在 @my-company/eslint-config 的 package.json 中,eslint 及其插件是它运行所必需的(没有它们,这个配置包无法工作)。因此,eslint 应该被列为这个工具包的 dependencies。
  • 在业务应用 app 中,你通过 npm install @my-company/eslint-config 引入这个共享配置。此时,app 只需要在开发时使用这个配置来检查代码,所以 @my-company/eslint-config 应该被列为 app 的 devDependencies。

微服务间的公共库 如果多个微服务都使用一个内部的 @my-company/utils 工具库,这个工具库提供了通用的数据处理函数。那么在每个微服务的 package.json 中,@my-company/utils 都必须是 dependencies,因为服务在运行时需要调用这些函数。

下表对比了不同场景下共享包的依赖归属:

共享包类型在共享包自身的 package.json 中在消费该包的业务项目的 package.json 中
构建/代码质量工具 (如自定义Webpack插件、ESLint配置)其依赖的底层工具(如webpack、eslint)应列为 dependencies该共享工具包本身应列为 devDependencies
公共业务工具库 (如工具函数、常量定义)其依赖的第三方库(如lodash)应列为 dependencies该工具库本身应列为 dependencies
TypeScript类型定义包 (@types/xxx)-几乎总是列为 devDependencies

这种清晰的划分,确保了在构建单个服务或应用时,只会安装它真正需要的运行时依赖,保持了各服务的轻量化和独立性。

5. 类型定义、文档生成与“仅类型”依赖

JavaScript生态中还有一些特殊的包,它们的存在形式比较微妙,常常引发困惑。

TypeScript类型定义 (@types/*) 对于像 lodash 这样的纯JavaScript库,为了获得TypeScript的类型提示,我们需要安装 @types/lodash。这个包只包含 .d.ts 类型声明文件,在代码被编译成JavaScript后,它们就完成了使命。因此,绝大多数 @types/* 包都应该放在 devDependencies 中。唯一的例外是,当你发布一个库,并且这个库的类型定义是其公共API的一部分时,才需要将 @types 依赖放入 dependencies(或者更好的方式是使用TypeScript的 declaration: true 选项将类型直接打包进你的库)。

文档生成工具 jsdoc, vuepress, docusaurus 这类工具用于从代码注释生成静态文档网站。文档站点本身是一个独立的产物,通常有独立的构建和部署流程。因此,在你的源代码项目中,这些工具应该列为 devDependencies。你可能会有一个 docs 文件夹或一个独立的文档仓库,在那里运行 npm run docs:build。

“Peer Dependencies” 的邻居:那些你“只需要它存在”的包 这是一种更高级但真实存在的场景。假设你开发一个Webpack插件 my-webpack-plugin,这个插件需要用到 webpack 的某些API。你会把 webpack 放在哪里?

  • 放在 dependencies?不行,这会强制安装特定版本的webpack,可能与使用你插件的主项目版本冲突。
  • 放在 devDependencies?也不行,因为用户安装你的插件时,如果他们的环境没有webpack,插件根本无法运行。
  • 正确答案是使用 peerDependencies。你通过 peerDependencies 声明:“我的插件需要webpack,但请使用项目本身的webpack版本”。同时,为了让你自己能开发和测试这个插件,你需要在本地的 devDependencies 里安装一个webpack实例。
// my-webpack-plugin 的 package.json
{
  "name": "my-webpack-plugin",
  "peerDependencies": {
    "webpack": "^5.0.0"
  },
  "devDependencies": {
    "webpack": "^5.80.0" // 用于本地开发和测试
  }
}

理解这些特殊案例,能帮助你在更复杂的生态位中做出精准的依赖管理决策,避免给协作者带来不必要的版本冲突或环境问题。

依赖管理是项目工程化的基石。区分 dependencies 和 devDependencies 远不止是遵循规范,它直接关系到构建的确定性、部署的效率和团队协作的顺畅度。下次你执行 npm install 时,不妨多花几秒钟思考一下这个包的真实身份,这个微小的习惯,能为你后续的开发扫清很多障碍。

npm与Yarn命令速查表:Windows报错、锁文件、PnP与工程选型指南 包管理器是现代前端工程的基石,npm和Yarn作为主流JavaScript包管理工具,其命令语法、执行逻辑与安全策略存在系统性差异。理解PowerShell执行策略如何拦截npm.ps1脚本、package-lock.json与yarn.lock的生成机制差异、以及Yarn PnP对node_modules的范式重构,是解决‘命令不生效’‘依赖不一致’‘CI构建不可重现’等高频问题的关键。本文聚焦开发者真实工作流——从Windows环境初始化、命令意图映射、锁文件治理,到Monorepo与合规场景下的技术选 阅读详情

相关推荐

从“手扫感应灯”拆解开始:聊聊三极管放大电路在生活中的那些实用设计

本文通过拆解手扫感应灯,深入探讨了三极管放大电路在日常生活中的实用设计。从红外信号放大到环境干扰应对,详细解析了电路配置技巧和调试方法,并延伸至声控灯、电容感应等智能家居应用,帮助读者理解并掌握三极管放大电路的核心原理与实践技巧。

weixin_42627853的博客 391

package.json 里的 dependencies和devDependencies区别

dependencies(依赖的意思):通过 --save 安装,是需要发布到生产环境的。比如项目中使用react,那么没有这个包的依赖就会报错,因此把依赖写入dependenciesdevDependencies(dev -- develop(开发)的简写):通过--save-dev安装, 里面的插件只用于开发环境,不用于生产环境。开发环境中使用的插件如webpack,chai等,上线后就用不到了,写入devDependencies。

原在路上的博客。 1460

在 Windows 10 中通过 WSL2 安装 vLLM 部署本地大模型的方法和步骤

通过 WSL2 在 Windows 10 中部署 vLLM 的核心优势是兼顾 Windows 生态与 Linux 环境的 GPU 加速能力,适合需要在 Windows 下开发但依赖 vLLM 高性能推理的场景。相比原生 Windows 部署(Ollama 等工具),该方案性能更优(接近原生 Ubuntu),且支持更大模型和量化优化。若追求极致性能,建议直接使用 Ubuntu 系统;若必须依赖 Windows 工具链,WSL2 + vLLM 是当前最优选择。

当 AI 开始写文章、绘星空,甚至预测未来,您还在旁观吗?这里将剖开人工智能的思考逻辑,拆解 AI 创作的底层密码,也聊聊人工智能里的人文温度。每篇都有让你拍案的细节,快来解锁 AI 时代的神奇世界! 3756

package.json文件中dependencies和devDependencies的区别

2、dependencies 是项目正常运行所需要的依赖,而devDependencies则是开发者开发时整个项目所需的依赖(如会有一些测试依赖之类的)。1、dependencies 是发布到生产环境的,而 devDependencies 里面的插件只用于开发环境,不用于生产环境。1、使用 --save-dev 安装的插件,会被写入到 devDependencies 对象里面去;2、使用 --save 安装的插件,会被写入到 dependencies 对象里面去。

王声声的博客 3204

【ART-Pi与RT-Thread入门】①ART-Pi上手初体验

文章目录关于ART-Pi实物照片板载资源、扩展接口及驱动支持扩展引脚默认固件蓝牙配网微信扫描二维码设备选择 ART-Pi,输入所要连接的 WIFI SSID 和密码配网成功会显示IP地址打开IP地址Finsh控制台配网WindowsmacOS 关于ART-Pi ART-Pi是 RT-Thread 团队为嵌入式软件工程师、开源创客设计的一款极具扩展功能的 DIY 开源硬件。致力打造一个开源的软硬件平台。 实物照片 板载资源、扩展接口及驱动支持 扩展引脚 其中P1排扩展引脚座兼容树莓派的扩展接口,并

SimonLiu的博客 5831

SA8155 QNX显示框架与WFD配置实战:从黑屏排查到高可用设计

智能座舱中,车载显示系统的稳定性直接关系到驾驶安全。QNX作为高安全性的操作系统,在座舱仪表、ADAS等关键域中承担着确定性调度与隔离职责,其图形体系Screen与显示输出框架WFD协同工作,构成从应用渲染到面板点亮的完整链路。WFD配置涉及时序、通道映射与行为控制,任何参数偏差或加载异常都可能导致黑屏、花屏等故障。为保障系统可用性,需结合心跳监控、日志采集、通路重试与备份显示切换等策略,构建兼具快速感知与恢复能力的防御体系。本文以SA8155平台为例,深入拆解QNX显示框架的架构与WFD配置要点,结合一次

weixin_29165465的博客 207

package.json中的dependencies(生产依赖)和devDependencies(开发依赖)

一、前言 项目开发过程中,难免会遇到需要npm install XXX的时候,这就又涉及安装的这个依赖模块是放到package.json中的dependencies或者是devDependencies中的问题,来区别一下吧。 二、安装依赖 1、npm install和npm uninstall 下面以安装axios为例: 在你才开始接触开发的时候,或许你也为npm install axios/npm uninstall axios、npm install axios -save/npm uninstall

BigFamer的博客 1万+

京东技术产品经理面试全记录:从简历投递到一面45分钟实战复盘

本文深度复盘京东技术产品经理面试全流程,从策略准备、思维题拆解、项目阐述到反问谈判,提供了一套可演练的求职策略体系。文章强调该岗位需具备横跨技术与商业的枢纽能力,并通过“QQ分组vs微信标签”等案例,剖析了产品思维与结构化表达在面试中的关键作用,助力候选人将紧张转化为掌控感。

weixin_29275257的博客 631

npm安装插件及package.json文件中dependencies和devDependencies的区别

这个时候,如果X框架是作为全局安装的话,那么文件中只有一个版本,必定不能同时满足两个项目的需求。所以本地安装是很有必要的。2、dependencies 是项目正常运行所需要的依赖,而devDependencies则是开发者开发时整个项目所需的依赖(如会有一些测试依赖之类的)。1、dependencies 是发布到生产环境的,而 devDependencies 里面的插件只用于开发环境,不用于生产环境。本地安装的重要性:本地安装最最关键的就是解决了不同项目对不同包的版本依赖问题。

MISS_zhang_0110的博客 5823

华为OD机试真题 新系统 - WIFI设备网络规划 (Java/Py/C/C++/Js/Go)

本文整理华为 OD 机试新系统机考真题库,涵盖高频考点精析与完整题目内容,提供 C 语言、Java、C++、Python、Go、JavaScript 多语言源码实现,搭配详细解题思路讲解,并支持在线 OJ 刷题练习,助力高效备考华为 OD 机试新系统。

算法大师! 2020

ASPICE学习笔记

ASPICE的全称是Automotive SPICE。

汽车电子软件领域知识分享 1356

package.json之devDependencies和 dependencies的详解

无论前端、Node做项目的时候经常会用package.json来管理本地安装的npm包,可是安装之后的包在哪里呢?为什么有时候安装要npm i XXX --save,有的是npm i XXX --save-dev?是不是很困惑?打开package.json会看见这两个如下: "dependencies": { "rxjs": "5.5.10", }, "devDepend...

简单Cere 4298

滑模控制算法(SMC)讲解-案例(附C代码)

该文章介绍了滑模控制算法的原理实现步骤,特点及关键问题,最后以车辆控制案例来讲解滑模控制的整个步骤实现

heda3的博客 4112

package.json 里面的 dependencies 和 devDependencies 的差异

其实不严格的话,没有特别的差异;若是严格,遵循官方的理解。

When you can't win by being better, you can win by being different. 1045

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

文档:亲测可用解决vnc灰屏,黑屏,鼠标大黑叉情况

主要解决vnc-viewer灰屏,黑屏,鼠标大黑叉等现象,详细见文档。

dependencies和devDependencies详解、区别

在Node.js项目中,`dependencies`和`devDependencies`字段用于`package.json`文件中,以便管理项目的所有依赖关系。下面是它们的详细解释、区别以及如何在代码中使用它们的示例。

大剑师兰特的GIS世界 6712

visio安装包

Microsoft Office Visio 是一款专业的制图软件。利用经过更新的形状、协作工具和数据链接图表,创建专业级图表以简化复杂的信息。

package.json中dependencies和devDependencies的区别

package.json中dependencies和devDependencies的区别是什么 解答: 1、dependencies:应用能够正常运行所依赖的包,是生成环境需要的。 2、devDependencies:开发环境所依赖的工具包。通常是一些开发、测试工具包,例如 webpack、eslint。 3、当执行命令 npm install 没有任何参数时,会安装package.js...

m0_37684037的博客 362

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

透彻演示 dependencies 和 devDependencies 区别

dependencies 与 devDependencies 最主要的区别是,作为依赖包时,能否被递归安装依赖

wlym123的专栏 3580

浅析package.json中的devdependencies 和 dependencies

1、dependencies和devDependencies 具体代码如下 “name”: “webpack-react-express”, “version”: “0.2.0”, “private”: true, “dependencies”: { “antd”: “^2.13.11”, “babel-polyfill”: “^6.26.0”, “base-64”: “^0.1.0”, “bluebird”: “^3.5.1”, “css-loader”: “^0.28.7”, “echarts

T748588330的博客 927

Node.js项目关于package.json的dependencies和devDependencies

Node.js项目关于package.json的dependencies和devDependencies

ikkkp的博客 917

package.json 里 dependencies和devDependencies的区别

package.json 里 dependencies和devDependencies的区别

u014212540的博客 1428

dependencies 和 devDependencies 的区别,安装包的时候,怎么做判断

在 Vue 项目中,正确管理依赖是保持项目结构清晰和提高构建效率的关键。本文将通过一个常见问题 —— 错误地将 sass 放在 dependencies 而非 devDependencies —— 来探讨如何优化依赖管理,并提供简单有效的解决方案。

无言非影的博客 1783

深入理解 package.json 中的依赖类型

在前端项目中,`package.json` 是项目依赖管理的核心文件,其中不同类型的依赖字段在开发、构建、部署等阶段扮演着不同角色。很多初学者甚至部分有经验的开发者,也容易混淆它们的区别与用法。本文将详细介绍 `dependencies`、`devDependencies`、`peerDependencies` 等常见依赖类型,并给出适用场景。

常备不懈 1528

vue-package.json中的dependencies(生产依赖)和devDependencies(开发依赖)

以下所有安装命令都会对node_modules生效,即安装都会安装到node_modules中,删除也会中从node_modules中删除。2、会添加到package.json的dependencies中 ,build时会打进去,3、会添加到package.json的devDependencies中。1、不会添加到package.json中。

startyangu的博客 1388
上一篇: ZIP密码破解工具横评:ARCHPR/fcrackzip/John the Ripper实战对比
下一篇: 从MobileViT到EdgeNeXt:轻量级视觉模型的进化之路与SDTA技术解析
devops8pract
博客等级 码龄4年 533粉丝 849原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值