首页 > Web开发 > 详细

package.json文件说明

时间:2019-12-18 11:47:56      阅读:79      评论:0      收藏:0      [点我收藏+]

1.概述

每个项目的根目录下面都有一个package.json文件,定义了这个项目所需要各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install 命令根据这个配置文件,自动下载所需要的模块,也就是配置项目所需的运行和开发环境

{
  "name" : "xxx",
  "version" : "0.0.0",
}

package.json 文件是一个JSON对象,该对象的每一个成员就是当前项目的一项设置。比如name就是项目名称,version 是版本

下面是一个更完整的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文件的各个字段

2.script字段
script指定了运行脚本命令的npm命令行缩写,比如start指定了npm run start 时,所需要执行的命令。

下面指定了npm run preinstall 、npm run postinstall 、npm run start 、npmm run start时,所需要执行的命令

"scripts": {
    "preinstall": "echo here it comes!",
    "postinstall": "echo there it goes!",
    "start": "node index.js",
    "test": "tap test/*.js"
}

 

3.dependencies字段,devDependencies字段
dependencies字段指定了项目运行所依赖的模块,devDependencies指定项目开发所需要的模块。

它们都指向一个对象。该对象的各个成员,分别由模块和对应版本要求组成,表示以来的模块及其版本范围

{
  "devDependencies": {
    "browserify": "~13.0.0",
    "karma-browserify": "~5.0.1"
  }
}

 

4.

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不再会默认安装了。

 

5.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时,就可以不带路径,直接通过命令来调用这些脚本。

因此,像下面这样的写法可以采用简写。

scripts: {  
  start: ‘./node_modules/someTool/someTool.js build‘
}

// 简写为

scripts: {  
  start: ‘someTool build‘
}

 

所有node_modules/.bin/目录下的命令,都可以用npm run [命令]的格式运行。在命令行下,键入npm run,然后按tab键,就会显示所有可以使用的命令。
6.main字段
main字段制定了加载的入口文件,require(‘module‘)就会加载这个文件,这个字段默认值是模块目录下面的index.js

7.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

8.其他

8.1 browser字段

browser指定该模板共浏览器使用的版本。Browserify这样的浏览器打包工具,通过它就知道该打包那个文件。

"browser": {
  "tipso": "./node_modules/tipso/src/tipso.js"
},
8.2 engines字段
engines字段指明了该模块运行的平台,比如Node的某个版本或者浏览器
{ "engines" : { "node" : ">=0.10.3 <0.12" } }
该字段也可以指定npm版本
{ "engines" : { "npm" : "~1.0.20" } }

       8.3 man 字段 用来指定当前模块man文档的位置

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

 

 文章转自:http://javascript.ruanyifeng.com/nodejs/packagejson.html#

package.json文件说明

原文:https://www.cnblogs.com/itljl/p/12058688.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!