SuperAPI AI 工具集

lint

办公与效率

查看项目

更新于 10-30 16:21

技能介绍

用途

lint 是 Obsidian 库的完整性巡检技能,属于规则执行类工具。它以 CONVENTIONS.md 作为唯一的规则权威,对已有笔记做回溯性合规检查;写入类技能负责在写入时正向执行同一套规则。由于规则以散文(自然语言)形式书写而 lint 由大模型驱动,规则可直接执行:在 CONVENTIONS.md 中修改一条规则,再运行 /lint,库便会按新规则重新符合规范。

前置条件

运行前先读取 ~/Obsidian/CONVENTIONS.md 与 ~/Obsidian/CONTEXT.md。若 ~/Obsidian/ 不存在,则停止执行。

主要能力(按巡检顺序)

lint 按 CONVENTIONS.md 中的规则清单(R1–R8)逐条执行,大致顺序如下:

  1. Class A 与杂物(R0/R8):扫描密钥、凭据、客户个人身份信息与财务数据、逐字照搬的专有源码,以及 Untitled.* 等遗留脚手架文件。此项优先级最高,泄露在任何规模下都是真实危害。注意:文件路径加提交 SHA 不属于 Class A(属 B-private,可保留);同时检查客户身份是否已化名。移除或编辑前需 [confirm]。

  2. Frontmatter 与类型(R1、R2):Inbox/ 之外的每条笔记都必须具备必需的 frontmatter,type 须在类型词表内。[fix]

  3. 命名(R3)与文件夹(R4):符合各类型的命名规则;文件夹用 Title Case,系统文件用小写。[confirm],参见重命名安全说明。

  4. 归档标记(R5):Archive/ 下的文件须带有 [[Archive]] 与 archived: 标记。[fix]

  5. 索引对账(R6):Library 的 index.md 与磁盘上的文件保持一致。[fix]

  6. 概览精简(R7):Profile/overview.md 控制在其约半页的篇幅预算内。[confirm]

修复纪律

标记为 [fix] 的规则自动应用;标记为 [confirm] 的规则会批量提出并等待批准。当某条规则属于需要主观判断的情况时,默认只标记问题而不直接改写。

重命名安全:重命名会破坏所有指向旧名称的 [[wikilink]]。绝不静默重命名,流程为提议、确认,然后原子化地重命名文件并改写所有反向链接。这是唯一不适用“像 eslint --fix 那样直接修”的地方。

巡检之后

报告哪些问题已自动修复、哪些需要人工决策。对有改动的 Library 追加 log.md 记录,格式为:## [YYYY-MM-DD] lint | <摘要>。

适用场景

适用于维护 Obsidian 笔记库的规范一致性:定期清洗泄密与杂物文件、补齐 frontmatter 与类型、统一命名与目录结构、校验归档标记、对齐索引与磁盘内容、控制概览页篇幅。也适用于调整 CONVENTIONS.md 规则后对全库重新合规。

相关技能

/inbox、/ingest 负责正向执行 CONVENTIONS.md;CONVENTIONS.md 是 lint 读取的规则来源。

限制

规则内容依赖 CONVENTIONS.md 的实际定义;lint 由大模型驱动,判断类规则可能只标记而不改写;重命名需人工确认;运行要求 ~/Obsidian/ 目录存在。资料未提供具体的安装步骤、收费、平台支持或性能指标。