05.使用package.json

创建package.json是用来管理本地包的最好的方法。

一个package.json文件可以提供很多有用的事情:
1.它描述了你的项目依赖一些包
2.它指定了包的版本范围
3.它使你的项目分享给其他开发者更容易

要求

最小限度的要求:

  • "name"

    • 全部小写
    • 一个单词,不能有空格
    • 允许破折号和下划线
  • "version"

例子

{
  "name": "my-awesome-package",
  "version": "1.0.0"
}

创建一个package.json

npm init

这将根据你的输入在当前目录创建一个package.json文件。

标识--yes

npm init --yes

这将根据默认模板快速创建一个package.json文件。

这将写到当前目录的package.json

{
  "name": "my_package",
  "description": "",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "repository": {
    "type": "git",
    "url": "https://github.com/ashleygwilliams/my_package.git"
  },
  "bugs": {
    "url": "https://github.com/ashleygwilliams/my_package/issues"
  },
  "homepage": "https://github.com/ashleygwilliams/my_package"
}
  • name:默认是作者名,如果在git目录则是目录名。
  • description:空
  • version:1.0.0
  • main:index.js
  • scripts:创建一个空的测试脚本
  • keywords:空的
  • author:空的
  • license:ISC
  • respository:和当前所在目录有关
  • bugs:和当前所在目录有关
  • home:和当前所在目录有关

你可以通过以下命令配置一些默认信息

npm set init.author.email "wombat@npmjs.com"
npm set init.author.name "ag_dubs"
npm set init.license "MIT"

note:
如果package.json中没有description字段,NPM使用readme.md的第一行或readme作为description。description有助于人们找到你的NPM包;一个自定义的描述可以让你的包更容易被发现。

定制init

同样你可以自己定制一些初始化信息,在初始化的时候这些信息会自动放到package.json中。你需要把额外的初始化信息放到 .npm-init.js 中,这个文件需要在根目录中创建。

如果是windows系统,则放在如下目录

X:\Users\用户名\.npm-init.js

例子,如果你的.npm-init.js内容像下面一样:

module.exports = {
  customField: 'Custom Field',
  otherCustomField: 'This field is really cool'
}

当执行 npm init 命令时,会在当前目录生成一个package.json文件,内容如下:

{
  customField: 'Custom Field',
  otherCustomField: 'This field is really cool'
}

Customizing the questions is also possible, by using the prompt function.

module.exports = prompt("what's your favorite flavor of ice cream buddy?", "I LIKE THEM ALL");

如果想要学习更高级的自定义,可以查看
init-package-json

指定依赖包

你需要在 package.json 中声明你的项目需要依赖的包。这里有两种依赖类型的声明:

  • "dependencies":生成的产品中需要依赖的包
  • "devDependencies":仅在开发和测试中需要用到的包。

手动编辑package.json

你可以手动编辑package.json。你需要创建dependencies属性去为你的项目添加依赖,这个属性将描述你所用到的包以及所用包的版本,使用 semver表达式来声明哪些版本的包是兼容你的项目的。

如果你仅仅只需要在开发中使用这些包,你可以按照上述相同配置在devDependencies属性中。

例如:你的项目使用 my_dep 的版本1作为生产依赖,使用 my_test_framework 作为开发时的依赖。你可以如下配置:

{
  "name": "my_package",
  "version": "1.0.0",
  "dependencies": {
    "my_dep": "^1.0.0"
  },
  "devDependencies" : {
    "my_test_framework": "^3.1.0"
  }
}

--save 和 --save-dev

使用命令为你的项目添加依赖是更简单方便的。你可以使用 npm install命令下载包到本地。运用标志位可以自动添加依赖项到package.json文件中。

添加到package.json的dependencies:

npm install <package_name> --save

添加到package.json的devDependencies:

npm install <package_name> --save-dev

管理依赖版本

npm使用Semantic Versioning(我们通常简称为SemVer)来管理包的版本范围。

如果当前目录存在package.json文件,使用npm install命令,npm将会根据 semver rules 下载最新的依赖包。

你可以通过 Getting Started "Semver" page学习semantic versioning。

官方原文

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,250评论 2 36
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,876评论 0 9
  • 原文链接:http://www.mujiang.info/translation/npmjs/files/pack...
    R_X阅读 1,027评论 0 1
  • 描述 npm从以下来源获取配置值,按优先级排序: 命令行标记 在命令行上放置--foo bar设置foo配置参数为...
    竹天亮阅读 44,142评论 0 8