package.json属性解释

package.json 是一个文件,用于存储JavaScript项目的元数据,如项目名称,版本号,作者,依赖等。 常用属性有:

  • name:项目名称
  • version:版本号
  • description:项目描述
  • main:项目入口文件
  • scripts:脚本命令
  • keywords:关键字
  • author:作者
  • license:许可证
  • dependencies:项目依赖的包
  • devDependencies:开发依赖的包
  • repository:仓库信息

除了上述属性之外,还可以设置以下属性:

  • config: 用来存储项目的配置信息
  • homepage: 项目的主页地址
  • bugs: 项目的 bug 报告地址
  • files: 项目中要发布的文件列表
  • bin: 项目的可执行文件
  • man: 项目的 man 页面
  • directories: 项目的目录结构
  • peerDependencies: 当前项目作为库被其他项目依赖时,所需的其他依赖包。
  • optionalDependencies: 可选的依赖包。
  • engines: 项目运行所需的Node.js版本
  • os: 项目运行的操作系统
  • cpu: 项目运行所需的 CPU 架构
  • private: 是否将项目发布到 npm 上
  • publishConfig: 用于发布项目到 npm 的配置信息
  • workspaces:用于存储项目工作空间的相关配置
  • husky:用于配置项目的 git hooks
  • lint-staged:用于配置在 git 提交时运行的 lint 脚本
  • eslintConfig:用于配置 ESLint 的相关配置
  • babel:用于配置 Babel 的相关配置
  • prettier:用于配置 Prettier 的相关配置
  • jest:用于配置 Jest 的相关配置
  • webpack:用于配置 Webpack 的相关配置
  • browser: 用于指定浏览器兼容性
  • types: 用于指定包含项目的类型声明文件的目录
  • type: 用于指定包含项目类型声明文件的文件夹。 例如,如果项目中类型声明文件存储在 ./types 文件夹中,则可以在 package.json 中设置 "type": "./types"
  • typings 属性是用于指定包含项目类型声明文件的文件名。例如,如果项目中类型声明文件存储在项目根目录中,文件名为 index.d.ts ,则可以在package.json 中设置 "typings": "index.d.ts"
  • sideEffects: 用于指定包含副作用的文件或文件夹
  • publish: 用于配置发布的额外的配置信息
  • npmClient: 用于指定使用的npm客户端
  • scripts.prepare: 用于在发布之前预处理项目
  • scripts.prepublishOnly: 用于在发布之前运行的脚本
  • scripts.postpublish: 用于在发布之后运行的脚本
  • dependency-cruiser: 用于配置该工具的配置信息
  • greenkeeper: 用于配置 Greenkeeper 的配置信息
  • lint-style: 用于配置项目的代码规范
  • commitlint: 用于配置 commit 规范
  • conventional-changelog: 用于配置 conventional-changelog 的配置信息
  • npm-run-all: 用于配置 npm-run-all 的配置信息

除此之外还有一些属性是在不同项目中使用的,不能一一列举,可以根据项目需求进行设置。

你可能感兴趣的:(前端笔记本,javascript,前端)