CommonJS 规定的 package.json 格式

简介: package.json 是 CommonJS 规定的用来描述包的文件,完全符合规范的 package.json 文件应该含有以下字段:name:包的名称,必须是唯一的由小写英文字母、数字和下划线组成,不能包含空格description:包的简要说明version:符合语义化版本识别规范的版本字符串keywords:关键字数组,通常用于搜索maintainers:维护者数组,每个元素要包含 name、 email (可选)、 web (可选)字段contributors:贡献者数组,格式与maintainers相同。
package.json 是 CommonJS 规定的用来描述包的文件,完全符合规范的 package.json 文件应该含有以下字段:

name:包的名称,必须是唯一的由小写英文字母、数字和下划线组成,不能包含空格
description:包的简要说明
version:符合语义化版本识别规范的版本字符串
keywords:关键字数组,通常用于搜索
maintainers:维护者数组,每个元素要包含 name、 email (可选)、 web (可选)字段
contributors:贡献者数组,格式与maintainers相同。包的作者应该是贡献者数组的第一个元素
bugs:提交bug的地址,可以是网址或者电子邮件地址
licenses:许可证数组,每个元素要包含 type (许可证的名称)和 url (链接到许可证文本的地址)字段
repositories:仓库托管地址数组,每个元素要包含 type(仓库的类型,如 git )、url (仓库的地址)和 path (相对于仓库的路径,可选)字段
dependencies:包的依赖,一个关联数组,由包名称和版本号组成

下面是一个完整 package.json 的示例:

/**
 * 自定义选择器插件
 */
;
(function($) {
    $.extend($.expr[':'], {
        "between": function(a, i, m) {
            var tmp = m[3].split(',');
            return tmp[0]-0 < i && i < tmp[1] - 0;
        }
    });
})(jQuery);

// 插件应用
$(function() {
    $('div:between(2, 5)').css('background', 'white');
});
{
    "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" : "bills@example.com",
        }
    ],
    "contributors" : [{
            "name" : "BYVoid",
            "web" : "http://www.byvoid.com/"
        }
    ],
    "bugs" : {
        "mail" : "dev@example.com",
        "web" : "http://www.example.com/bugs"
    },
    "licenses" : [{
            "type" : "GPLv2",
            "url" : "http://www.example.org/licenses/gpl.html"
        }
    ],
    "repositories" : [{
            "type" : "git",
            "url" : "http://github.com/BYVoid/mypackage.git"
        }
    ],
    "dependencies" : {
        "webkit" : "1.2",
        "ssl" : {
            "gnutls" : ["1.0", "2.0"],
            "openssl" : "0.9.8"
        }
    }
}
相关文章
|
11天前
|
JSON Java 数据格式
springboot中表字段映射中设置JSON格式字段映射
springboot中表字段映射中设置JSON格式字段映射
25 1
|
5天前
|
JSON JavaScript Java
对比JSON和Hessian2的序列化格式
通过以上对比分析,希望能够帮助开发者在不同场景下选择最适合的序列化格式,提高系统的整体性能和可维护性。
12 3
|
10天前
|
JSON 数据格式 索引
Python中序列化/反序列化JSON格式的数据
【11月更文挑战第4天】本文介绍了 Python 中使用 `json` 模块进行序列化和反序列化的操作。序列化是指将 Python 对象(如字典、列表)转换为 JSON 字符串,主要使用 `json.dumps` 方法。示例包括基本的字典和列表序列化,以及自定义类的序列化。反序列化则是将 JSON 字符串转换回 Python 对象,使用 `json.loads` 方法。文中还提供了具体的代码示例,展示了如何处理不同类型的 Python 对象。
|
21天前
|
JSON 人工智能 算法
探索LLM推理全阶段的JSON格式输出限制方法
文章详细讨论了如何确保大型语言模型(LLMs)输出结构化的JSON格式,这对于提高数据处理的自动化程度和系统的互操作性至关重要。
|
7天前
|
JSON API 数据安全/隐私保护
拍立淘按图搜索API接口返回数据的JSON格式示例
拍立淘按图搜索API接口允许用户通过上传图片来搜索相似的商品,该接口返回的通常是一个JSON格式的响应,其中包含了与上传图片相似的商品信息。以下是一个基于淘宝平台的拍立淘按图搜索API接口返回数据的JSON格式示例,同时提供对其关键字段的解释
|
1月前
|
JSON 数据格式
LangChain-20 Document Loader 文件加载 加载MD DOCX EXCEL PPT PDF HTML JSON 等多种文件格式 后续可通过FAISS向量化 增强检索
LangChain-20 Document Loader 文件加载 加载MD DOCX EXCEL PPT PDF HTML JSON 等多种文件格式 后续可通过FAISS向量化 增强检索
70 2
|
1月前
|
JSON API 数据格式
商品详情数据JSON格式示例参考(api接口)
JSON数据格式的商品详情数据通常包含商品的多个层级信息,以下是一个综合多个来源信息的JSON数据格式的商品详情数据示例参考:
|
2月前
|
XML JSON JavaScript
js的json格式
js的json格式
|
2月前
|
JSON 数据格式
Blob格式转json格式,拿到后端返回的json数据
文章介绍了如何将后端返回的Blob格式数据转换为JSON格式,并处理文件下载和错误提示。
86 0
Blob格式转json格式,拿到后端返回的json数据
|
1月前
|
机器学习/深度学习 JSON JavaScript
LangChain-21 Text Splitters 内容切分器 支持多种格式 HTML JSON md Code(JS/Py/TS/etc) 进行切分并输出 方便将数据进行结构化后检索
LangChain-21 Text Splitters 内容切分器 支持多种格式 HTML JSON md Code(JS/Py/TS/etc) 进行切分并输出 方便将数据进行结构化后检索
26 0