Tsukutta
DocsAuditor - スクリーンショット

DocsAuditor

仕様書とソースコードの整合性チェック用VSCode対応拡張機能

業務効率化ツール
今週 1人が使いました
401

Y
Yuzuko Underson

公開日2026年6月14日
カテゴリ業務効率化ツール

アプリの説明

私が、アプリなどの開発中にAIに作らせる「変数関数仕様書」が実際にあっているのかを確認する用途で作った、VSCode拡張機能です。VSCodeだけではなく、VSIXという形式で拡張機能をインストールできるIDEでは基本的には使うことが出来るはずです。今回試験的にHFSM(階層型有限状態機械)を使って作成しました。

tree-sitterを使用したASTを用いて、仕様書内にある変数関数が実際のソースコードで使用されているのか(あるいはその逆)の確認や、どこからも呼び出されていない無駄な変数関数の通知、依存関係マッピングの整合性のチェックなどを行います。

対応するプログラミング言語は、
Rust, TypeScript, JavaScript, Python, Go, C, C++, C#, Ruby, Swift, Kotlin, Javaです。見出し3(###)の後にある関数名などを探し、該当する行数や整合性チェックなどを行っています。
また、何かしらの間違いを発見した際は専用のMDが作成されます。AIにそれを見せて修正をさせるようにすることが出来ます。

エラーメッセージ等も多言語化に対応していて、
日本語、英語、簡体中国語、繁体中国語、韓国語、フランス語、ドイツ語、スペイン語、エストニア語、ベトナム語に対応しています。

プロジェクトフォルダ内にdocs/variables'n'functionsというフォルダが作成され、[言語]ファイル名.mdというファイルが作成されます。
厳密なフォーマット指定はしていませんが、大体見出し3の後に関数名などが来ていたので今回はMDファイルの見出し3とインライン表示をパースするようにしています。気になるようでしたらプロンプトはお好きに改造してください。
※文字数制限でここの説明部分にプロンプトは残せませんでした。こちらのnoteのDocsAuditorのところから見てください。
https://note.com/dandy_viper3242/n/n60059c786742

フィードバック

使ってみた感想やバグ報告など、開発者に直接届きます

ログインすると感想を投稿できます

ログインしてフィードバック

関連するアプリ

すべて見る
Web
Markdown Articler

Markdown Articler

マークダウンファイルをキレイに見れるツール

Tomoyuki Matsumoto1551
Web
(異)世界縮尺計算機

(異)世界縮尺計算機

2Dマップと3Dマップ上でピンを刺すことで距離やその他諸々を計算してくれます。星のデカさも設定で変更可能です。小説などで世界観設定をするときなどに使えると思います。

Yuzuko Underson11
Web
ホワイトボード

ホワイトボード

シンプルに特化したホワイトボードWebアプリ。会議などでご活用ください。アプリとしてインストールもできます。黒ペン、赤ペン、消しゴム、ペン太さの変更、画像としてダウンロードができます。

Yamamoto5989412
Web
国民年金システム(自治体標準・参考実装デモ)

国民年金システム(自治体標準・参考実装デモ)

国民年金の被保険者・免除・裁定請求管理を体験

金田一竣亮NEW1
Web
Saturn — 日本企業データを、スプレッドシートとAPIで

Saturn — 日本企業データを、スプレッドシートとAPIで

Tominaga Takuya185
Web
Color Palette generator

Color Palette generator

1色選ぶと、その色に合ったカラーパレットを生成してくれる。

Tomo231
Web
シフト表作成メーカー

シフト表作成メーカー

スタッフのシフト表をブラウザで簡単に作成。期間選択、早番・遅番・夜勤の色分け表示、勤務日数の自動カウント。CSV出力・印刷にも対応。

KOUSUKE39
Web
ガントチャートメーカー

ガントチャートメーカー

プロジェクトのタスクと期間を入力すると、見やすいガントチャートを自動描画。ドラッグで期間変更、依存関係の設定も可能。

Tsukutta公式351
問題を報告する
今週 1人が使いました