😎 文件夹解析器[Dir Parser v2] 😎
文件夹解析器 dir-parser
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-n89LEJzr-1615083892078)(https://img.shields.io/npm/v/dir-parser.svg)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-CZ4yzanc-1615083892089)(https://img.shields.io/npm/l/dir-parser.svg)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lu0A7odg-1615083892090)(https://img.shields.io/npm/dm/dir-parser.svg?style=flat)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-dBMRRx7H-1615083892092)(https://packagephobia.now.sh/badge?p=dir-parser)]
解析一个文件夹并生成它的结构树
使用其它语言阅读: English | 简体中文
- 文件夹解析器 dir-parser
一、什么是文件夹解析器 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 打印帮助信息
$ parser -H
(或: $ parser --Help
)
用例: parser [参数options]
参数 Options:
-V, --version 打印输出版本号。
-v, --version 打印输出版本号。
-c, --config [config] 根据配置文件解析,可选。
-i, --input <input> 指定个目标文件夹,(默认: "./")。
-o, --output <output> 解析结果输出目录,(默认: "./")。
-d, --depth <depth> 解析深度,0表示不限制。(默认: 0)。
-l, --lineType <lineType> 生成的文件树线型, "dashed" 或 "solid",(默认: "solid")。
-e, --excludes <excludes..> 根据名称排除文件夹或文件。
-x, --excPaths <excPaths..> 根据路径排除文件夹或文件。
-p, --patterns <patterns...> 根据正则解析文件夹或文件。
-g, --generate [fileName] 生成一个解析结果的文件,默认文件名为"dir-info.txt"。
-r, --reverse 生成节点逆序的文件树。
-s, --silent 静默解析,不在控制台输出解析结果。
-f, --fileFirst 先输出文件节点,先于文件夹节点。
-F, --fileOnly 只解析文件。
-D, --dirOnly 只解析文件夹,只有当fileOnly为false时才生效。
-I, --ignores <ignores..> 根据名称忽略一些文件夹或文件。
-N, --no-dirInfo 不在解析结果中显示文件夹和文件的数量信息。
--paths <paths..> 根据路径解析文件夹或文件。
--includes <includes..> 根据名称解析文件夹或文件。
--excPatterns <excPatterns...> 根据正则排队文件夹或文件。
-H, --Help 打印中文帮助信息。
-h, --help 打印英语帮助信息。(output usage information)
2.2 生成文件树
如果需要跑例子的话,你可能需要安装 express-generator
,但这也不是必需的:
运行:
$ npm install -g express-generator
$ express myapp
$ cd myapp
$ parser
myapp ( directories: 7, Files: 9 )
├─ bin
│ └─ www
├─ public
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets
│ └─ style.css
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
└─ package.json
2.3 使用解析参数
2.3.1 排除项-excludes
👉 根据名称排除文件夹或文件。
$ # git init
$ npm install
$ parser -e .git,node_modules,public
或: $ parser --excludes .git,node_modules,public
myapp ( directories: 3, Files: 8 )
├─ bin
│ └─ www
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
└─ package.json
2.3.2 忽略项-ignores
👉 根据名称忽略一些文件夹或文件。
$ parser -e node_modules -I bin,public
或: $ parser -e node_modules --ignores bin,public
myapp ( directories: 4, Files: 7 )
├─ bin/
├─ public/
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
└─ package.json
2.3.3 正则匹配-patterns
👉 根据正则解析文件夹或文件。
$ parser -e node_modules -p .js$
或: $ parser -e node_modules --patterns .js$
myapp ( directories: 1, Files: 3 )
├─ routes
│ ├─ index.js
│ └─ users.js
└─ app.js
2.3.4 结构线型-lineType
👉 生成的文件树线型, “dashed” 或 “solid”,(默认: “solid”)。
$ parser -e bin,node_modules -l dashed
或: $ parser -e bin,node_modules --lineType dashed
myapp ( directories: 6, Files: 8 )
+-- public
¦ +-- images/
¦ +-- javascripts/
¦ +-- stylesheets
¦ +-- style.css
+-- routes
¦ +-- index.js
¦ +-- users.js
+-- views
¦ +-- error.jade
¦ +-- index.jade
¦ +-- layout.jade
+-- app.js
+-- package.json
2.3.5 解析深度-depth
👉 解析深度,0表示不限制。(默认: 0)
$ parser -e node_modules,views -d 2
或: $ parser -e node_modules,views --depth 2
myapp ( directories: 6, Files: 5 )
├─ bin
│ └─ www
├─ public
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets/*
├─ routes
│ ├─ index.js
│ └─ users.js
├─ app.js
└─ package.json
2.3.6 节点逆序-reverse
👉 生成节点逆序的文件树。
$ parser -e node_modules,views -d 2 -r
或: $ parser -e node_modules,views -d 2 --reverse
myapp ( directories: 6, Files: 5 )
├─ routes
│ ├─ users.js
│ └─ index.js
├─ public
│ ├─ stylesheets/*
│ ├─ javascripts/
│ └─ images/
├─ bin
│ └─ www
├─ package.json
└─ app.js
2.3.7 文件优先-fileFirst
👉 先输出文件节点,先于文件夹节点。
$ parser -e node_modules,bin,views -f
或: $ parser -e node_modules,bin,views --fileFirst
myapp ( directories: 5, Files: 6 )
├─ app.js
├─ dir-info.txt
├─ package.json
├─ public
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets
│ └─ style.css
└─ routes
├─ index.js
└─ users.js
2.3.8 仅文件-fileOnly
👉 只解析文件。
$ parser -e node_modules,bin,views -F
或: $ parser -e node_modules,bin,views --fileOnly
myapp ( directories: 3, Files: 6 )
├─ public
│ └─ stylesheets
│ └─ style.css
├─ routes
│ ├─ index.js
│ └─ users.js
├─ app.js
├─ dir-info.txt
└─ package.json
2.3.9 仅文件夹-dirOnly
👉 只解析文件夹,只有当fileOnly为false时才生效。
$ parser -e node_modules,bin,views -D
或: $ parser -e node_modules,bin,views --dirOnly
myapp ( directories: 5 )
├─ public
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets/
└─ routes/
2.3.10 解析信息-dirInfo
👉 不在解析结果中显示文件夹和文件的数量信息。
$ parser -e node_modules,bin,public -N
或: $ parser -e node_modules,bin,public --no-dirInfo
myapp
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
├─ dir-info.txt
└─ package.json
2.3.11 路径排除-excPaths
👉 根据路径排除文件夹或文件。
$ parser -e node_modules,bin -x myapp/public
或: $ parser -e node_modules,bin -excPath myapp/public
myapp ( directories: 2, Files: 7 )
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
└─ package.json
2.3.12 正则排除-excPatterns
👉 根据正则排队文件夹或文件。
$ parser -e node_modules,bin --excPatterns .jade$,.css$
myapp ( directories: 6, Files: 4 )
├─ public
│ ├─ images/
│ ├─ javascripts/
│ └─ stylesheets/
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views/
├─ app.js
└─ package.json
2.3.13 静默解析-silent
👉 静默解析,不在控制台输出解析结果。
$ parser -e node_modules,bin,public -s
或: $ parser -e node_modules,bin,public --silent
2.3.14 生成结果-generate
👉 生成一个解析结果的文件,默认文件名为"dir-info.txt"。
$ parser -e node_modules,bin,public -sg
或: $ parser -e node_modules,bin,public -s --generate
$ cat dir-info.txt
myapp ( directories: 2, Files: 7 )
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├─ error.jade
│ ├─ index.jade
│ └─ layout.jade
├─ app.js
└─ package.json
2.3.15 配置文件-config
👉 根据配置文件解析,可选。
$ touch parser.conf.json
$ vi parser.conf.json
{
"directory": "./",
"excludes": [ ".git", "node_modules", "bin", "public", "parser.conf.json" ],
"depth": "2",
"generate": "info.txt"
}
$ parser -c ./parser.conf.json
myapp ( directories: 2, Files: 8 )
├─ routes
│ ├─ index.js
│ └─ users.js
├─ views
│ ├