Note to JSON

English | 简体中文

一个 Obsidian 插件：把 Markdown 笔记的排版规范化或紧凑化，把 JSON 美化成可读结构或压缩成一行。

纯本地运行，零网络请求，零运行时依赖。

功能

四条命令，全部可在「设置 → 快捷键」中搜索 Note to JSON 重新绑定：

• 编辑器右键菜单里还有「格式化 JSON」「压缩 JSON」两项，与命令行为一致。
• 有选区时只处理选区；无选区时处理整篇文档。
• 所有写回都是单次 editor.transaction，Ctrl+Z 一步回滚。

安装

手动安装：

1. 执行 npm install && npm run build 生成 main.js。
2. 把 manifest.json、main.js、versions.json 复制到 <你的仓库>/.obsidian/plugins/note-to-json/。
3. 重启 Obsidian，在「设置 → 第三方插件」中启用 Note to JSON。

Markdown 格式化规则（F1–F11）

Markdown 简化规则（S1–S5）

简化不会合并段落：段落之间的空行保留，避免两段被渲染成一段。

保护区

以下内容在任何规则下都逐字节不变：

• YAML frontmatter（首行 --- 到闭合 ---）
• 围栏代码块（``` / ~~~，按标记长度配对）
• $$ 数学块
• HTML 注释块
• 行内代码、[[wikilink]]、![[嵌入]]、![](图片)、URL

选区上方的内容会参与状态分析，因此从代码块中间开始选中也不会误把代码当正文改。

JSON 格式化与压缩

保真

格式化不经过 JSON.stringify(JSON.parse(x), null, 2)，而是只重排 token 之间的空白，字面量按原文输出：

空容器 {} / [] 保持一行；CRLF 文档写回仍是 CRLF。

非常规空白归一化

从网页、聊天工具或 Excel 复制来的 JSON 常在缩进里混入全角空格（U+3000）、不换行空格（U+00A0）、EM SPACE（U+2003）、零宽空格或 BOM。JSON 规范只认半角空格、Tab、LF、CR，这些字符会让解析失败，但报错片段看起来完全正常。

插件会在字符串字面量之外把这些字符归一化为半角空格，字符串内部一个字符都不改，成功后提示「已修正 N 处全角/特殊空白」。

严格校验

注释、尾逗号、单引号、NaN 一律判为非法：弹出提示「JSON 语法错误（第 N 行第 M 列：片段），已保持原样」，文档不做任何写回。片段中的不可见字符会显示为 ⟨U+0001⟩ 形式，便于定位。

已知取舍

• 美化后首行顶格，原本缩进在列表项里的 JSON 不还原层级。
• 不支持键名排序、图形化树视图、JSON5/JSONC。
• 无选区且整篇是笔记正文时会报错，需先选中 JSON 片段。

设置项

已知局限

1. 中文等宽字符按 1 个字符计算，纯中文表格在等宽字体下竖线不完全视觉对齐。
2. 引用块内的表格（> | a | b |）不参与对齐与空行规范。
3. #标签 与 #标题 语法上无法区分，插件选择保守不动。
4. 规则会增删空行，写回后光标停留在原行号（保留列位置），可能偏移一两行。
5. 列表项内以 4 空格缩进书写的围栏（ ```js）不被识别为保护区。
6. 单次处理上限 2 MB，超过则跳过。

开发

npm install     # 安装依赖
npm run dev     # 监听模式，改动即编译
npm run build   # 类型检查 + 生产构建，产出 main.js

main.js 是构建产物，已在 .gitignore 中排除，不随源码提交。

目录结构

manifest.json          # 插件清单（id: note-to-json）
versions.json          # 版本 → 最低 Obsidian 版本
esbuild.config.mjs     # 打包配置
tsconfig.json
src/
  main.ts              # 插件入口：命令注册、右键菜单、默认热键
  settings.ts          # 设置类型与默认值
  settingsTab.ts       # 设置面板
  core/
    text.ts            # 行工具与行内占位符保护
    segment.ts         # 保护区状态机
    rules.ts           # 格式化规则 F1–F11
    compact.ts         # 简化规则 S1–S5
    pipeline.ts        # 规则管线
    json.ts            # JSON 校验与 tokenizer 重排

技术栈

• TypeScript 7 + esbuild，obsidian 作为 external
• 不引入运行时依赖，不打网络请求
• 行级状态机 + 规则管线，不使用 AST 序列化（避免改写 wikilink、callout、注释）

License

ISC