project-tree

English | 简体中文

简化您的项目结构展示

project-tree是一款强大且易用的插件，旨在帮助开发者快速生成项目树结构。通过简单的操作，您可以将项目结构清晰地展示在README.md文件中，提升开发和协作效率。

主要功能：

• 一键生成项目树：安装插件后，按下Ctrl Shift P并输入“Project Tree”即可激活插件，生成项目树结构。
• 多样化主题设置：通过ProjectTree.theme设置，您可以选择适合的树结构外观，默认主题为“perfect”。
• 自定义注释：使用ProjectTree.withComment和ProjectTree.commentDistance设置，您可以选择是否在行尾添加注释，并调整注释与标题之间的距离。
• 智能文件忽略：通过ProjectTree.loadIgnore和ProjectTree.ignoreFolders设置，您可以忽略.gitignore中指定的文件以及常见的文件夹，如node_modules、.git和.vscode。
• 输出目标文件：通过ProjectTree.distFileName设置，您可以指定输出文件，默认为README.md。

使用示例：

project-tree
├─ .git
├─ .gitignore
├─ .vscode
│  ├─ extensions.json
│  ├─ launch.json
│  ├─ settings.json
│  └─ tasks.json
├─ .vscodeignore
├─ CHANGELOG.md
├─ dist
│  ├─ extension.js
│  └─ extension.js.map
├─ images
│  └─ tree-icon.jpg
├─ node_modules
├─ out
│  ├─ extension.js
│  ├─ extension.js.map
│  ├─ index.js
│  ├─ index.js.map
│  ├─ operate.js
│  ├─ operate.js.map
│  ├─ test
│  │  ├─ extension.test.js
│  │  ├─ extension.test.js.map
│  │  ├─ index.js
│  │  └─ index.js.map
│  ├─ traverse.js
│  ├─ traverse.js.map
│  └─ type
│     ├─ index.js
│     └─ index.js.map
├─ package-lock.json
├─ package.json
├─ src
│  ├─ config.ts
│  ├─ extension.ts
│  ├─ ignore
│  │  └─ index.ts
│  ├─ ignore.ts
│  ├─ index.ts
│  ├─ test
│  │  ├─ extension.test.ts
│  │  └─ index.ts
│  ├─ theme
│  │  ├─ index.ts
│  │  ├─ normal.ts
│  │  └─ perfect.ts
│  ├─ traverse.ts
│  ├─ type
│  │  └─ index.ts
│  └─ utils.ts
├─ tsconfig.json
├─ tslint.json
└─ webpack.config.js         

开始使用project-tree，简化您的项目管理，提升开发效率！