@gerhobbelt/json5

中文文档
2.1.0-48发布于 2019/09/21MITCommonJS近 30 天下载 2.6万

JSON为人类服务.

中文使用文档
文档目录32 节
  1. 为什么
  2. 特征概述
  3. 对象
  4. 阵列
  5. 字符串
  6. 数字
  7. RegExp 实例(和衍生类)
  8. 出错实例(和衍生类别)
  9. 评论
  10. 空白
  11. 简短示例
  12. 规格
  13. 安装
  14. 节点.js
  15. 浏览器
  16. API 密码
  17. JSON5.parse()
  18. JSON5.stringify()
  19. 节点.js require() JSON5 文件
  20. 国 际
  21. 安装
  22. 使用量
  23. 捐款
  24. 发展
  25. 问题
  26. 贡献者
  27. -什么是新的还是不同的?
  28. 许可证
  29. 贷项
  30. 相关材料
  31. 软件包
  32. 文档

JSON5 – 人类的JSON

GitHub Repository npm version Build Status Coverage Status Dependency Status

通知

这个寄存器包含由GerHobbelt维护的叉. 最初的JSON5作品有: json5/json5 (中文(简体) )。 。 。 .

有关所有变化(修正和特征)的概述,见本节 有新的还是不同的? 还见下文.

JSON5数据交换格式(JSON5)是一个超集 贾森 旨在 通过扩大其语法以包括: 一些作品来自: ECMAScript 5.1 (中文(简体) )。 。 。 .

这个JavaScript库是JSON5官方引用执行的衍生工具 解析和序列化库,其中此衍生工具包含一些额外的功能: 这些额外项目在下面的特征列表中以 q 来标示.

为什么

JSON不是最友好的 写入键、对象和 数组不能有后缀逗号, 不允许评论 — 尽管 今天普通JavaScript没有出现这种情况.

JSON的目标是要成为伟大的数据格式 已经扩大 机器JSON现在用于写作 配置, (中文(简体) ), 清单连 测试 - 全部通过 人类。 。 。 .

也有其他形式比较人性友好,如YAML,但改变 从JSON到完全不同的形式在许多情况下是不可取的. JSON5的目标是保持与JSON和JavaScript的相近.

特征概述

以下ECMAScript 5.1功能在JSON中没有支持,具有 已扩展至JSON5.

对象

  • 对象密钥可以是 ECMAScript 5.1 标识符Name。 。 。 .
  • 对象可能有一个单一的后导逗号.

阵列

  • 阵列可能有一个后导逗号.

字符串

注意下文关于增强字符串格式的章节中提到的限制.

数字

  • 数字可能是十六进制.
  • 数字可能有一个先入后出的小数点.
  • 数字可能是 IEEE 754 (英语) 阳性无穷,阴性无穷,而纳能.
  • 数字可以以明确加号开头.

RegExp 实例(和衍生类)

出错实例(和衍生类别)

评论

  • 允许单行和多行评论.

空白

  • 允许添加白空字符 .

简短示例

{
  // comments
  unquoted: 'and you can quote me on that',
  singleQuotes: 'I can use "double quotes" here',
  lineBreaks: "Look, Mom! \
No \\n's!",
  hexadecimal: 0xdecaf,
  leadingDecimalPoint: .8675309, andTrailing: 8675309.,
  positiveSign: +1,
  trailingComma: 'in objects', andIn: ['arrays',],
  "backwardsCompatible": "with JSON",
}

规格

关于JSON5格式的详细解释,请改为: 正式 规格。 。 。 .

安装

节点.js

npm install @gerhobbelt/json5
const JSON5 = require('@gerhobbelt/json5')

浏览器

<script src="https://unpkg.com/@gerhobbelt/[email protected]"></script>

这将建立一个全球 JSON5 变量.

API 密码

JSON5 API 兼容 JSON API (英语)。 。 。 .

JSON5.parse()

解析 JSON5 字符串,构建 JavaScript 值或由 JavaScript 描述的对象 绳子。 可以提供一种可选的复活器功能来进行 在返回之前先在生成对象上转换.

语法

JSON5.parse(text[, reviver])

