package.json说明

项目中用到的package.json中使用到的配置字段。

{
  "name": "项目名称",
  "version": "项目版本",
  "description": "项目描述",
  "keywords": ["项目关键词"],
  "main": "标识入口函数",
  "files": [],
  "script": {   // 执行脚本的指令
    "bootstrap": "yarn || npm i",                                 // 安装项目依赖
    "makefile": "node bin/makefile.js",                           // 根据路由文件生成项目目录
    "generate": "npm run makefile",                               // 与上一指令等同
    "dev": "node bin/dev-server.js",                              // 开启本地服务
    "start": "npm run dev",                                       // 与上一指令等同
    "build": "node bin/build.js",                                 // 编译打包
    "prod": "npm run build",                                      // 与上一指令等同
    "lint": "eslint --fix src scripts test",                      // 检查代码并修复
    "dev:test": "karma start test/karma/karma.dev.config.js",     // 本地开发测试
    "test:unit": "karma start test/karma/karma.unit.config.js",   // 单元测试
    "test:cover": "karma start test/karma/karma.cover.config.js", // 覆盖率测试
    "test": "npm run lint && npm run test:cover",                 // 可能还会引入端到端的测试
    "flow": "flow check",                                         // 工作流检测
    "release": "bash scripts/release.sh",                         // 执行发布脚本
    "release:note": "node scripts/gen-release-note.js"            // 发布流程信息
  },
  "repository": {                                                 // 源码库地址信息
    "type": "源码库类型",
    "url": "源码库地址"
  },
  "author": ["项目作者"],
  "license": "许可协议",
  "bugs": "issues地址",
  "homepage": "源码库homepage",
  "devDependencies": "开发环境依赖",
  "dependencies": "公共依赖",
  "peerDependencies": "指定依赖",
  "engines": {},                                                  // 引擎信息
  "browserslist": []                                              // 浏览器支持信息
}