项目中packge.json 配置文件详细

通常我们使用npm init命令来创建一个npm程序时,会自动生成一个package.json文件。package.json文件会描述这个NPM包的所有相关信息,包括作者、简介、包依赖、构建等信息,格式是严格的JSON格式。

package.json 文件配置说明 官网

  1. name:必需,名称,长度必须小于等于214个字符,不能以"."(点)或者"_"(下划线)开头,不能包含大写字母。
  2. version:必需,版本。X.Y.Z → [major, minor, patch] → [主版,次版,补丁版]如:1.2.3
  3. description:项目描述,是一个字符串。有助于人们在使用npm search时找到这个包。
  4. keywords:项目关键字,是一个字符串数组。有助于人们在使用npm search时找到这个包。
  5. homepage:项目主页的 url
  6. bugs:bug 提交地址。
  7. license:软件许可证,让用户知道他们的使用权利和限制。
  8. author:项目开发者。
  9. contributors:项目贡献者 。
  10. files:被项目包含的文件名数组。
  11. main:项目默认执行文件,比如 require(‘webpack’);就会默认加载 lib 目录下的 webpack.js 文件,如果没有设置,则默认加载项目跟目录下的 index.js 文件。
  12. bin:内部命令对应的可执行文件的路径。
  13. man:为系统的man命令提供帮助文档。帮助文件的文件名必须以数字结尾,如果是压缩的,需要以.gz结尾。
  14. directories:CommonJS包所要求的目录结构信息,展示项目的目录结构信息。字段可以是:lib, bin, man, doc, example。值都是字符串。
  15. repository:项目仓库地址。
  16. scripts:通过设置这个可以使NPM调用一些命令脚本,封装一些功能。
  17. config:添加一些设置,可以供scripts读取用,同时这里的值也会被添加到系统的环境变量中。
  18. dependencies:生产环境下,项目运行所需依赖的包。使用下面的命令来安装:npm install --save packageName。
  19. devDependencies:只有在开发环境下才需要的依赖包。使用下面的命令来安装:npm install --save-dev packageName。
  20. peerDependencies:相关的依赖,如果你的包是插件,而用户在使用你的包时候,通常也会需要这些依赖(插件),那么可以将依赖列到这里。
  21. bundledDependencies绑定的依赖包,发布的时候这些绑定包也会被一同发布。
  22. optionalDependencies:即使这些依赖没有,也可以正常安装使用。
  23. engines:指定包运行的环境。
  24. os:指定你的包可以在哪些系统平台下运行。
  25. cpu:可以指定包运行的cpu架构。
  26. private:设为true这个包将不会发布到NPM平台下。
  27. publishConfig:这个字段用于设置发布时候的一些设定。尤其方便你希望发布前设定指定的tagregistry

如下: 

{
  "name": "usercenter",
  "version": "1.0.0",
  "description": "manage usercenter",
  "keywords": ["angular","es6"],
  "homepage": "https://github.com/***",
  "bugs": {
    "url": "https://github.com/***",
    "email": "111@qq.com"
  },
  "license": "ISC",
  "author": "xjx",
  "main": "src/index.html",
  "repository": {
    "type": "git",
    "url": "git clone git@git.hrmch.com:usercenter.git ~/git/usercenter"
  },
  "scripts": {
    "init": "npm install",
    "install": "bower install",
    "start": "node src/server/app.js",
    "build": "gulp build"
  },
  "dependencies": {
    "body-parser": "^1.19.0",
    "express": "^4.17.1",
    "morgan": "^1.10.0",
    "serve-favicon": "^2.5.0"
  },
  "devDependencies": {
    "babel-core": "^6.26.3",
    "babel-preset-env": "^1.7.0",
    "chalk": "^4.1.2",
    "gulp": "^4.0.2",
  }
}

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

smart_dream

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值