参数

  • text:要解析为JSON5的字符串.

  • reviver: 如果一个函数, 则该函数将规定由 解析是转换的,在返回之前.

    reviver 调用函数参数 : (key, value)时

    • this: 引用包含密钥/值对的JavaScript对象.
    • key: 代表属性的字符串 value。 。 。 .
    • value: 该数值 this[key] 属性,由JSON5解析.

    这个 reviver() 函数返回函数(可能更改/“活化”) value。 。 。 .

    何时 reviver() 返回时 undefined,属性(this[key])为 删除 从对象.

    解析出 JSON5 对象树的根也传入 reviver() 作为 带有密钥的属性 '' (空字符串),因此允许 reviver() 到后处理 解析出 JSON5 输入的每个部分 .

    请注意: reviver() 作为JSON5 分析的一部分 后处理 从而 当遇到重复密钥时, 无法用于编码交替行为 输入对象或其他解析错误: JSON5 首先进行全解析, 在 引用 reviver() 在每一个再生成的元素上.

返回值

对应给定的JSON5文本的对象.

JSON5.stringify()

将 JavaScript 值转换为 JSON5 字符串,如果是 指定替换器函数,或可选择仅包括指定的 如果指定了替换器阵列,则属性.

语法

JSON5.stringify(value[, replacer[, space[, circularRefHandler]]])
JSON5.stringify(value[, options])

