背景

プロジェクト参加時にリポジトリのソースコードをざっくり読むときがある
そんなときに、treeベースのTodoリストを作ってクリップボードにコピーするコマンド

環境

macOS 13.5

コマンド

tree --noreport -a --dirsfirst <DIRECTORY> -I <IGNORE_PATTERN> \
| sed 's/^/- [ ] /' \
| pbcopy

• <DIRECTORY>: ex. ./src
• <IGNORE_PATTERN>: ex. node_modules

やってること

1. treeコマンドでディレクトリ構造を取得
   • --noreport: Turn off file/directory count at end of tree listing.
   • -a: All files are listed.
   • --dirsfirst: List directories before files (-U disables).
   • -I pattern: Do not list files that match the given pattern.
2. sedで各行の先頭に- [ ] を追加
3. pbcopyでクリップボードにコピー

出力例

- [ ] src
- [ ] ├── assets
- [ ] │   ├── app-logo.svg
...
- [ ] ├── components
- [ ] │   ├── Button
- [ ] │   │   ├── Button.stories.tsx
- [ ] │   │   ├── Button.tsx
- [ ] │   │   └── index.ts
...
- [ ] ├── App.tsx
- [ ] ├── main.tsx
- [ ] └── vite-env.d.ts