package.json与package-lock.json

简介：

package.json 文件一般都在每个项目的根目录下面，定义了这个项目所需要的各种模块，以及项目的配置信息(比如名称、版本、许可证、依赖模块等元数据)。npm install 命令根据这个配置文件，

　　　　　　自动下载所需的模块，也就是配置项目所需的运行和开发环境。该文件会描述这个NPM包的所有相关信息，包括作者、简介、包依赖、构建等信息，格式是严格的JSON格式。

package-lock.json 是在 `npm install` 时候生成一份文件，用以记录当前状态下实际安装的各个 npm package 的具体来源和版本号。

package-lock.json作用：

　　因为npm是一个用于管理package之间依赖关系的管理器，它允许开发者在pacakge.json中间标出自己项目对npm各库包的依赖，所以就可以实现锁定安装时的包的版本号，并且需要上传到git，以保证其他人在npm install时大家的依赖能保证一致。

　　你可以选择以如下方式来标明自己所需要库包的版本，例如：

"dependencies": {
 "@types/node": "^8.0.33",
},

　　这里面的向上标号^是定义了向后（新）兼容依赖，指如果 types/node的版本是超过8.0.33，并在大版本号（8）上相同，就允许下载最新版本的 types/node库包，例如实际上可能运行npm install时候下载的具体版本是8.0.35。

　　大多数情况这种向新兼容依赖下载最新库包的时候都没有问题，可是因为npm是开源世界，各库包的版本语义可能并不相同，有的库包开发者并不遵守严格这一原则：不同时间或者不同npm下载源之下，下到的各依赖库包版本可能有所不同，因此其依赖库包行为特征也不同有时候甚至完全不兼容。-...- npm最新的版本就开始提供自动生成package-lock.json功能，为的是让开发者知道只要你保存了源文件，到一个新的机器上、或者新的下载源，只要按照这个package-lock.json所标示的具体版本下载依赖库包，就能确保所有库包与你上次安装的完全一样。

那如果我们安装时的包有bug，后面需要更新怎么办？

在以前可能就是直接改package.json里面的版本，然后再npm install了，但是5版本后就不支持这样做了，因为版本已经锁定在package-lock.json里了，所以我们只能npm install xxx@x.x.x 这样去更新我们的依赖，然后package-lock.json也能随之更新。

假设我们已经安装了jquery 2.1.4这个版本，从git更新了package.json和package-lock.json，我们使用npm install能覆盖掉node_modules里面的依赖吗?

其实我也有这个疑问，所以做了测试，在直接更新package.json和package-loc.json这两个文件后，npm install是可以直接覆盖掉原先的版本的，所以在协作开发时，这两个文件如果有更新，你的开发环境应该npm install一下才对。

package.json用法？

常用命令：

npm i --save packageName 安装依赖包
npm i --save-dev packageName
npm i webpack@1.2.1 安装指定版本的包，版本号用@符号连接

npm install 模块名 -s/--save  把模块写进依赖文件
npm install 模块名  -g/--global  安装的是工具,全局安装
卸载：npm uninstall  --global|-g  模块包名称
npm init (-y) 初始化一个node项目(一步到位)
属性介绍：
name(包名) 和 version(包的版本号。如"1.0.0")
　　是package.json中最重要的两个字段，也是发布到NPM平台上的唯一标识，如果没有正确设置这两个字段，包就不能发布和被下载。 是两项元数据：项目名称和项目版本
　　description(包的描述信息),将会在npm search的返回结果中显示，以帮助用户选择合适的包。
　　下面是一个更完整的package.json文件。

