使用 tree-node-cli 自动生成目录树结构

港控/mmm° 2022-12-02 00:50 444阅读 0赞

### 一、安装 Node 和 Git ###

下载 [Node.js][] 和 [Git][]，网上教程很多，这里不再赘述。

### 二、安装 tree-node-cli ###

在项目的根文件夹下鼠标右键打开 `Git Bash Here`：

![format_png][]

输入下面命令进行安装：

npm install -g tree-node-cli

![format_png 1][]

### 三、自动生成目录树结构 ###

输入下面命令：

tree -L 4 -I "Scripts|Lib|pycache" > tree.md

![format_png 2][]

**解释：**

*  `tree -L n` 显示项目的层级。n 表示层级数。比如你想要显示项目的 4 层结构，可以用`tree -L 4`。
 *  `tree -I "Scripts|Lib|pycache"` 表示要过滤的文件夹/目录。
 *  `tree > tree.md` 表示将结构输出到 tree.md 这个文件。

更多操作可以输入 `tree --help` 进行查看：

Options:
      -V, --version             output the version number
      -a, --all-files           All files, include hidden files, are printed.
      --dirs-first              List directories before files.
      -d, --dirs-only           List directories only.
      -I, --exclude [patterns]  Exclude files that match the pattern. | separates alternate patterns. Wrap your entire pattern in double quotes. E.g. `"node_modules|coverage".
      -L, --max-depth <n>       Max display depth of the directory tree.
      -r, --reverse             Sort the output in reverse alphabetic order.
      -F, --trailing-slash      Append a '/' for directories.
      -h, --help                output usage information

查看 tree.md 文件里的内容：

![format_png 3][]

这样就能直接复制内容写进 GitHub 项目里的 README 中了，超级方便，而且很有条理。

### 四、参考 ###

[使用tree生成目录树结构][tree]

[Node.js]: https://nodejs.org/en/
[Git]: https://git-scm.com/
[format_png]: /images/20221123/3a2d4567e3b04a5e92c8adbc48cad775.png
[format_png 1]: /images/20221123/b4c090029ac54c8c9fbc1aad45ea3f40.png
[format_png 2]: /images/20221123/09f7332cb53145a6896e0caaf4cdc5a1.png
[format_png 3]: /images/20221123/d16dc98fd68e473e9b97233358c3dcca.png
[tree]: https://www.jianshu.com/p/dcde5ab4cfd9