package.json作用
这个文档的内容是你必须要知道的,它必须是JSON文本格式。每个项目的根目录下面,一般都有一个package.json
文件,定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install
命令根据这个配置文件,自动下载所需的模块,也就是配置项目所需的运行和开发环境。
name和version 属性
这个属性是必须的,定义项目的名称和项目的版本号(遵守“大版本.次要版本.小版本”的格式)。如果没有name属性和version属性,那这个包将不能进行安装。name和version保证了包的唯一性。
注意:
- name 长度不超过240字节;
- name不能以圆点和下划线开头;
- name只能是小写;
小技巧:
- 不能是已经有的包名称 (查看npm注册表,是否存在这个名称) ;
- 在name中不能带有js或node;
- 尽量简短;
dependencies 属性
dependencies属性
指定了项目运行所依赖的模块,devDependencies
指定项目开发所需要的模块。它们都指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。
对应的版本可以加上各种限定,主要有以下几种:
1. 指定版本:比如1.2.2,遵循“大版本.次要版本.小版本”的格式规定,安装时只安装指定版本。2. 大于(>),大于等于(>=),小于(<),小于等于(<=):必须是大于(大于等于,小于,小于等于)某个版本,也可以同时使用(>=version1 <=version2)。3. 星号(*):任何版本。4. git版本(git...):可以使用git URL来进行版本依赖。 5. 波浪号(tilde)+指定版本:比如~1.2.2,表示安装1.2.x的最新版本(不低于1.2.2),但是不安装1.3.x,也就是说安装时不改变大版本号和次要版本号。 6. 插入号(caret)+指定版本:比如ˆ1.2.2,表示安装1.x.x的最新版本(不低于1.2.2),但是不安装2.x.x,也就是说安装时不改变大版本号。需要注意的是,如果大版本号为0,则插入号的行为与波浪号相同,这是因为此时处于开发阶段,即使是次要版本号变动,也可能带来程序的不兼容。 7. latest:安装最新版本。
例子:
package.json文件可以手工编写,也可以使用npm init
命令自动生成。
$ npm init
这个命令采用互动方式,要求用户回答一些问题,然后在当前目录生成一个基本的package.json文件。所有问题之中,只有项目名称(name)和项目版本(version)是必填的,其他都是选填的。
有了package.json文件,直接使用npm install命令,就会在当前目录中安装所需要的模块。
$ npm install
如果一个模块不在package.json
文件之中,可以单独安装这个模块,并使用相应的参数,将其写入package.json
文件之中。
$ npm install express --save $ npm install express --save-dev
上面代码表示单独安装express模块,--save
参数表示将该模块写入dependencies
属性,--save-dev
表示将该模块写入devDependencies
属性。
description 属性
description属性是对项目进行描述,帮助用户发现你的项目。
license 属性
license属性是表述你项目发布遵循什么样的规则,用户拥有那些权限。
{ "license" : "BSD-3-Clause" }
author 属性
author 属性指明了项目的发布者。
ahthor:“张三”
contributions 属性
contributions 属性指明了项目的贡献者。
"contributors":[{"name":"李四","email":"lisi@example.com"}],
scripts属性
scripts
指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start
时,所要执行的命令。
下面的设置指定了npm run preinstall
、npm run postinstall
、npm run start
、npm run test
时,所要执行的命令。
"scripts": {"preinstall": "echo here it comes!","postinstall": "echo there it goes!","start": "node index.js","test": "tap test/*.js"
}
peerDependencies属性
有时,你的项目和所依赖的模块,都会同时依赖另一个模块,但是所依赖的版本不一样。比如,你的项目依赖A模块和B模块的1.0版,而A模块本身又依赖B模块的2.0版。
大多数情况下,这不构成问题,B模块的两个版本可以并存,同时运行。但是,有一种情况,会出现问题,就是这种依赖关系将暴露给用户。
最典型的场景就是插件,比如A模块是B模块的插件。用户安装的B模块是1.0版本,但是A插件只能和2.0版本的B模块一起使用。这时,用户要是将1.0版本的B的实例传给A,就会出现问题。因此,需要一种机制,在模板安装的时候提醒用户,如果A和B一起安装,那么B必须是2.0模块。
peerDependencies
字段,就是用来供插件指定其所需要的主工具的版本。
{"name": "chai-as-promised","peerDependencies": {"chai": "1.x"} }
上面代码指定,安装chai-as-promised
模块时,主程序chai
必须一起安装,而且chai
的版本必须是1.x
。如果你的项目指定的依赖是chai
的2.0版本,就会报错。
注意,从npm 3.0版开始,peerDependencies
不再会默认安装了。
bin属性
bin项用来指定各个内部命令对应的可执行文件的位置。
"bin": {"someTool": "./bin/someTool.js" }
上面代码指定,someTool 命令对应的可执行文件为 bin 子目录下的 someTool.js。Npm会寻找这个文件,在node_modules/.bin/
目录下建立符号链接。在上面的例子中,someTool.js会建立符号链接npm_modules/.bin/someTool
。由于node_modules/.bin/
目录会在运行时加入系统的PATH变量,因此在运行npm时,就可以不带路径,直接通过命令来调用这些脚本。
main属性
main
字段指定了加载的入口文件,require('moduleName')
就会加载这个文件。这个字段的默认值是模块根目录下面的index.js
。
config 属性
config属性
用于添加命令行的环境变量。
下面是一个package.json
文件。
{"name" : "foo","config" : { "port" : "8080" },"scripts" : { "start" : "node server.js" } }
然后,在server.js
脚本就可以引用config
字段的值。
http.createServer(...).listen(process.env.npm_package_config_port)
用户执行npm run start
命令时,这个脚本就可以得到值。
$ npm run start
用户可以改变这个值。
$ npm config set foo:port 80
engines 属性
engines
字段指明了该模块运行的平台,比如 Node 的某个版本或者浏览器。
"engines": {"node": "0.10.x"},
repository 属性
repository属性指明了你的仓库位置,帮助用户去迭代你的项目。
例如:
"repository" :{"type" : "git" ,"url" : "https://github.com/npm/npm.git"}
转载于:https://www.cnblogs.com/phpandmysql/p/7419742.html
package.json作用相关推荐
- 前端项目中package.json到底是什么,又充当着什么作用呢?一文来带你了解package.json!
大家好,我是纸飞机,想必大家都在项目中经常看见package.json.package-lock.json.node_modules这三剑客,那么他们到底是什么呢?又有什么作用呢?今天就来带你们理一遍 ...
- webpack:package.json中scripts的作用
webpack:package.json中scripts的作用 为了在执行命令的时候输入太长的命令,我们可以将要执行的命令配置到 package.json的scripts中,因为scripts中配置可 ...
- node工程中package.json文件作用是什么?里面的^尖括号和~波浪号是什么意思?
1.package.json文件的作用是什么? package.json是包的说明文件,主要有以下3个作用: (1)相当于你本地项目的一个文档说明. (2)允许你指定你项目中所使用的node包的版本. ...
- package.json和package-lock.json的作用
package.json记录当前项目所依赖模块的版本信息,更新模块时锁定模块的大版本号(版本号的第一位).package-lock.json记录了node_modules目录下所有模块的具体来源和版本 ...
- package.json 中的 bin 字段作用
我们在下载 npm 包后,查看 npm 包的 package.json 有些包会有 bin 字段 例如我们常用的 webpack-cli 包 那么 bin 字段有什么用呢? 官方文档链接 许多软件包都 ...
- 15 —— npm —— package.json 与 package-lock.json 的作用
一,package.json 是 npm init 时创建的一个文件,会记录当前整个项目中的一些基础信息. 二,package-lock.json 是 node_modules 文件夹或者 pack ...
- package.json中private选项的作用
如果你"private": true在package.json中设置,那么npm将拒绝发布它. 这是一种防止意外发布私有存储库的方法.如果您希望确保仅将某个包发布到特定注册表(例如 ...
- npm WARN saveError ENOENT: no such file or directory, open ‘/Users/....../package.json‘的解决办法
执行npm报错: npm WARN saveError ENOENT: no such file or directory, open '/Users/....../package.json' 根据错 ...
- package.json文件||项目依赖||开发依赖
package.json文件 node_modules文件夹的问题 package.json文件的作用 项目描述文件,记录了当前项目信息,例如项目名称.版本.作者.github地址.当前项目依赖了哪些 ...
最新文章
- 1.75亿美元!吴恩达第三锤:宣布成立AI基金AIFund
- SQL Server 2008_企业版和开发版产品密钥
- 关于NodeJS配置HTTPS服务、阿里云申请HTTPS证书
- 《廖雪峰 . Git 教程》学习总结
- 前端基础(一):js数据类型
- docker学习(一)ubuntu上安装docker
- 关于一次装机后的个人总结
- 如何在 C# 中使用 Exceptionless
- Makefile模板的改进
- .NET开发设计模式-获取某个接口下面所有的派生类
- uboot网络调试方法
- jquery遍历的radio的取值问题
- qt结合arcgis for qt开发(鼠标点击地图获取坐标,坐标转换)
- 崩溃死我的Dev无法调试,Devc调试点下一步没反应
- db9串口(db9串口定义及颜色)
- 一个朋友的精彩BLOG
- grep指令与ps指令的详细使用说明
- 物联网有哪些安全风险?物联网安全问题汇总
- 【Pandas】- pandas入门
- 架构扫盲 | 四种常见的软件架构