npm packsages.json(2)| 青训营笔记

101 阅读2分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 16 天

接着学习packzges的配置详解

name

packages中比较重要的字段,name是包的名字,他在url之中使用,以及在node_module中的包名。 它的命名是要遵循如下几个规则:

1.新包的名称必须小于或等于214个字符。

2.新包的名称不得包含大写字母。

3.报的名称可以以点(.)或者下划线(_) 开头。

4.该名称最终成为 URL 的一部分,命令行上的参数, 和文件夹名称。因此,名称不能包含任何非 URL 安全 字符。

version

version是包的版本。它就上name字段共同构成一个独一无二标识符。如果项目要发布的话,必须配置name和version。

Description

帮助使用者了解包的功能,包管理器也会把这个字符串作为搜索关键字。 写法如下:

Description”:“报的功能”

keywords

将关键字放入其中,它是一个字符串数组。这有助人们发现你的软件包。

license

许可证。所有包都应该添加许可证,以便用户知道他们在什么授权下使用的包。 写法:

 "license" : "ISc" 

一般的话是ISC授权。

人员字段:作者(author),参与者(contributors)

写法:

"name" : "Barney Rubble", "email" : "b@rubble.com", "url" : "http://barnyrubble.tumblr.com/" 

或者是下面这种写法:

"author": "Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)" 

files

指定包含在项目中的文件,无论设置如何始终包含一些文件。

main

项目的入口文件,当一个包被别的包依赖的时候,那么别的包依赖这个包时,会自动引用main中的入口文件,如果没有设置,node.js会默认index.js为入口文件。 写法:

“main”:“sas.js

bin

随着项目一起被安装的可执行项目。写法:

"bin": {
"my-app-cli": "./bin/cli.js";
}

第一个字段是命令字段,第二个字段是本地文件。全局安装此包时该文件将在全局bins目录中链接。

private

定义私有模块。npm拒绝发布private字段的包,通过设置该字段,防止包无意中发布。 写法

“private”:true