DirDoc
暗黙的になりがちなディレクトリ構造やファイルをJSONで文書化できるパッケージを作成しました。
いわゆるVibeコーディングで、Claude3.7（Sonnet）と一緒に作りました。
パッケージを作ること自体がはじめてのため、本当に動くのか？まだまだわからないことだらけです。
コードのほとんどはClaudeが書いてくれたので、そもそものアイディアはわたしが書き残しておこうと思いました。
ネーミングのむずかしさ
ネーミングはむずかしいですし、文脈を読んで正しく理解することはもっとむずかしいです。
内容を表すためには、長く豊かな表現にしたいのに、トークンとしては短いものがいい（中略）
矛盾した要求を名前付けに求められている（郡山昭仁「イベント駆動コンテンツ」PHPerKaigi 2024、2024年）
このディレクトリ名は、「（ある書籍が発祥の）ナントカ Driven Delopmentのナントカ」です。みたいなことってよくありませんか？
あるいは、いろいろなサービスの設定ファイルが増えてきて、名前からなんとなく察せるものの、具体的にはどのサービスが使っているだろう？というようなファイルが増えてしまうこととか。
この問題に挑戦しています。
機能の解説
プロジェクトの途中からでも導入ができるような、ゆるい制約になっています。
まずは現状からJSONを作成し、その後に説明を追加できます。（説明自体が不要なものは、そもそもJSONに記録できないようにもできます。）
その後は、チェックするコマンドを実行して、JSONと現実が乖離していたり、説明がもれていればお知らせすることもできます。
今後の課題
まだプロジェクトに組み込めていないので、まずは実際に導入してもらうことからのスタートになりそうです。
そしてJSONのみですと、よくあるツリー状の表記には劣るので、表示する仕組みが必要そうです。
以上となります。
もしご意見などがあれば、お気軽にご連絡いただけたら幸いです。
Discussion