参数

  • value: 转换为 JSON5 字符串的值.

  • replacer: 改变字符串化行为的函数 进程,或用作白名单的字符串和数字对象数组 用于选择/过滤要包含的值对象的属性 jSON5弦乐 如果该值无效或不提供,则该值的所有属性 对象包含在产生的 JSON5 字符串中.

  • space: 用于将空白插入到 为可读性目的输出 JSON5 字符串。 如果这是一个数字,它 表示要用作白空格的空格字符数; 此数字是 上限为10(如果大于10,则数值仅为10)。 数值小于1 表示不应使用空格。 如果这是字符串,则字符串(或 字符串的前10个字符,如果更长)作为白色使用 空间。 如果未提供此参数( 或为无效) , 则不使用空白 . 如果使用白色空间,在对象和阵列中会使用后缀逗号.

  • circularRefHandler: QQ 为每个元素引用的回调函数 否则会造成 JSON5.stringify() 丢出一个 "converting circular structure to JSON5" 类型错误 除外.

    回调返回取而代之的字符串值 。 当此值 恰好包含循环引用本身,然后会被检测到 以 JSON5.stringify() 编码为 '[!circular ref inside circularRefHandler!]' 取而代之的是字符串值.

    回调函数参数 : (value, circusPos, stack, keyStack, key, err)时

    • value: 循环参考值.
    • circusPos编号: stack[] 财务报告和审定财务报表 keyStack[] 数组,表示 引用的父对象 value 循环参考值.
    • stack: 用于此值的家长堆栈(对象,阵列)。 第一个条目 (指数 0) 是根 value。数组是一个快照(shallow clone),以确保 用户代码可以简单地直接存储此引用值 不冒险 JSON5 - 内部关闭问题,在我们不提供时会产生 带快照的你。 。 。 .
    • '键盘' : 用于描述路径的密钥堆栈, 每个父键一个 根的违法循环参考值 value 下来。 第一个条目 (指数 0) 是根 value。当您想要显示诊断时有用 它在根值中列出通过对象等级的正向路径 参考文件 value 例如,在手边.
      阵列是快照( shallow clone) 以确保 用户代码可以简单地直接存储此引用值 不冒险 JSON5 - 内部关闭问题,在我们不提供时会产生 带快照的你。 。 。 .
    • key: 当前直接父密钥 value。与 keyStack[keyStack.length - 1]。 。 。 .
    • err: 类型错误 JSON5.stringify():在这里提供,所以你 用户定义的回调码可以舍弃以丢弃循环引用错误 无论如何.
  • options: 具有下列属性的对象:

    • replacer: 与 replacer 参数.
    • space: 与 space 参数.
    • quote: 表示序列化时要使用的引用字符串 字符串。 在未明确指明的情况下,JSON5将用弹性方式确定 每个字符串值的引用以最小化字符数 逃出(从而将输出大小最小化).
    • circularRefHandler: QQ 为每个元素引用的回调函数 否则会造成 JSON5.stringify() 丢出一个 "converting circular structure to JSON5" 类型错误 除外。 见 circularRefHandler 关于更多信息的上述参数描述.
    • noES6StringOutput: qq 当设定为 true (或有真实价值) JSON5.stringify() 将不会输出 (''''''') backtick-encoded ES6 字符串字符串; 相反, 字符串将用 JSON5 标准输出 单引出或双引出字符串值。 您可以设置此选项为 输出将与其他标准 JSON5 阅读器相容的 JSON5 文件 .

返回值

代表值的 JSON5 字符串 .

节点.js require() JSON5 文件

当使用Node.js时,你可以 require() JSON5 通过添加以下文件 语句.

require('json5/lib/register')

然后,你可以加载 JSON5 文件与节点.js require() 语句。 对于 示例:

const config = require('./config.json5')

页:1这当然是假设 required JSON5 文件不包含“ heredoc” 格式化 字符串内容 !

国 际

由于JSON比JSON5被更广泛使用,此包包括用于 将 JSON5 转换为 JSON5 并用于验证 JSON5 文档的语法.

安装

npm install --global @gerhobbelt/json5

使用量

json5 [options] <file>

若为 <file> 不提供,则使用STDIN.

选项 :

  • -s, (中文(简体) ), --space: 缩进或缩进的空格数 t 标签
  • -o, (中文(简体) ), --out-file [file]: 输出到指定文件, 否则为 STDOUT 。 (如果 - 以 file 名称,使用STOUT。 )
  • -v, (中文(简体) ), --validate: 验证 JSON5 但不输出 JSON
  • -V, (中文(简体) ), --version: 输出版本编号
  • -h, (中文(简体) ), --help: 产出使用信息

捐款

发展

git clone https://github.com/GerHobbelt/json5
cd json5
npm install

输入代码时, 请写相关的测试并运行 npm test 财务报告和审定财务报表 npm run lint 在提交拉动请求之前。 请使用支持的编辑器 编辑器配置。 。 。 .

问题

报告错误或请求JSON5数据格式的特性,请 将问题提交 正式规格 仓库。 。 。 .

报告错误或请求 JavaScript 执行的特性 JSON5 请向这个寄存器提交一个问题.

贡献者

巨头

-什么是新的还是不同的?

以下是一份综合清单,列出与《公约》相比的特征和修正 原文

  • 增加了对 ES2015型 “.”多行字符串模板文字,比如说.

    { str: `multiline
            example
            string value!` 
    }
    

    关于此增强字符串格式的注释数字 :

    • 虽然 模板字面谱 否则,我们仍不支持JSON5中的八分子出逃 ''-delimited *multiline strings*, as these ARE NOT identical to JavaScript 'template strings' as we DO NOT intend to support the ${...} 模板变量扩展功能 !

      这个 多行字符串字符串 方便撰写 JSON5 内容 如果字符串内容跨越多行和/或 包含各种引用字符,从而尽可能减少逃避的必要性 内容.

    • 任何MAC或WINDOWS风格行端被转换为标准的UNIX行端, 即这些转换由JSON5自动完成:

      • CRLF - > 低频
      • CR - > 低频
  • 增加了对 异语字符串 数值, 必须从 << 紧接着有一个标记,例如:. EOT 或者说 其它一些字母标识符,当单独在一行中使用时,会 表示“heredoc”字符串的结尾.

    例如:

    { str: <<EOT
            multiline EOT
            example \n
            string value!
    EOT
    }
    

    将字串编码

            multiline EOT
            example \n
            string value!
    

    即,任何异教内容都不会被视为逃脱! (本节) \n 内 因此读取为 JavaScript 字符串 "\\n". ) (中文(简体) )

    关于此增强字符串格式的注释数字 :

    • 解析此语义值时, 我们必须先提取 EOT 标记 还有 一旦我们做了,我们跳过第一行,开始 扫描/ 消耗性异端文献内容, 直到我们点击线路上的 EOT 标记 单靠自己,就是白空间.

    • 我们接受两个以上(!) < 要标记异端语块开始的字符.

    • 我们接受任何非白空字符序列 作为异端EOT标记.

    • 根据惯例,我们不接受EOT之前的“格式化白空间/缩进” 标记在同一行.

      这个 内容 (一) 首个CR/LF之后开始的格言; 我们不会容忍 追随白空间 或任何其他十字架 跟随EOT标记!

    • JSON5扫描一个孤独的异教 EOT 标记以终止字符串内容; 直到我们找到一个, 一切都是字串的内容.

    • 文中的内容 DOES NOT 处理出局序列 : 一切都以-is方式传递 !

    • 内容 ENDS 在此之前 单 EOT 标记之前的最后一个 CR/LF; 即 EOT 标记必须存在 在一条线本身, 没有任何前行或后行的白色空间.

    • 如果JSON5字段后面是更多的数据,则分隔符(comma,括号, 必须存在于线上 过去 eOT 标记行: EOT 必须是 里面有明显的"孤"字,例如:

      { str: <<EOT
      multiline EOT
      example \n
      string value!
      EOT
      , extra: 42
      }
      
    • CR / CRLF / LF MAC / Windows/UNIX行在内容中结尾为"不转换".

      这不同于上述“多线字符串字元”类型, 中,所有行尾自动转换为 UNIX 样式 “\n”. 因此,人们可以认为,本文献是: 二进制数据 格式.

  • 🎷🍓 JSON5.stringify() 带着一个 第四届 参数:可选的回调方法 中每个值将被引用的字符串 a “周期性引用”错误另投.

    用户指定的调用可以提供替代值来代为编码 或最终丢弃错误例外.

    另见上文API文件.

  • QQ 复制对象中相同的密钥, 在解析 JSON5 输入时引起语法错误 . (例如,当您提供手动编辑的 JSON5 内容时,就可能发生这种情况) 改为 JSON5.parse() 或处理 JSON5 内容时( 不正确) 由任意文本 diff/ patch 工具合并. )

