node npm package.json 解析

[TOC]

介绍

package.json 中包含各种所需模块以及项目的配置信息 meta 信息

package.json 字段介绍

必要字段

name: 它属于必须字段,在package.json中最重要的就是name和version字段,如果没有就无法install
name和version一起组成的标识在假设中是唯一的。改变包应该同时改变version。

使用时,应注意以下三点:

  1. 不要在name中包含js, node字样;
  2. 这个名字最终会是URL的一部分,命令行的参数,目录名,所以不能以点号或下划线开头;
  3. 这个名字可能在require()方法中被调用,所以应该尽可能短;

version:同上,属于必须字段

可选字段

  • description: 可选字段,它必须是字符串,帮助我们了解创建的包

  • keywords: 可选字段,可以是字符串数组,比如javascript, nodejs

  • homepage: 可选字段,项目官网的url。注意: 这和“url”不一样。如果你放一个“url”字段,registry会以为是一个跳转到你发布在其他地方的地址

  • bugs: 可选字段,问题追踪系统的URL或邮箱地址;npm bugs用的上

  • license: 指定一个许可证,让人知道使用的权利和限制的

  • main: main字段配置一个文件名指向模块的入口程序

    如果你包的名字叫foo,然后用户require("foo"),main配置的模块的exports对象会被返回

  • scripts: “scripts”是一个由脚本命令组成的hash对象,他们在包不同的生命周期中被执行

"scripts": {
    "dev": "NODE_ENV=development ./node_modules/.bin/nodemon bin/www",
    "start": "NODE_ENV=production node bin/www",
    "prd": "pm2 start bin/www",
    "test": "echo \"Error: no test specified\" && exit 1"
  }

key是生命周期事件,value是要运行的命令,使用方式 yarn run dev 或者 npm run prd

  • config: 可选对象

为一个obj,Config对象中的值在Scripts的整个周期中皆可用,专门用于给Scripts提供配置参数

  • repository: 指定你的代码存放的地方
  • dependencies: 指示当前包所依赖的其他包,版本格式可以是下面任一种:
version 完全匹配
>version 大于这个版本
>=version大于或等于这个版本
<version
<=version
~version 非常接近这个版本
^version 与当前版本兼容
  • devDependencies: 可选字段

如果只需要下载使用某些模块,而不下载这些模块的测试和文档框架,放在devDependencies下面比较不错

  • private: 可选字段,布尔值

如果private为true,npm会拒绝发布。这可以防止私有repositories不小心被发布出去

{
    "private": true
}

指定node版本

文档来源于

https://docs.npmjs.com/files/package.json#engines

在package.json 中的engines 节点 指定 依赖的nodejs 的版本号码

{
  "engines": {
    "node" : ">=8.0 <9.0",
    "npm": "~5.0.0"
  }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,258评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,335评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,225评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,126评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,140评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,098评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,018评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,857评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,298评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,518评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,400评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,993评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,638评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,661评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 原文链接:http://www.mujiang.info/translation/npmjs/files/pack...
    R_X阅读 1,027评论 0 1
  • name 必须字段。提示: 不要在name中包含 js、 node 字样; 这个名字最终会是 URL 的一部分,命...
    djyuning阅读 1,405评论 0 1
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,876评论 0 9
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,250评论 2 36