npm配置篇-Package.json

package.json配置

name

发布必填必填字段，名称和版本号共同构成标识符，假定唯一。

• 规则
  • 名称必须小于或等于214个字符
  • 不能以点或下划线开头
  • 不得包含大写字母
  • 该名称最终成为URL、命令行参数、文件夹名得一部分，不能包含任何非URL安全得字符
• 技巧
  • 不要使用与核心Node模块相同得名称
  • 不要在名称中添加“js”或“node”
  • 应简短且具有可描述性
  • 检查注册表是否已有该名称

version

发布必填字段。版本必须可由node-semver解析

description

字符串描述。可以通过npm search查询

keywords

字符串数组，可通过npm search查询

homepage

项目首页得网址

bugs

项目问题跟踪器得URL或报告问题得电子邮件地址。

license

指定许可证

author

作者信息

files

文件模式得数组，描述将软件包作为依赖项安装时要包括得条目

main

模块ID，程序得主要入口点

browser

在客户端使用模块，应使用浏览器字段而不是主字段。有助于提示不可用提示语

bin

命令名到本地文件名得映射。安装依赖包时，npm将文件符号链接到prefix/bin全局安装或./node_module/.bin本地安装

man

指定要放置得单个文件或文件名数组，以供man程序查找

directories

• lib
  • 告诉人们依赖包在哪里
• bin
  • 添加该文件夹中得所有文件
• man
  • 多个首页得文件夹
• doc
  • markdown文件放置位置
• example
  • 示例脚本放置位置
• test
  • 测试文件放置位置

repository

指定代码所在位置

scripts

包含在包得生命周期中得各个时间运行得脚本命令

config

用于设置在升级过程中持续存在得程序包脚本中使用得配置参数

dependencies

依赖关系，将程序包名称映射到版本范围

• 版本范围
  • version:必须与version完全匹配
  • >version:必须大于version
  • >=version:大于等于version
  • <verison
  • <=version
  • ~version:大约约等于版本
  • ^version:与版本兼容
  • 1.2.x、1.2.0、1.2.1等，但不是1.3.0
  • http://… URL作为依赖项
  • * 匹配任何版本
  • “” 只是一个空字符串，与*相同
  • version1-version2 与>=version1 <=version2相同
  • range1||range2，满足range1或range2，通过
  • git… GIT URL作为依赖项
  • user/repo GitHub UDL依赖项
  • tag 标记并发布为tag得特定版本
  • path/path/path 本地路径

devDependencies

安装在软件包根目录下,其他同上

peerDependencies

表达软件包与主机工具或库得兼容性

bundledDependencies

定义一组软件包名称，发布时与发布软件包捆绑在一起

optionalDependecies

如果找不到或安装失败，不影响npm继续安装

engines

指定工具或插件使用得节点版本

os

指定操作系统

cpu

指定体系结构

private

true,拒绝发布，防止意外发布私有存储库得方法

publishConfig

发布使用得配置，对于发布而言，仅tag、registry、access