zoukankan      html  css  js  c++  java
  • package.json文件各个选项含义

    本文转自阮一峰老师教程,链接:http://javascript.ruanyifeng.com/nodejs/packagejson.html#

    目录

    重要说明:本教程已经搬迁,此处不再维护,请访问新网址:wangdoc.com/javascript

    概述

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

    下面是一个最简单的package.json文件,只定义两项元数据:项目名称和项目版本。

    {
      "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文件的各个字段。

    scripts字段

    scripts指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。

    下面的设置指定了npm run preinstallnpm run postinstallnpm run startnpm 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会建立符号链接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键,就会显示所有可以使用的命令。

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

    .

  • 相关阅读:
    字符串和正则表达式
    委托和事件
    集合
    C#基础
    Pwnable中的passcode解题记录:
    DevExpress插件中GridView控件界面显示风格的保存与加载
    地区代码表(利用Hashtable实现)
    关于DevExpress插件中LookUpEdit控件的快速搜索列的定位问题
    C#实现PictureBox控件的动态添加及在每个图像左上角添加一个复选框
    Android4.4新的特性,在应用内开启透明状态栏和透明虚拟按钮。
  • 原文地址:https://www.cnblogs.com/jianxian/p/12247910.html
Copyright © 2011-2022 走看看