mdsf

使用您喜欢的代码格式化工具格式化 Markdown 代码片段。

mdsf 0.2.2
Format markdown code snippets using your favorite code formatters
Mads Hougesen <mads@mhouge.dk>

Usage: mdsf <COMMAND>

Commands:
  format       Run formatters on input files
  verify       Verify files are formatted
  init         Create a new mdsf config
  completions  Generate shell completion
  cache-prune  Remove old caches
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

安装

您可以从 github.com/hougesen/mdsf/releases 直接下载最新版本的 mdsf。

Cargo

使用已发布的 crates 安装

cargo install mdsf --locked

或直接从源代码安装

git clone git@github.com:hougesen/mdsf.git

cargo install --path ./mdsf --bin mdsf

用法

mdsf format <NAME_OF_FOLDER_OR_FOLDER>

Run formatters on input files

Usage: mdsf format [OPTIONS] <PATH>

Arguments:
  <PATH>  Path to file or directory

Options:
      --config <CONFIG>        Path to config
      --debug                  Log stdout and stderr of formatters
      --log-level <LOG_LEVEL>  [possible values: trace, debug, info, warn, error, off]
      --threads <THREADS>      Amount of threads to use. Defaults to 0 (auto)
      --cache                  Only format changed codeblocks
  -h, --help                   Print help
  -V, --version                Print version

验证代码是否已格式化

mdsf verify <NAME_OF_FOLDER_OR_FOLDER>

Verify files are formatted

Usage: mdsf verify [OPTIONS] <PATH>

Arguments:
  <PATH>  Path to file or directory

Options:
      --config <CONFIG>        Path to config
      --debug                  Log stdout and stderr of formatters
      --log-level <LOG_LEVEL>  [possible values: trace, debug, info, warn, error, off]
      --threads <THREADS>      Amount of threads to use. Defaults to 0 (auto)
  -h, --help                   Print help
  -V, --version                Print version

配置

mdsf 的默认配置旨在尽可能合理。因此，每种语言的默认格式化程序是大多数人已经安装的格式化程序。

如果您想自定义要运行的格式化程序，可以运行以下命令创建一个新的 mdsf 配置文件

mdsf init

mdsf 支持在相同的代码片段上运行多个格式化程序。

{
  // Only run `ruff` on Python snippets,
  "python": "ruff",
  // Run `usort` on file and then `black`
  "python": ["usort", "black"],
  // Run `usort`, if that fails run `isort`, finally run `black`
  "python": [["usort", "isort"], "black"]
}

支持的工具

[!NOTE] mdsf 不是一个包管理器。

只有已安装的工具将被使用。

mdsf 目前支持 174 个工具。如果您喜欢的工具缺失，请随时提交 issue/pull-request！ 😃

Shell completions

可以使用以下命令生成 Shell 完整性：mdsf completions <SHELL>。

Generate shell completion

Usage: mdsf completions <SHELL>

Arguments:
  <SHELL>  [possible values: bash, elvish, fish, powershell, zsh]

Options:
  -h, --help     Print help
  -V, --version  Print version

Bash

将以下内容添加到您的 .bashrc。

eval "$(mdsf completions bash)"

Bash

将以下内容添加到您的 .zshrc。

eval "$(mdsf completions zsh)"

Fish

将以下内容添加到 ~/.config/fish/config.fish。

mdsf completions fish | source

PowerShell

将以下内容添加到您的PowerShell配置文件中（可以通过运行 $PROFILE 来找到）。

Invoke-Expression (&mdsf completions powershell)

Elvish

将以下内容添加到 ~/.elvish/rc.elv。

eval (mdsf completions elvish)

致谢

mdsf 受益于惊人的 neovim 格式化插件 conform.nvim。

mdsf 的替代方案

• conform.nvim 使用 injected 模式。
• mdformat.