想必大家在一些node工程中都见过package.json 文件吧,那么它到底有什么神秘的面纱呢?现在就随我一起来揭秘他的神秘面纱!!!!
package.json文件描述了一个NPM包的所有相关信息,包括
作者、
简介、
包依赖、
构建等信息
package.json文件描述了一个NPM包的所有相关信息,包括
作者、
简介、
包依赖、
构建等信息
格式必须是严格的JSON格式。
1、name
name
和version
是package.json中最重要的两个字段,也是发布到NPM平台上的唯一标识,如果没有正确设置这两个字段,包就不能发布和被下载。
新版本的NPM可以指定scope, 名字可以加前缀标识,如@ijse/mypackag
2、version
这个字段的取值需要符合node-semver的规则,详细可以见其文档
3、description
包的描述信息,将会在npm search
的返回结果中显示,以帮助用户选择合适的包。
4、keywords
包的关键词信息,是一个字符串数组,同上也将显示在npm search
的结果中。
5、homepage
包的主页地址
6、bugs
包的bug跟踪主页地址
7、license
包的开源协议名称
8、author
包的作者,可以是字符串或对象
9、repository
包的仓库地址
10、scripts
通过设置这个可以使NPM调用一些命令脚本,封装一些功能。
11、config
添加一些设置,可以供scripts
读取用,同时这里的值也会被添加到系统的环境变量中。
12、dependencies
指定依赖的其它包,这些依赖是指包发布后正常执行时所需要的,如果是开发中依赖的包,可以在devDependencies
设置。
通常使用下面命令来安装:
npm install --save otherpackage
13、devDependencies
这些依赖只有在开发时候才需要。
14、peerDependencies
相关的依赖,如果你的包是插件,而用户在使用你的包时候,通常也会需要这些依赖(插件),那么可以将依赖列到这里。
如果想获得更详细配置项,请访问 https://www.ijser.cn/npm-package-json-document/