完全符合package.json在CommonJS中的规范

页面导航:首页 > 网络编程 > JavaScript > 完全符合package.json在CommonJS中的规范

完全符合package.json在CommonJS中的规范

来源: 作者: 时间:2016-02-02 09:59 【

众所周知,package json是CommonJS规定的用来描述包的文件,完全符合规范的package json文件应该含有一下字段。name:包的名称,必须是唯一的,由小写英文字母、数字和下划线组成,不能包含

众所周知,package.json是CommonJS规定的用来描述包的文件,完全符合规范的package.json文件应该含有一下字段。

name:包的名称,必须是唯一的,由小写英文字母、数字和下划线组成,不能包含空格。

description:包的简要说明。

version:符合语义化八本识别规范的版本字符串。

keywords:关键字数组,通常用于搜索。

maintainers:维护者数组,每个元素要包含name、email(可选)、web(可选)字段。

contributors:贡献者数组,格式与maintainers相同。包的作者应该是贡献者数组的第一个元素。

bugs:提交bug的地址,可以是网址或者电子邮件地址。

licenses:许可证数组,每个元素要包含type(许可证的名称)和url(链接到许可证文本的地址)字段。

repositories:仓库托管地址数组。每个元素要包含type(许可证的名称)和url(链接到许可证文本的地址)字段。

dependencies:包的依赖,一个关联数组,由包名称和版本组成。


下面是一个完全符合CommonJS规范的package.json示例:

{
	"name":"mypackage",
	"description":"Sample package for CommonJS.This package demonstrates the required elements of a CommonJS package."
	"version":"0.7.0",
	"keywords":[
		"package",
		"example"
	],
	"maintainers":[
		{
			"name":"Bill Smith",
			"email":""
		}
	],
	"contributors":[
		{
			"name":"BYVoid",
			"web":"http://www.byvoid.com"
		}
	],
	"bugs":{
		"mail":"",
		"web":"http://www.example.com/bugs"
	},
	"licenses":[
		{
			"type":"GPLv2",
			"url":"http://www.example.org/licenses/gp1."
		}
	],
	"repositories":[
		{
			"type":"git",
			"url":"http://github.com/BYVoid/mypackage.git"
		}
	],
	"dependencies":{
		"webkit":"1.2",
		"ssl":{
			"gnutls":["1.0","2.0"],
			"openssl":"0.9.8"
		}
	}
}


Tags:

相关文章

    文章评论

    最 近 更 新
    热 点 排 行
    Js与CSS工具
    代码转换工具
    
    <