生成项目目录树

目录树

在开发完一个项目后，常常在gitee和github上看到别人的项目后面，总有那种牛逼的目录树，来展示每个文件夹，并且附上描述。当然如果你是mac电脑或者linux操作系统，那么一个强大的tree命令，即可满足自己的生成目录树的需求。

对于使用linux或者mac的小伙伴，可以忽略下面的内容，直接一个tree命令到底。

生成方法

treer

​ https://www.npmjs.com/package/treer

• 安装

  npm install -g treer
  

• 检验是否安装成功

  treer --help
  treer --version
  

• 参数

  -h, --help             使用帮助
  -V, --version          版本信息
  -d, --directory [dir]  指定一个目录来生成结构树
  -i, --ignore [ig]      要忽略的目录名
  -e, --export [epath]   所导出到文件示例
  

• 示例

  -e 是生成输出到名为tree.txt的文件中
  -i 是忽略不需要的目录，多个文件用竖线 | 隔开,前后要用斜线 / 包括。
  
  treer -e tree.txt -i "/node_modules|.git|dist|readme.md|resource|floor|banner/"
  

• 优点

  一个比tree命令结果更加优美的目录结构小工具

• 缺点

  不能自己指定要生成的目录层级，尽管可以完美的显示目录结构，但是层级深了，没有自己指定目录层级那么理想

在windows10中开启linxu子系统

• 想法由来

  • linux下的tree命令参数很多，完全够用
  • windows下的tree命令就2个参数，阉割太狠了，想用的没有
    • F 显示每个文件夹中文件的名称。（带扩展名）
    • /A 使用 ASCII 字符，而不使用扩展字符。(如果要显示中文，例如 tree /f /A >tree.txt)
    • 根本无法满足按自己想要的目录层级生成，更别说忽略部分目录

• 开启方法和ubuntu初始配置

  https://www.jianshu.com/p/6af3846dbe68

• 修改软件源

  https://www.jb51.net/article/136334.htm

• 安装tree

  sudo apt-get install tree
  

• 查看是否安装成功

  tree --version
  

• 在windows10中如何开启linux命令行

  • 在开始菜单，点击安装后出现的ubuntu图标
  • win+R打开windows10 cmd命令行，输入bash即可切换到linxu命令行

• 参数

  -a 显示所有文件和目录。
  -A 使用ASNI绘图字符显示树状图而非以ASCII字符组合。
  -C 在文件和目录清单加上色彩，便于区分各种类型。
  -d 显示目录名称而非内容。
  -D 列出文件或目录的更改时间。
  -f 在每个文件或目录之前，显示完整的相对路径名称。
  -F 在执行文件，目录，Socket，符号连接，管道名称名称，各自加上"*","/","=","@","|“号。
  -g 列出文件或目录的所属群组名称，没有对应的名称时，则显示群组识别码。
  -i 不以阶梯状列出文件或目录名称。
  -I 不显示符合范本样式的文件或目录名称。
  -l 如遇到性质为符号连接的目录，直接列出该连接所指向的原始目录。
  -n 不在文件和目录清单加上色彩。
  -N 直接列出文件和目录名称，包括控制字符。
  -p 列出权限标识。
  -P 只显示符合范本样式的文件或目录名称。
  -q 用”?"号取代控制字符，列出文件和目录名称。
  -s 列出文件或目录大小。
  -t 用文件和目录的更改时间排序。
  -u 列出文件或目录的拥有者名称，没有对应的名称时，则显示用户识别码。
  -x 将范围局限在现行的文件系统中，若指定目录下的某些子目录，其存放于另一个文件系统上，则将该子目录予以排除在寻找范围外。
  

• 示例

  linux  tree命令
  // 过滤不显示node_modules|dist|resource 只展示3层目录，并输出到text文件
  -I 是要忽略的目录
  -L 指定层级
  show_tree.txt 把生成的目录树输出到本目录下的show_tree.txt中
   tree -I "node_modules|dist|resource" -L 3  > show_tree.txt
  

• 优点

  随心所欲，随时开启，可以指定生成的层级目录，linux下的tree命令所有参数可用。不管你是在项目文件下，还是windows系统下的任何地方，随意生成目录树，根据自己的需要指定层级。

• 缺点

  从开启linux子系统到修改软件源，等等，可能步骤繁杂

tree for windows配合git

https://blog.csdn.net/weixin_43900833/article/details/86565085

• 下载：http://gnuwin32.sourceforge.net/packages/tree.htm

• 打开进入 Tree for Windows 页面，选择下载 Binaries zip 文件。

• 解压压缩包，将压缩包内的 bin 目录下的 tree.exe 复制，粘贴到git安装目录下，即 Program Files\Git\usr\bin 目录，完成安装

• 测试
  进入 Git-Bash，输入 tree --help命令，如果安装成功，命令可以正常执行

• 优点

  tree命令所有参数可用，配合git轻巧

• 缺点

  捆绑git，并且git虽然功能强大，个人觉得界面没有cmd顺手，并且一边cmd，bash秒进linux命令行，exit返回windows的cmd似乎更香