npm依赖应该放在哪一个字段?

广告位招租
扫码页面底部二维码联系

在一个前端项目中,我们把依赖通过特有的p【关注微信公众号:wwwtangshuangnet】【本文首发于唐霜的博客】acakge.json,其中的depen【访问 www.tangshuang.net 获取更多精彩内容】【本文首发于唐霜的博客】dencies字段提供给npm来安装依赖著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】。自从npm升级之后,就增加了依赖的控制【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】,例如增加package-lock.js本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】on来锁定开发时使用的依赖版本。而我们的【原创不易,请尊重版权】【转载请注明来源】项目,很多会上到CI系统去构建,然后通过著作权归作者所有,禁止商业用途转载。【本文受版权保护】CD系统来部署到我们的生产环境中。这就会本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshuangnet】带来一个问题,我们在开发环境中使用的依赖【版权所有,侵权必究】【原创不易,请尊重版权】,应不应该在CI系统中安装,因为大部分C著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。I系统都不具备开发环境那么宽松的编译环境著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】。那么到底要怎么来安排我们的开发环境依赖【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】、CI环境依赖和生产环境依赖?

本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。【作者:唐霜】原创内容,盗版必究。

首先理解三种依赖:

【原创不易,请尊重版权】未经授权,禁止复制转载。

dependencies

未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】

本包的依赖。即当另外一个包/项目依赖你这著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】个包的时候,你的包必须依赖的其他包。np【原创不易,请尊重版权】【转载请注明来源】m在安装一个包的时候,它不单单只安装了这【版权所有,侵权必究】原创内容,盗版必究。个包本身,同时还安装了dependenc【版权所有】唐霜 www.tangshuang.net【转载请注明来源】ies里面指定的依赖。例如:

【未经授权禁止转载】未经授权,禁止复制转载。【作者:唐霜】【本文受版权保护】

npm i databaxe

著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。

你会发现,不单单databaxe这个包被【原创不易,请尊重版权】【未经授权禁止转载】安装了,databaxe这个包的pack【本文受版权保护】【转载请注明来源】age.json里面的dependenc转载请注明出处:www.tangshuang.net原创内容,盗版必究。ies字段里面的包也被安装了(devDe【版权所有,侵权必究】【本文首发于唐霜的博客】pendencies里面的包没有被安装,本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.netoptionalDependencies【本文首发于唐霜的博客】【作者:唐霜】 也会被安装,但是 optionalDe【转载请注明来源】转载请注明出处:www.tangshuang.netpendencies 有一点不同,如果里【未经授权禁止转载】【关注微信公众号:wwwtangshuangnet】面的包在安装过程中失败了,那么不会影响安【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。装过程,这个包因为安装失败而被忽略,具体【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】阅读这里)。

【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net

由于我们大部分前端项目,在现阶段还是需要本文作者:唐霜,转载请注明出处。【未经授权禁止转载】通过构建工具构建的,因此,对于一个完整的【原创内容,转载请注明出处】【版权所有,侵权必究】上线项目而言,dependecies里面【作者:唐霜】未经授权,禁止复制转载。只需要放置node端的modules即可转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。,例如express等服务器依赖包,而不【本文受版权保护】【关注微信公众号:wwwtangshuangnet】需要把jquery等前端代码需要的包放在转载请注明出处:www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】 dependencies 里面,因为,【作者:唐霜】【版权所有】唐霜 www.tangshuang.net前端代码的依赖包会被webpack等工具【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。打包进去。这些在构建阶段用到的包,可以放【作者:唐霜】【转载请注明来源】在 devDependencies 里面【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号:wwwtangshuangnet】

本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net【本文首发于唐霜的博客】

但是,对于一个组件,或者一个第三方前端包原创内容,盗版必究。未经授权,禁止复制转载。,你需要考虑的是,你的包被其他项目引用时本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。,会由其他项目去自己实现构建过程。你的代【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.net码里面的依赖可以和该项目其他依赖的依赖共著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net用,例如前面提到的jquery,有可能你转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】的包和别人的包都用到了,是一个公用的依赖【本文首发于唐霜的博客】本文作者:唐霜,转载请注明出处。,因此,你不应该把jquery的代码打包转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net到你自己发布的包代码中,而是作为依赖的形【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】式,添加到dependencies中去。本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net这样,当别人的项目在构建时,会同时使用你【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.net的包、别人的包、jquery去进行构建。本文作者:唐霜,转载请注明出处。原创内容,盗版必究。这样保证了代码的复用和代码量的减少。

【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】【转载请注明来源】

devDependencies

【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。【原创内容,转载请注明出处】未经授权,禁止复制转载。

