HackerNews中文版

文档会出现偏差。README.md 中的示例可能与实现不再匹配，而持续集成（CI）通常不会注意到这一点。我开发了 doksnet，这是一个小型的 Rust 命令行工具，它可以将文档部分与代码片段链接起来，并通过 Blake3 哈希值验证两者是否保持同步。你可以定义如下的映射：• README.md:15-25• src/lib.rs:40-65doksnet 将这些范围及其哈希值存储在一个紧凑的 .doks 文件中。doksnet test 会重新提取内容，如果有任何变化（包括空格），则会失败（退出代码 1）。基本流程：• doksnet new – 初始化• doksnet add – 创建文档 ↔ 代码映射（交互式）• doksnet test – CI 安全验证• doksnet test-interactive – 审查/修复不匹配它是本地仓库的，不依赖外部服务，也没有解析/抽象语法树魔法——仅仅是确定性的文本提取和哈希。如果你想在 CI 中强制同步，还有一个 GitHub Action。仓库： <a href="https://github.com/Pulko/doksnet" rel="nofollow">https://github.com/Pulko/doksnet</a> 安装：cargo install doksnet 网站： <a href="https://doksnet.pulko-app.com" rel="nofollow">https://doksnet.pulko-app.com</a>希望能收到对这种方法的反馈——特别是这个工具是否能比“根据新变化重写所有 README，确保没有错误”更有用，尤其是在 AI 使用受到限制的环境中。

查看原文

Docs drift. Examples in README.md stop matching the implementation. CI usually doesn’t notice.I built doksnet, a small Rust CLI that lets you link a documentation section to a code snippet and verify that both sides stay in sync using Blake3 hashes.You define mappings like:• README.md:15-25• src/lib.rs:40-65doksnet stores the ranges + their hashes in a compact .doks file. doksnet test re-extracts the content and fails (exit code 1) if anything changed — including whitespace.Basic flow:• doksnet new – initialize• doksnet add – create doc ↔ code mapping (interactive)• doksnet test – CI-safe verification• doksnet test-interactive – review/fix mismatchesIt’s repo-local, no external service, no parsing/AST magic — just deterministic text extraction + hashing.There’s also a GitHub Action if you want to enforce sync in CI.Repo: <a href="https://github.com/Pulko/doksnet" rel="nofollow">https://github.com/Pulko/doksnet</a> Install: cargo install doksnet Web: <a href="https://doksnet.pulko-app.com" rel="nofollow">https://doksnet.pulko-app.com</a>Interested in feedback on the approach — especially whether this tool could be more useful then “Rewrite all the readme based on new changes. Make no mistakes”, for instance, in environments where AI usage is restricted

展示 HN：Doksnet – 通过哈希验证保持文档与代码同步