😎 文件夹解析器[Dir Parser v2] 😎
# 文件夹解析器 dir-parser
[](https://www.npmjs.com/package/dir-parser)
[](https://www.npmjs.com/package/dir-parser)
[](https://npmcharts.com/compare/dir-parser?minimal=true)
[](https://packagephobia.now.sh/result?p=dir-parser)
> 解析一个文件夹并生成它的结构树
使用其它语言阅读: [English](https://github.com/CN-Tower/dir-parser) | 简体中文
- [文件夹解析器 dir-parser](#文件夹解析器-dir-parser)
- [一、什么是文件夹解析器 dir-parser](#一什么是文件夹解析器-dir-parser)
- [1.1 工具简介](#11-工具简介)
- [1.2 安装使用](#12-安装使用)
- [二、在命令行中使用](#二在命令行中使用)
- [2.1 打印帮助信息](#21-打印帮助信息)
- [2.2 生成文件树](#22-生成文件树)
- [2.3 使用解析参数](#23-使用解析参数)
- [2.3.1 排除项-excludes](#231-排除项-excludes)
- [2.3.2 忽略项-ignores](#232-忽略项-ignores)
- [2.3.3 Glob过滤-glob](#233-Glob过滤-glob)
- [2.3.4 正则匹配-patterns](#234-正则匹配-patterns)
- [2.3.5 结构线型-lineType](#235-结构线型-lineType)
- [2.3.6 解析深度-depth](#236-解析深度-depth)
- [2.3.7 节点逆序-reverse](#237-节点逆序-reverse)
- [2.3.8 文件优先-fileFirst](#238-文件优先-fileFirst)
- [2.3.9 仅文件-fileOnly](#239-仅文件-fileOnly)
- [2.3.10 仅文件夹-dirOnly](#2310-仅文件夹-dirOnly)
- [2.3.11 解析信息-dirInfo](#2311-解析信息-dirInfo)
- [2.3.12 路径排除-excPaths](#2312-路径排除-excPaths)
- [2.3.13 正则排除-excPatterns](#2313-正则排除-excPatterns)
- [2.3.14 静默解析-silent](#2314-静默解析-silent)
- [2.3.15 生成结果-generate](#2315-生成结果-generate)
- [2.3.16 配置文件-config](#2316-配置文件-config)
- [2.4 多个命令混合使用](#24-多个命令混合使用)
- [三、在Js代码中使用](#三在Js代码中使用)
- [3.1 方法接口](#31-方法接口)
- [3.1.1 主函数-parser](#311-主函数-parser)
- [3.1.2 参数选项-Options](#312-参数选项-options)
- [3.1.3 解析结果-Parsed](#313-解析结果-parsed)
- [3.1.4 文件夹信息-DirInfo](#314-文件夹信息-dirinfo)
- [3.1.5 文件信息-FileInfo](#315-文件信息-fileinfo)
- [3.2 获取文件树](#32-获取文件树)
- [3.2.1 构建文件树案例](#321-构建文件树案例)
- [3.2.2 执行文件树案例](#322-执行文件树案例)
- [3.3 获取文件信息](#33-获取文件信息)
- [3.3.1 构建文件夹信息案例](#331-构建文件夹信息案例)
- [3.3.2 执行文件夹信息案例](#332-执行文件夹信息案例)
- [3.3.3 构建子文件信息案例](#333-构建子文件信息案例)
- [3.3.4 执行子文件信息案例](#334-执行子文件信息案例)
- [3.3.5 构建纯文件信息案例](#335-构建纯文件信息案例)
- [3.3.6 执行纯文件信息案例](#336-执行纯文件信息案例)
## 一、什么是文件夹解析器 dir-parser
### 1.1 工具简介
👍👍👍dir-parser是一个基于nodejs的强大的文件夹分析工具,可以在命令行中使用也可以在javascript代码中应用。有很多实用的参数可以设置,可以帮助你获取格式化的文件夹树和内部信息。
### 1.2 安装使用
#### 1.2.1 全局安装
- yarn: `$ yarn global add dir-parser`
- npm: `$ npm install -g dir-parser`
#### 1.2.2 局部安装
- yarn: `$ yarn add dir-parser` or `$ yarn add dir-parser -D`
- npm: `$ npm install dir-parser` or `$ npm install dir-parser -D`
## 二、在命令行中使用
### 2.1 打印帮助信息
`$ dp -H` (或: `$ dp --Help`)
```
用例: dp [参数options]
参数 Options:
-V, --version 打印输出版本号。
-v, --version 打印输出版本号。
-c, --config [config] 根据配置文件解析,可选。
-i, --input 指定个目标文件夹,(默认: "./")。
-o, --output