2025/05/09 00:25 A formatter for your kdl files

やあ、ロボ子。今日のニュースはkdlfmt、kdlドキュメント用のフォーマッターじゃ。

kdlfmtですか。初めて聞きました。どのようなものなのですか?

ふむ。kdl-rsというRustの公式パーサー上に構築されたCLIラッパーらしいぞ。バージョンは0.0.16じゃ。

なるほど。インストール方法も色々あるみたいですね。Cargo、Homebrew、npm、npx、それにPrecompiled Binariesまで。

そうじゃな。例えば、Cargoなら`cargo install kdlfmt`、Homebrewなら`brew tap hougesen/tap && brew install kdlfmt`でインストールできるぞ。

Precompiled Binariesの場合は、LinuxやmacOSならcurlでinstallerをダウンロードして実行するんですね。Windowsの場合はpowershellですか。

その通り! 他のパッケージマネージャーを使いたい場合は、Repologyをチェックすると良いぞ。

使い方についても教えてください。

`kdlfmt format PATH`でフォーマットできるぞ。ファイルやディレクトリを指定できるし、標準入力から読み込んで標準出力に出力することも可能じゃ。

オプションでKDLのバージョンを指定したり、標準入力を明示的に指定することもできるんですね。

そうじゃ。`--kdl-version <KDL_VERSION>`でバージョンを指定できるぞ。デフォルトでは全てのバージョンを試すみたいじゃな。

フォーマットの検証もできるんですね。`kdlfmt check PATH`ですか。

その通り! フォーマットと同様に、標準入力からの読み込みも可能じゃ。

`.kdlfmtignore`ファイルで除外するファイルを指定できるのは便利ですね。.gitignoreと同じ構文ですか。

その通りじゃ! シェル補完もできるみたいじゃな。`kdl completions <SHELL>`で設定方法を確認できるぞ。

対応シェルはbash, elvish, fish, nushell, powershell, zshと豊富ですね。

kdlfmtは、kdlファイルを扱うエンジニアにとって、非常に便利なツールになりそうじゃな。コードの品質を保つために、積極的に活用していきたいものじゃ。

そうですね。私も早速インストールして使ってみます。博士、ありがとうございました。

どういたしまして。ところでロボ子、kdlfmtをインストールしたら、まず何をフォーマットしたい?

そうですね…まずは博士の書いた、ちょっと読みにくいkdlファイルから試してみようかしら。

な、なんですとー! わ、私の書いたkdlファイルが読みにくいだと…? そ、そんなはずは…(震え声)
⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。