{
    "name": "Hello World",
    "version": "0.0.1",
    "author": "张三",
    "description": "第一个node.js程序",
    "keywords":["node.js","javascript"],
    "repository": {
        "type": "git",
        "url": "https://path/to/url"
    },
    "license":"MIT",
    "engines": {"node": "0.10.x"},
    "bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
    "contributors":[{"name":"李四","email":"lisi@example.com"}],
    "scripts": {
        "start": "node index.js"
    },
    "dependencies": {
        "express": "latest",
        "mongoose": "~3.8.3",
        "handlebars-runtime": "~1.0.12",
        "express3-handlebars": "~0.5.0",
        "MD5": "~1.2.0"
    },
    "devDependencies": {
        "bower": "~1.2.8",
        "grunt": "~0.4.1",
        "grunt-contrib-concat": "~0.3.0",
        "grunt-contrib-jshint": "~0.7.2",
        "grunt-contrib-uglify": "~0.2.7",
        "grunt-contrib-clean": "~0.5.0",
        "browserify": "2.36.1",
        "grunt-browserify": "~1.3.0",
    }
}
 
下面详细解释package.json文件的各个字段。

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"
}

dependencies字段，devDependencies字段
　　dependencies字段指定了项目运行所依赖的模块，devDependencies指定项目开发所需要的模块。它们都指向一个对象。
该对象的各个成员，分别由模块名和对应的版本要求组成，表示依赖的模块及其版本范围。
{
  "devDependencies": {
    "browserify": "~13.0.0",
    "karma-browserify": "~5.0.1"
  }
}
对应的版本可以加上各种限定，主要有以下几种：指定版本：比如1.2.2，遵循“大版本.次要版本.小版本”的格式规定，安装时只安装指定版本。
波浪号（tilde）+指定版本：比如~1.2.2，表示安装1.2.x的最新版本（不低于1.2.2），但是不安装1.3.x，也就是说安装时不改变大版本号和次要版本号。
插入号（caret）+指定版本：比如ˆ1.2.2，表示安装1.x.x的最新版本（不低于1.2.2），但是不安装2.x.x，也就是说安装时不改变大版本号。
需要注意的是，如果大版本号为0，则插入号的行为与波浪号相同，这是因为此时处于开发阶段，即使是次要版本号变动，也可能带来程序的不兼容。
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属性。

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会建立符号链接node_modules/.bin/someTool。由于node_modules/.bin/目录会在运行时加入系统的PATH变量，
因此在运行npm时，就可以不带路径，直接通过命令来调用这些脚本。因此，像下面这样的写法可以采用简写。scripts: {  
  start: './node_modules/bin/someTool.js build'
}
// 简写为



scripts: {

start: 'someTool build'

}
所有node_modules/.bin/目录下的命令，都可以用npm run [命令]的格式运行。在命令行下，键入npm run，然后按tab键，就会显示所有可以使用的命令。
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


其他
browser字段　　browser指定该模板供浏览器使用的版本。Browserify这样的浏览器打包工具，通过它就知道该打包那个文件。
"browser": {
  "tipso": "./node_modules/tipso/src/tipso.js"
},
engines 字段　　engines字段指明了该模块运行的平台，比如 Node 的某个版本或者浏览器。
{ "engines" : { "node" : ">=0.10.3 <0.12" } }

　　该字段也可以指定适用的npm版本。
{ "engines" : { "npm" : "~1.0.20" } }

man字段　　man用来指定当前模块的man文档的位置。
"man" :[ "./doc/calc.1" ]

preferGlobal字段　　preferGlobal的值是布尔值，表示当用户不将该模块安装为全局模块时（即不用–global参数），要不要显示警告，表示该模块的本意就是安装为全局模块。style字段　　style指定供浏览器使用时，样式文件所在的位置。样式文件打包工具parcelify，通过它知道样式文件的打包位置。
"style": [
  "./node_modules/tipso/src/tipso.css"
]

参考教程：package.json文件

ES6 教程电子书：ECMAScript 6 简介

posted on 2021-11-11 18:25 北唐陌颜阅读(793) 评论(0) 编辑收藏举报

刷新页面返回顶部

北唐陌颜

package.json与package-lock.json

简介：

package.json用法？

scripts字段

dependencies字段，devDependencies字段

peerDependencies

bin字段

main字段

config 字段

其他

browser字段

engines 字段

man字段

preferGlobal字段

style字段

导航

公告