package.json字段知识
必要属性
1. name
- 如果项目是需要发版为npm包的，则name字段是必须的。 因为它涉及到npm包的命名。
- 如果项目不需要发npm包，则name字段为可选
例如：
{
'name': 'myProject',
'version': '1.0.0',
'description': '',
'keywords': []
}
命名规则：
name字符串长度，必须小于或等于214个字符。
不能以”.“和”_“开头
不能使用大写字母命名
2. version
如果项目是需要发版为npm包的，则version字段是必须的,否则为可选
-
格式为：主版本号.次版本号.修订号 1.0.0
npm view react versions: 查看react所有版本
描述
1. description
description用于描述当前项目的概况。 如上图所示，发布的npm包，在搜索结果中，可以直接显示description内容，方便使用方直接了解包的功能
2. keywords
如上图react Javascript等标签信息
'keywords': [
'react',
'javascript',
'ui'
]
3. homepage
homepage就是项目的主页地址了，它是一个字符串。
'homepage': 'https"//....';
4. author
作者信息
通过此信息使其他人知道此项目是谁制作
'author': {
'name': 'greyfus',
'email': '8888888@qq.com',
'url': 'https://.....',
}
5. contributors
协作者信息。
格式为对象数组，对象内容与author一致
'contributors': [
{
'name': 'author1',
'email': '8888888@qq.com',
},
{
'name': 'author2',
'email': '8888888@qq.com',
}
]
6. repository
repository表示代码的存放仓库地址，通常有两种书写形式。第一种是字符串形式：
'repository': {
'type': 'git',
'url': 'https://...',
}
7. bugs
开源项目，用于接受bug反馈。
{
'url': 'https://github.com/facebook/react/issues',
'email': '8888888@qq.com',
}
文件
1. files
files指定的文件（包括文件夹）会被推送到npm服务器中
'files': [
'src',
'dist/*.js',
]
如果有不想提交的文件，可以在项目根目录中新建一个.npmignore文件，写在这个文件中的文件即便被写在files属性里也会被排除在外。比如可以在该文件中这样写：
dist/
deploy_versions/
.temp/
.rn_temp/
node_modules/
.DS_Store
2. main
使用npm包时，需要执行require(...)操作，这个操作会查看main字段，找到程序的主入口
'main': 'dist/index.js'
脚本配置相关
script
项目脚本命令。约定俗成的规范脚本命令
npm run start 开发模式启动
npm run build 编译打包
config
config字段用来配置scripts运行时的配置参数，如下所示：
'config': {
"port": 3000
}
// 运行npm run start, 此时port字段会映射到”npm_package_config_port“环境变量上
console.log(process.env.npm_package_config_port) // 3000
用户可以通过npm config set foo:port 3001 命令来重写port的值
依赖
dependencies、devDependencies、peerDependencies
dependencies生产依赖与devDependencies开发依赖。
dependencies规则：
// 符号^ : 主版本不变，可更新 次版本与修正版本
'dependencies': {
'react': '^17.0.0', // 安装依赖时，可以安装符合17.*.* 的任意版本，只要主版本号是17即可。
}
// 符号~ : 主版本与次版本不变，可更新 修正版本号
'react': '^17.0.0', // 安装依赖时，可以安装符合17.0.* 的任意版本
// 符号* : 可以安装任意版本
'react': '^17.0.*', // 安装依赖时，可以安装符合17.0.* 的任意版本
'react': '^17.*.*', // 安装依赖时，可以安装符合17.*.* 的任意版本
// latest: 最新的稳定版
'react': 'latest',
peerDependencies在npm包的依赖关系处理中的作用：
例如：UI组件antd@4.0 之后依赖 React 16以上的版本。
'peerDependencies': {
'react': '>=16.0.0'
}
当项目npm install时，安装依赖低于对应版本，控制台会输出WARN。
engines
项目运行环境的要求声明
当我们维护一些旧项目时，可能对npm包的版本或者Node版本有特殊要求，如果不满足条件就可能无法将项目跑起来。为了让项目开箱即用，可以在engines字段中说明具体的版本号
'engines': {
'node': '>=8.10.3<15'
}
上述代码，告知node版本需要在8.10.3与15之间，才可以运行当前项目。 在不符合条件的环境中运行项目时，控制台会有报错输出。
发布配置
1. private
private字段可以防止我们意外地将私有库发布到npm服务器。只需要将该字段设置为true：
2.publishConfig
publishConfig配置会在模块发布时生效，用于设置发布时一些配置项的集合。如果不想模块被默认标记为最新，或者不想发布到公共仓库，可以在这里配置tag或仓库地址
通常情况下，publishConfig会配合private来使用，如果只想让模块发布到特定npm仓库，就可以这样来配置：
"private": true,
"publishConfig": {
"tag": "1.1.0",
"registry": "https://registry.npmjs.org/",
"access": "public"
}
license
项目的协议类型。
license 字段用于指定软件的开源协议，开源协议表述了其他人获得代码后拥有的权利，可以对代码进行何种操作，何种操作又是被禁止的。常见的协议如下：
MIT ：只要用户在项目副本中包含了版权声明和许可声明，他们就可以拿你的代码做任何想做的事情，你也无需承担任何责任。
Apache ：类似于 MIT ，同时还包含了贡献者向用户提供专利授权相关的条款。
GPL ：修改项目代码的用户再次分发源码或二进制代码时，必须公布他的相关修改。
os
操作系统的要求声明
'os': [
'darwin',
'linux',
]
