文学编程工具 weave 与 tangle 的缺失功能及解决方案探讨
来源标题:Missing Tools of Literate Programming
文章指出文学编程的 weave 和 tangle 两个工具存在未解决的问题,并提出相应方案。tangle 生成代码编译报错时只给出生成文件的行号而非源 .lit 文件位置,作者建议让 tangle 生成 sourcemap 来映射两边的行位置。作者还建议增加一个「absorb」程序,借助 sourcemap 把对生成文件的修改写回 .lit,避免下次 tangle 时丢失修复。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
2026年11月14日。阅读约需3分钟。
Literate programming 有两个工具:weave 和 tangle。weave 接收 literate 程序 a.lit,生成 a.pdf 或 a.html,其目标是便于人类理解。tangle 以 a.lit 为输入,输出 a.py 或 b.c 等可供计算机执行的程序。
以下是 weave 和 tangle 尚未解决的一些问题,我也提出相应的解决方案。
首先,你用 tangle 生成程序 a.go,但它有错误。编译器指出错误位于 a.go:20,这是 a.go 中的位置,编译器不会给出 a.lit 中的位置。我们可以让 tangle 在构建 a.go 时生成 sourcemap。这个 sourcemap 能告诉我们 a.go 中的某一行来自 a.lit 的哪里,以及 a.lit 中的某一行最终落到了 a.go 的哪里。
如果你现在修复了 a.go:20 处的错误,却忘了同步更新 a.lit,那么下次 tangle 时,你在 a.go 中的修复就会丢失。我们可以做一个程序,把对 a.go 文件的修改吸收回 a.lit。它可以利用 sourcemap 把改动放到正确的位置。已有工具能做到这一点,比如 org-babel-detangle。我认为它依赖于在 a.go 中放入一些标记,这虽然可行,但你的队友可能不喜欢源代码里到处是 literate 程序的杂物。我的版本把标记留在源码之外,改用 sourcemap。
现在改动是双向流动的,于是出现了并发修改问题。你可能同时修改了 a.go 和 a.lit,两边的改动可能冲突。我们希望有一个工具能智能地合并它们,并指出需要解决的冲突。
我们可以运行一个 watcher,在文件发生改动时监视并记录日志。然后一个 sync 工具可以利用日志和 sourcemap 进行同步。它还能指出冲突,并像 git 一样让我们逐条挑选改动。
我们可以让 a.go 和 a.lit 始终保持同步,但我觉得这太打扰了(它会在我打字时重写我的文件)。我们也可以用某种 CRDT,但一切都在同一台机器上发生,没必要搞得那么复杂。
你可能喜欢 literate programming,但团队里其他人未必都想这么做。他们还没被说服。而且他们凭什么要被说服呢?他们看不到这么做的理由。他们不用它也照样高效。你有一个庞大的代码库,谁来把这一切都 literate 化?啊哈!现在这可以安排了。我们可以让 AI 把代码库 literate 化。代码是高度可验证的。AI 产出的任何 .lit 在 tangle 后都必须还原出你的代码库,所以代码本身完全没问题。AI 生成的各代码块 literate 摘要可能一般,但你能得到一些概念,为你的 .lit 开发提供一个起点。团队里每个人都可以在共享代码库的同时拥有自己的 .lit 版本。团队唯一需要达成一致的是 tangle 的输出。
现在,我让 Claude 把这些工具真正做出来了。你可以试用。git 仓库在这里:https://github.com/pratikdeoghare/lit。它本身就是一个 literate 程序。它是一个单独的 Go 二进制文件,带有 absorb、sync、watch、weave、tangle 子命令。还有一个给 Claude 用的 skill,用 Python 编写,包含每个工具的脚本。我还没有读过代码或它产出的任何东西。我会试用并审查这些内容。里面还有其他东西,比如在 literate 程序中留洞让 AI 填充,这也是我要求加入的。我认为 lit 文档可以用来给 AI 提供更好、更小的上下文,并像 chain-of-thought prompting 一样从中获得更高质量的输出。但这一点我还没有验证。也可能出现另一种情况:由于代码与其解释、论证紧密交织在一起,偏离和胡扯会更容易被发现。我们也许终究能把理解找回来。
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。