【Tools】使用tree自動生成目錄結構

前言：

開發的時候，如何記錄清楚目錄結構、每個資料夾在做什麼一直是個小困擾。記錄成文件很費時。不記錄的話，交接的時候總要花不少時間解釋，有時候時間久了自己也會記不清。

後來便找到了一個加速文件生成的小工具：tree。

使用方式很簡單，只要安裝好，進到專案資料夾輸入指令，便可以自動生成樹狀的目錄結構。不但使用快速，生成的文件也很清楚。

使用tree自動生成目錄結構

Max OS可使用homebrew安裝tree

 brew install tree

輸入指令

tree -help可查看指令

tree -a 顯示所有文件/文件夾
tree -d 僅顯示文件夾
tree -v 結果依字母排序
tree -N 中文檔名有亂碼時，加上 -N
tree -L n 顯示到第N層目錄（tree -L 1 = 顯示第一層目錄）
tree -I pattern 排除不想顯示的文件/文件夾
tree -P pattern 只列出符合pattern的
tree -D  Print the date of last modification or (-c) status change.
tree -t  Sort files by last modification time.
tree -c  Sort files by last status change time.
tree > filename 將結果輸出到filename這個文件

將生成的目錄結構輸出到tree.md文件中

// 排除node_modules這個文件夾，將結果輸出到tree.md這個文件中

tree -I node_modules > tree.md

會發現生成的md檔難以閱讀

. ├── demo.md ├── folder │   ├── file1.html │   
└── file2.html ├── img │   ├── img1.png │   └── img2.png └── index.html

只需要在開頭和結尾加上「```」就可以排版好咯！

```
.
├── demo.md
├── folder
│   ├── file1.html
│   └── file2.html
├── img
│   ├── img1.png
│   └── img2.png
└── index.html
```

之後就可以在旁邊新增一些說明文字。