package.json

一、package.json 文件作用

package.json 文件其实就是对项目或者模块包的描述，里面包含许多元信息。比如项目名称，项目版本，项目执行入口文件，项目贡献者等等。npm install 命令会根据这个文件下载所有依赖模块。

二、package.json 文件示例

<pre spellcheck="false" class="md-fences md-end-block ty-contain-cm modeLoaded" lang="" cid="n4" mdtype="fences" style="box-sizing: border-box; overflow: visible; font-family: var(--monospace); font-size: 0.9em; display: block; break-inside: avoid; text-align: left; white-space: normal; background-image: inherit; background-position: inherit; background-size: inherit; background-repeat: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: rgb(248, 248, 248); position: relative !important; border: 1px solid rgb(231, 234, 237); border-radius: 3px; padding: 8px 4px 6px; margin-bottom: 15px; margin-top: 15px; width: inherit; color: rgb(51, 51, 51); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">{
"name": "exchange",
"version": "0.1.0",
"author": "zhangsan zhangsan@163.com",
"description": "第一个node.js程序",
"keywords":["node.js","javascript"],
"private": true,
"bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
"contributors":[{"name":"李四","email":"lisi@example.com"}],
"repository": { "type": "git", "url": "https://path/to/url" },
"homepage": "http://necolas.github.io/normalize.css",
"license":"MIT",
"dependencies": { "react": "^16.8.6", "react-dom": "^16.8.6",
"react-router-dom": "^5.0.1",
"react-scripts": "3.0.1" },
"devDependencies": { "browserify": "~13.0.0",
"karma-browserify": "~5.0.1" },
"scripts": {"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject" },
"bin": { "webpack": "./bin/webpack.js" },
"main": "lib/webpack.js",
"eslintConfig": { "extends": "react-app" },
"engines" : { "node" : ">=0.10.3 <0.12" },
"browserslist": { "production": [ ">0.2%", "not dead", "not op_mini all" ],
"development": [ "last 1 chrome version", "last 1 firefox version", "last 1 safari version" ] },
"style": [ "./node_modules/tipso/src/tipso.css"],
"files": [ "lib/", "bin/", "buildin/",
"declarations/", "hot/", "web_modules/", "schemas/", "SECURITY.md" ]
}</pre>

三、package.json 文件配置说明

1. name：项目/模块名称，长度必须小于等于214个字符，不能以"."(点)或者"_"(下划线)开头，不能包含大写字母。

2. version：项目版本。

3. author：项目开发者，它的值是你在https://npmjs.org网站的有效账户名，遵循“账户名<邮件>”的规则，例如：zhangsan zhangsan@163.com。

4. description：项目描述，是一个字符串。它可以帮助人们在使用npm search时找到这个包。

5. keywords：项目关键字，是一个字符串数组。它可以帮助人们在使用npm search时找到这个包。

6. private：是否私有，设置为 true 时，npm 拒绝发布。

7. license：软件授权条款，让用户知道他们的使用权利和限制。

8. bugs：bug 提交地址。

9. contributors：项目贡献者 。

10. repository：项目仓库地址。

11. homepage：项目包的官网 URL。

12. dependencies：生产环境下，项目运行所需依赖。

13. devDependencies：开发环境下，项目所需依赖。

14. scripts：执行 npm 脚本命令简写，比如 “start”: “react-scripts start”, 执行 npm start 就是运行 “react-scripts start”。

15. bin：内部命令对应的可执行文件的路径。

16. main：项目默认执行文件，比如 require(‘webpack’)；就会默认加载 lib 目录下的 webpack.js 文件，如果没有设置，则默认加载项目跟目录下的 index.js 文件。

17. eslintConfig：EsLint 检查文件配置，自动读取验证。

18. engines：项目运行的平台。

19. browserslist：供浏览器使用的版本列表。

20. style：供浏览器使用时，样式文件所在的位置；样式文件打包工具parcelify，通过它知道样式文件的打包位置。

21. files：被项目包含的文件名数组。