dir-tree について
dir-tree について
dir-tree は、プロジェクトの構成を説明する開発者やテクニカルライターのためのツールです。ファイルの一覧だけでなく、必要な項目に絞ったツリーと短い注釈で、どこから読めばよいかを伝えます。
無料のブラウザーツールで、読み込み、構成の編集、注釈、出力まで行えます。元のプロジェクトを変更せずに、生成ファイルを除外し、README、レビュー、新メンバー向け資料に使う構成を整理できます。
プロジェクト構成に注目する理由
ドキュメントは、次に開くべきファイルを見つける手助けになるべきです。不要なパスを除き、残した重要なパスを説明するために、フィルターと注釈を一つの流れで扱えます。
ローカルフォルダーの処理、編集、出力はブラウザー内で完結します。リモートからの読み込みは選択した接続先にアクセスします。AI は任意で、手動の注釈や整列に AI は必要ありません。
ツリーの操作にはオープンソースの @devmc12/dir-tree を使用しています。GitHub の Repo で実装や変更履歴を確認できます。
GitHub でコアを見る