#docs #pattern #sed #search-pattern #cli-tool #rust-doc

bin+lib STKLR

STKLR:发音为 'stickler'。是一个命令行工具,用于自动在 rust-doc 文档字符串中链接函数、枚举、结构体、特质等。在我需要的时候找不到这样的工具,所以……就这样出现了。

2 个版本

0.0.42 2022 年 10 月 12 日
0.0.41 2022 年 10 月 7 日

#1414文本处理

每月 24 次下载

MIT 许可证

27KB
577

   _____ _______ _  ___      _____  
  / ____|__   __| |/ / |    |  __ \ 
 | (___    | |  | ' /| |    | |__) |
  \___ \   | |  |  < | |    |  _  / 
  ____) |  | |  | . \| |____| | \ \ 
 |_____/   |_|  |_|\_\______|_|  \_\
                                    
                                    

发音为 'stickler'。

摘要

我最喜欢的 rust-doc(从 Rust 代码库中的特定类型的文档字符串自动生成文档的工具)的功能是关键字链接。我最不喜欢的 rust-doc 功能是尝试记住进行这种链接,或者通常在特定工具中编辑 markdown(rust-doc 实际上生成的),因为,我通常在特定工具中编辑 markdown。

所以,我制作了一个为我做这件事的工具——如果你也像我一样,也许它不仅能给你带来快乐,还能提高你包文档的质量。

安装

  • cargoinstall --githttps://github.com/alphastrata/stklr

注意:此应用程序最多为测试版,是工作进展中。

使用方法

在使用此工具之前备份您的代码库,使用源代码控制。

  • stklr # 显示帮助菜单。
  • stklr preview # 显示它想要做出的更改,更改用绿色表示,源文件和行号等都在那里。
  • stklr fix# 在您在上面的预览中看到的所有文件上做出更改,带有 preview

错误

  • 在问题/PR 中创建——包括使它偏离文本。

贡献

  • 尚未。

更多发布平台等

  • 以后,不在测试阶段。

依赖项

~5–7MB
~112K SLoC