前言
在开发前端项目的过程中，经常需要使用到 Github 上公开的代码库作为基础，而在 Github 上，有时我们需要查看某个项目的目录树结构，以便于更好地了解代码结构。此时，npm 包 github-trees 就为我们提供了方便。
github-trees 是什么？
github-trees 是一个基于 Node.js 开发的 npm 包，可以通过命令行工具快速地获取 Github 上公开项目的目录树结构，并通过控制台直观地展示。
安装
在终端中使用以下命令进行安装：
npm install -g github-trees
安装完成后，可以通过以下命令来查看 github-trees 的帮助文档：
github-trees -h
使用
命令格式
github-trees <username> <repository> [branch] [path] [options]
- username: Github 用户名
- repository: Github 存储库名称
- branch: 分支名称，默认为 master
- path: 目录路径，默认为根目录
- options:
-c: 显示的列数，默认为 3-t: 显示的文件类型列表，以逗号分隔，默认为'md', 'js', 'css', 'less', 'sass', 'html', 'vue', 'json', 'yml', 'yaml', 'lock', 'log', 'txt'
示例
以默认设置获取目录树
github-trees yuanxindong github-trees
使用以上命令可以获取用户 yuanxindong 在 Github 上的存储库 github-trees 的 master 分支的根目录树结构。输出结果类似于：
-- -------------------- ---- ------- - --- ------------- --- ------------- --- ------------ --- ---------- --- ---------- --- ----------- --- --------- --- --- --- --- --------------- --- -------- --- --- --- --- ------- --- ------------
可以看到，根目录下有许多文件和文件夹，其中文件夹和文件呈嵌套状态。
自定义设置
如果想要自定义设置，如输出的列数、只展示特定类型的文件等，可以使用以下命令：
github-trees yuanxindong github-trees -c 4 -t 'js,css,md'
在以上命令中，-c 参数表示需要展示的列数为 4，-t 参数表示需要展示的特定类型文件为 js、css 和 md。输出结果类似于：
. ├── .editorconfig .eslintrc.js lib README.md ├── .eslintignore index.js package.json ├── .gitignore bin node_modules ├── .npmignore ├── .travis.yml
可以看到，根据我们的设定，目录树的输出已经变得不同，仅列出了 js、css 和 md 类型的文件，为我们查看源代码提供了更大的方便。
总结
通过使用 npm 包 github-trees，我们可以快速地获取并查看 Github 上公开项目的目录树结构。合理地使用其自定义设置功能，可以更便捷地进行源码查阅，提升开发效率。
注：以上示例代码以 https://github.com/yuanxindong/github-trees 作为演示对象。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005731581e8991b448e9421