许可证

麻省理工学院. 见 利比里亚 页:1 细节.

贷项

刺杀基肖尔 创建了这个项目.

迈克尔·博林 独立抵达并公布 这些想法中有一些 有着惊人的解释和细节。 建议 读取 : 建议改进JSON

道格拉斯克罗克福德 设计并建造 JSON 但他的状态机器图上 JSON网站,作为 虽然听起来很俗气,但给了我们动力和信心,让我们相信建立一个新的 执行这些想法的策略已经可以实现! 原画 jSON5的应用也直接从道格的开源软件中模拟出来 json parse.js par. 我们感谢那个干净和有记录的 代码.

马克思·纳纳西 已经是一个早期和丰富的 支持者,贡献多块补丁和想法.

安德鲁·艾森伯格 提供原件 stringify 方法.

约旦 塔克 jSON5 已更紧密地对齐 与ES5,写了JSON5的官方规格, 完全重写了 正在积极维护这个项目.

讨论试图解决同一问题的材料包和文件 或非常类似的问题:

机器可读(和-可写)结构数据 这对人类来说是容易的 读取 财务报告和审定财务报表 写入。 。 。 .

软件包

文档

版本与发布记录

@gerhobbelt/json5 共发布 28 个版本,首次发布于 2017/08/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.1.0-48latest2019/09/217 年前
2.1.0-472019/09/217 年前
2.1.0-462019/06/157 年前
2.1.0-452019/06/157 年前
2.1.0-442019/06/157 年前
2.1.0-432019/06/157 年前

关于 @gerhobbelt/json5 的常见问题

@gerhobbelt/json5 是什么?

JSON为人类服务.

如何安装 @gerhobbelt/json5?

在项目目录运行 npm install @gerhobbelt/json5,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 json5,可以用 npx json5 直接运行。

@gerhobbelt/json5 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gerhobbelt__json5 是否存在。

@gerhobbelt/json5 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gerhobbelt/json5 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=8。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gerhobbelt/json5 可以商用吗?

@gerhobbelt/json5 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gerhobbelt/json5 的下载量有多少?

根据 npm 官方下载统计,@gerhobbelt/json5 在 2026/10/16 – 2026/11/14 这 30 天内被下载 26,036 次,日均约 868 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gerhobbelt/json5 还在维护吗?

最新版本 2.1.0-48 发布于 2019/09/21(7 年前);至今共发布 28 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/08/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。