package参数说明

package.json参数说明
name
包名
version
版本号
description
包描述
dependencies
npm install 包名,安装包时,会安装该包下package.json文件中dependencies下申明的包
keywords
关键字
homepage
项目的官网主页地址。
repository
项目仓库信息
license
项目的协议信息
author
作者信息
contributors
协作者信息
files
声明有哪些文件,是需要作为依赖项,保留下来。
不然,执行npm publish进行发布时,这些文件是会自动屏蔽上传的。
同理,也可以使用.npmignore文件进行配置。
main
使用npm包时,需要进行require(…)的操作。这个操作,会查看main字段,找到程序的主入口。
bin
工具性质的npm包,一定有bin字段,对外暴露脚本命令。
publishConfig
用于定义发布npm时,设置相关信息
unpkg
CDN方式下,引入当前npm包的链接。
module
性质等同于main字段。module用于ES6规范的模块,只要支持ES6,会优先使用module入口。
这样,代码也可以启用tree shaking机制。
types
项目如果是用TypeScript写的,则需要types字段,对外暴露相关的类型定义。
sideEffects
sideEffects格式:boolean | string[]。
sideEffects: false用于告知打包工具(webpack),当前项目无副作用,可以使用tree shaking优化。
sideEffects的值,也可以是一个文件路径组成的数组。告知哪些文件无副作用,可以使用tree shaking优化。
workspaces
monorepo类型的项目,需要用到workspaces。它可以告知其他工具,当前项目的工作区间在哪里。
bugs
开源项目用于接收bug反馈。
devDependencies
生产环境不需要使用的依赖,都需要安装在devDependencies下。
peerDependencies
当开发一些插件和工具包时,对使用方的运行环境的依赖包版本有要求,可以使用peerDependencies字段进行声明

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值