doccmd

主要观点:介绍了一个名为doccmd的命令行工具,用于对文档文件中的代码块运行命令,如运行 linters、formatters 等工具。
关键信息

  • 提供多种安装方式,包括pip、Homebrew 及预构建的 Linux 二进制文件。
  • 给出了使用doccmd的各种示例,如针对不同语言的代码块运行不同工具。
  • 说明了doccmd可处理多种文件格式,如 reStructuredText、Markdown 等。
  • 介绍了格式化和填充相关内容,包括如何处理工具与填充的兼容性及相关命令选项。
  • 提及文件命名和 linter 忽略相关事宜,如创建临时文件及在 linter 配置中忽略文件。
  • 提供了相关参考文档的链接,涵盖安装、使用示例、命令等多个方面。
    重要细节
  • pip安装需 Python 3.11+,Homebrew安装需先安装Homebrew
  • 使用doccmd作为pre-commit钩子时的配置示例。
  • doccmd通过添加填充来为运行命令提供带有行号的错误和警告信息,可使用特定命令选项去除填充。
  • 临时文件创建在与文档文件相同的目录,文件名包含文档文件名和代码块行号等信息,可据此在 linter 配置中忽略文件。
阅读 11
0 条评论