NPM Package.json 字段列表(包括非官方字段)

tech2022-09-25  100

得空看看一些源码,发现 Package.json 文档里有些字段是不常见的,自然也不知道配置的是什么,查官方文档, 发现有些找不到,看到一篇不错的英文文档,翻译一下,以后好查看。

一、基本字段

1、name

自如其名,不多加解释,这个字段的使用需要注意一下几个要点

(1) 若项目是要作为包发布到 npm 上的话,需要是独一无二的名字

(2) 若要发布的包隶属于某个机构或者私有仓库,需要在前面加上@组织名称,比如这样, @ebag/exp-ui

(3) 名称总字符长度不能超过 214

(4) 不能以大写字母、斜划线或者点开头

(5) 只能使用 url 安全字符,因为我们的名称可能会被别人在终端使用,比如: npm i lyp-pagination 或者 ‘https://www.npmjs.com/package/lyp-pagination’

2、version

version 跟 name 组成已发布包的每个版本唯一ID, 这就意味着,我们每发布一个版本就需要更新一下版本号。此外,版本号应该有一个固定的可以让 node-semver 解析的结构,比如我们常见的 npm 包版本号都是由三个被点分隔的数字组成,比如这样: 1.1.2, 有些包可能后面还接一个可选的标签,比如这样: 1.1.2-alphal。这路需要注意,不应该给版本降级,特别是当包已经被广泛使用的时候。

二、信息类字段

最新回复(0)