本包的开发依赖。当你在开发一个包的时候,【本文首发于唐霜的博客】转载请注明出处:www.tangshuang.net你可能需要用到一些用于开发的依赖,例如w未经授权,禁止复制转载。【转载请注明来源】ebpack,babel等。这些依赖只会【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.net在开发构建阶段(也包括你上到CI系统进行原创内容,盗版必究。未经授权,禁止复制转载。构建时)用到,而不会在生产环境用到。np【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。m在安装一个包时,这个包pacakge.【作者:唐霜】【作者:唐霜】json里面的devDependenci原创内容,盗版必究。转载请注明出处:www.tangshuang.netes里面的包不会被同时安装。但你在把这个未经授权,禁止复制转载。【原创内容,转载请注明出处】包的源码克隆到本地,并准备开发时,你在项【本文受版权保护】原创内容,盗版必究。目目录下执行

【本文受版权保护】【关注微信公众号:wwwtangshuangnet】

npm i

【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net

你就会发现,这些包被安装了。而且,这些包【版权所有】唐霜 www.tangshuang.net【作者:唐霜】里面的package.json里面的规定著作权归作者所有,禁止商业用途转载。【本文受版权保护】,也完全和本文所讲的规则一致。也就是说,【访问 www.tangshuang.net 获取更多精彩内容】转载请注明出处:www.tangshuang.net虽然这些包是放在devDependenc【原创内容,转载请注明出处】原创内容,盗版必究。ies里面,但是,它们被安装时,它们自己【转载请注明来源】【版权所有,侵权必究】package.json里面的devDe【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.netpendencies里面的包不会被安装,【未经授权禁止转载】未经授权,禁止复制转载。因为,这些是它们自己的开发依赖。当它们被【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】安装时,是被当作一个正式的第三方产品来使【访问 www.tangshuang.net 获取更多精彩内容】【本文受版权保护】用。

【作者:唐霜】未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net

optionalDependencies

【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。

本包的可选依赖。当你在开发一个包的时候,【访问 www.tangshuang.net 获取更多精彩内容】【本文受版权保护】你可能希望有些包是可选的,比如,一个包由本文作者:唐霜,转载请注明出处。【版权所有,侵权必究】AB两位同学在开发。其中A开发时由于自己转载请注明出处:www.tangshuang.net【未经授权禁止转载】的习惯,使用到了一个包,但是B同学没有这【作者:唐霜】【转载请注明来源】个习惯,他不希望自己在开发时这个多余的包【访问 www.tangshuang.net 获取更多精彩内容】【作者:唐霜】被下载浪费时间,这个时候,这个包应该被放【作者:唐霜】【版权所有,侵权必究】在optionalDependencie转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】s里面。npm在安装一个包的时候,该包的原创内容,盗版必究。【原创内容,转载请注明出处】optionalDependencies转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net里面的依赖也不会被安装。但是,在开发时,【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。你执行

本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】【原创不易,请尊重版权】

npm i

转载请注明出处:www.tangshuang.net【未经授权禁止转载】

这些包还是会被安装。你可能会问,那它和d【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。evDependencies有啥区别?区【本文受版权保护】【原创内容,转载请注明出处】别在于,你可以使用参数让它们不被安装:

【原创不易,请尊重版权】【作者:唐霜】未经授权,禁止复制转载。

npm i –no-optional

【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】【原创内容,转载请注明出处】

通过这个参数,在执行npm i的时候,o【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。ptionalDependencies就【版权所有】唐霜 www.tangshuang.net【转载请注明来源】不会被安装了。

【本文受版权保护】本文作者:唐霜,转载请注明出处。

不同的开发环境如何正确选择一个包应该放在【作者:唐霜】著作权归作者所有,禁止商业用途转载。哪里?

【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net
  • 但凡用于构建的、测试的、质量检查的,都放本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。到devDependencies里面
  • 著作权归作者所有,禁止商业用途转载。【转载请注明来源】
  • 但凡仅用于本地开发,例如预览等,都放到o本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。ptionalDependencies里本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】
  • 原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。

例如,我们经常会在本地开发时,起一个de【本文受版权保护】【作者:唐霜】vserver来对开发结果进行预览,但是【作者:唐霜】未经授权,禁止复制转载。在上到CI系统时,这个功能根本不会用到,【本文受版权保护】【本文首发于唐霜的博客】所以,我们把这些依赖放到optional【作者:唐霜】【原创内容,转载请注明出处】Dependencies里面,而在CI系【版权所有,侵权必究】【原创内容,转载请注明出处】统构建脚本中,一定要加上–no-optional参数。

【作者:唐霜】原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。

所以,最终总结下来,我们大致可以这么认为【本文首发于唐霜的博客】转载请注明出处:www.tangshuang.net:dependencies是给生产环境用【版权所有,侵权必究】【原创不易,请尊重版权】的,devDependencies是给C【转载请注明来源】原创内容,盗版必究。I构建用的,optionalDepend未经授权,禁止复制转载。【转载请注明来源】encies是给本地开发用的。虽然这个理转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。解有偏差,但对于对这个知识点刚刚了解的同【未经授权禁止转载】原创内容,盗版必究。学来说,非常有用。

【本文首发于唐霜的博客】【本文受版权保护】转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。