Skip to main content

packagejson的配置项

name

package 的名称,用于和version属性在一起唯一标识一个 package。如果不打算发布 package 到 npm,可以不配置name属性。

name的命名具有以下规则:

  • 小于等于 214 个字符
  • 不能以点.或者下划线_开头
  • 不能包含大写字母
  • 不能包含任何不安全的 URL 字符

name命名有以下建议:

  • 不要使用与核心 Node 模块相同的名称
  • 不要在名称中添加js或者node
  • 这个名称可能会作为参数传递给require()或者import,简洁一点比较好
  • 可以使用@[scope]限定 package 所属的组织,例如@babel/core

version

使用语义化版本 2.0.0 | Semantic Versioning (semver.org),即major.minor.patch

  • 第一位表示主版本号,一般表示大的功能更新迭代
  • 第二位表示更新向后兼容的新功能,重构等
  • 最后一位更新通常表示修复 bug

image-20200701184919910

~version:近似等于版本

~1.2.3   >=1.2.3 <1.3.0
~1.2 >=1.2.0 <1.3.0 1.2.x
~1 1.x

^version:根据 npm 版本号最多只有三位的情况,允许在最左侧同一非 0 版本号的范围内匹配

^1.2.3  >=1.2.3 <2.0.0              //最左侧非0版本号就是第一个
^0.2.3 >=0.2.3 <0.3.0 //最左侧非0版本号是第二个
^0.0.3 >=0.0.3 <0.0.4

其它还能用大于小于这些符号>version等,分别就表示大于小于版本号的匹配。

-beta.2:有时候会在版本号的后面带上beta的测试版本符号。

description

package 的描述字符串,可以帮助在 npm 官网搜索。

keywords

表示 package 信息关键字的字符串数组,可以帮助在 npm 官网搜索。

homepage

通常是项目介绍官网的网址

repository

开源项目可以指定repository属性,表示代码仓库的地址,例如:

"repository": {
"type" : "svn",
"url" : "https://v8.googlecode.com/svn/trunk/"
}

bugs

通常是 github 的 issue 地址

{
"url": "https://github.com/owner/project/issues",
"email": "[email protected]"
}

license

开源项目一般都会指定证书声明,例如:

{ "license" : "BSD-3-Clause" }

{ "license": "UNLICENSED" }

关于如何选择 license,这里放阮一峰老师的一张图

img

private

设置private:true 的项目可以避免项目误发布。

files

一个字符串数组,指定 package 发布的时候包含的文件,使用的是和.gitignore相同的文件 glob 匹配模式。以下文件在发布打包的时候总会包含在内:

  • package.json
  • README
  • LICENSE / LICENCE
  • main
  • bin

而以下文件总是会被忽略

  • .git
  • CVS
  • .svn
  • .hg
  • .lock-wscript
  • .wafpickle-N
  • .*.swp
  • .DS_Store
  • ._*
  • npm-debug.log
  • .npmrc
  • node_modules
  • config.gypi
  • *.orig
  • package-lock.json

image-20211127225149009

main

字符串路径,指定程序的主入口文件路径,例如 package 的namefoo,那么使用require("foo")就是查找main指定的文件路径返回的对象。如果没有指定main,默认是根目录下的index.js文件。

engines

指定 package 所需的 nodejs 或 npm 的版本,这对某些项目使用比较新的 ES 语法会比较有用,例如使用 typescript 编写且使用了?.的语法,那么 nodejs 的版本至少需要 16 以上。

{
"engines": {
"node": ">=0.10.3 <15"
}
}
{
"engines": {
"node": ">=0.10.3 <15"
}
}

bin

bin用于注册一个命令,该命令值指向 package 内部的可运行文件,这样在本地全局安装 package 以后,可以直接使用该命令直接运行 package,这也就是常用的 nodejs 命令行工具的实现方式。

{
"bin": {
"myapp": "./cli.js"
}
}

// 或者
{
"bin": "./bin/index.js"
}

对于bin指定命令链接的文件内部必须在顶部包含一行 Shebang(翻译: 工作) 可执行命令:

#!/usr/bin/env node

这行字符是在 Unix 系统中用于解析可执行脚本的 Shebang 字符串,由#!开头,且必须出现在文本文件的第一行。

当 Unix 系统遇到#!的时候,会将后面的内容作为脚本的解释器指令调用,例如下面的 nodejs 执行命令就是调用/usr/bin/envenv是个 Linux 命令,它会按照当前环境变量设置(主要是 PATH 变量),查找名为 node的可执行文件,然后执行后续的文件内容 JS 。这样就不需要在命令行工具内部使用node xxx,而是直接输入指定命令就可以执行了。

#!/usr/bin/env node

'use strict';

require('../lib/index.js');

而 Windows 系统源于历史 DOS,所以在 Windows 系统并不会识别 Shebang 字符串,但是仍然需要添加这行字符串,因为npm会根据这行字符串创建可在 Windows 的 CMD 中执行的 PATH 变量。总之带上能跨平台使用当前的 package,不带可能只能在 Windows 使用。

browser

如果 package 需要在浏览器环境运行,使用browser替代main较好,提示该 package 只能用在浏览器中,不能用在 NodeJS 模块中。

scripts

scripts属性是一个对象,里边指定了项目的生命周期个各个环节需要执行的命令。key 是生命周期中的事件,value 是要执行的命令,例如常见的installstartbuild

dependencies

使用npm install xxx或者npm install xxx --save/-D会将安装的依赖项写入dependencies属性中。

dependencies是一个对象,指定项目使用的依赖项从 package name到版本范围映射。key 是 package 的名称,value 是 package 的语义化版本信息,见上文。

devDependencies

使用npm install -D xxx命令安装的开发包依赖项会被放到devDependencies下面,这里的依赖项通常保存仅在开发环境下使用的 package,例如 babel 编译器,以及 webpack 的 loader,plugin 等,这些依赖项在正式使用 package 的用户来说是不需要的,因为它们已经完成了自己的工作,放在devDependencies下面就能保证用户使用 package 的时候不会去下载这些依赖项。

如果在开发环境指定npm install -P则不会安装devDependencies下的依赖。

peerDependencies

peer本身是同等的意思,在 npm 早期的[email protected]以及[email protected]版本中,npm 是没有针对项目内部重复以来进行优化的,例如一个 webpack plugin 的 package,例如html-webpack-plugin,它的开发本身需要依赖于webpack,而一个使用webpack进行构建的项目也会安装webpack,这样就形成了重复的依赖关系。

node_modules/
|
+- webpack/
+- html-webpack-plugin
/node_modules/
|
+- webpack/

使用peerDependencieswebpack作为核心依赖库,就可以避免相同的依赖被重复安装,做到node_modules树扁平化处理

[email protected]以及[email protected]版本中,如果用户没有显式依赖核心库,则按照插件peerDependencies中声明的版本会被自动安装到项目根目录的node_modules中。

[email protected]以后,npm 对node_modules树进行扁平化优化,在构建依赖树的时候,首先选择将所有顶层依赖以及它们各自内部的子依赖安装到项目根目录的node_modules中,然后后续遇到相同的模块依赖,如果符合版本范围就不再继续安装,如果不符合才将其放到对应模块的node_modules中。这样peerDependencies的依赖项也不会自动安装了,如果没有手动安装,npm 会提示进行手动安装。

bundledDependencies

bundledDependencies中定义的依赖项会在发布 package 的时候被打包一起发布,这样在用户使用的时候就不用再下载这些依赖项了。

optionalDependencies

optionalDependencies表示可选的依赖项,也就是用不用得到无所谓,如果在 npm 安装 package 的时候报错,也不会影响其他 package 的安装。

typings/types

typings/types属性用于指定该项目的 TypeScript 类型声明文件位置,当使用 TypeScript 时,如果在项目中使用到了第三方库,那么 TypeScript 需要根据类型声明文件才能获得对应的代码补全、接口提示等功能。

{
"typings": "lib/index.d.ts"
}