grace-file-tree工具

介绍

grace-file-tree工具可以帮我们生成一个带注释的目录树，虽然vscode也有直接生成目录树的插件，不过对于一个庞大的项目来说在一长串的目录中找到想要的文件还是有些困难的，于是就手撸了个带注释的目录树工具 grace-file-tree

使用方式

直接命令行输入即可,建议直接配置到package.json的scripts中

查看使用帮助

output tree -h

生成带注释的文件树

output tree [参数1] [参数2] [参数3] [参数4]

生成不带注释的文件树只有三个参数

output tree -n [参数1] [参数2] [参数3]

参数说明

目前只有四个参数参数按顺序读取,不能省略,使用默认值需要输入’ '占位,如下:output tree [参数1] ’ ’ [参数3] [参数4],当然也可以都不配置直接执行output tree

参数1: 解析目录路径,默认为’./src
参数2：要遍历的目录名使用’,‘隔开不能有空格,支持正则表达式,默认为’pages’, ‘components’
参数3：生成文件路径,默认为’./fileTree.md’
参数4：要读取的注释类型使用’,‘隔开不能有空格,默认为’component’, ‘util’

注释说明

文件中的注释写法必须是下面这种格式才能读取，并且只会读取文件中的第一个,注释中@后面的名称可以自定义但是不能是注释规范中的单词，
定义的单词首字母会在文件树的注释中体现如’-c’，
为了文件树更加简洁脚本自动过滤的没有写注释的文件。


/*** @component 权限按钮组件 <-脚本中会读取该行的注释* @props {string} auth 权限名* @props {string} env 环境 dev prod test* @props {boolean} needPopconfirm 需要Popconfirm二次确认**/
const AuthButton = (props: IProps) => {...
}

生成效果


┌─components
| ├─ AuthComponents
| | ├─ AuthButton.tsx # 权限按钮组件 -c
| | ├─ AuthContainer.tsx # 自定义权限按钮并支持二次确认弹窗 -c
| | ├─ AuthLink.tsx # 为表格便捷操作的权限text组件（只有拥有权限才能触发text点击事件） -c
| | └─ AuthMenuItem.tsx # 权限菜单按钮 -c
| ├─ Authorized
| | ├─ Authorized.tsx # 权限校验容器组件 -c
| | ├─ CheckPermissions.tsx # 通用权限检查方法 -u
| | ├─ PromiseRender.jsx # 异步权限校验组件 -c
| | ├─ Secured.jsx # 用于判断是否拥有权限访问此 view 权限 -u
| | └─ renderAuthorize.ts # 更新权限方法 -u
| ├─ CustomSelectors
| | ├─ TagSelector.tsx # 标签选择器 -c
| | ├─ ThemeSelect.tsx # 主题选择组件 -c
| | └─ index.tsx # 导出ThemeSelect、TagSelector 组件 -u
| ├─ ProTable
| | └─ index.tsx # ProTable 基于ProTable二次封装表格组件 -c

一个优雅的目录树生成工具相关推荐

开源一个优雅的类图生成工具
前言首先必须声明,这不是一篇广告或者标题党. 而是我开源了一个工具,可以优雅的为Java or Kotlin 项目生成 Class Diagram. 我推测列为读者会进来阅读,原因无非以下两点: 获 ...
wkhtmltoimage 卡住了_用rails做一个简单的长微博生成工具
长微博就是把文字转换成图片,主要用到的gem是imgkit. imgkit是一个通过open3来调用wkhtmltoimage生成图片的gem,源码不是很复杂,使用也很简单. 基本步骤如下: rail ...
基于AD的用户组织目录树选择工具的解决方案
默认情况下,MOSS具有的用户选择器非常不方便,我们的领导希望用组织目录树的方式来进行人员的选择,当然,这可难倒我了.最后我选择了自定义字段来进行开发,解决这样的问题.不知道是否也有人和我碰到同样的问 ...
一个好用的脚本生成工具
sqlserver 自带导出架构脚本和数据脚本的功能,但只抽取部分数据生成脚本没那么方便,后来看到一个脚本生成工具SqlDataToScript.exe.这个工具使用挺简单,免安装,连接上数据库,写好 ...
如何用20行C#代码写一个桌面二维码生成工具
本文是利用ZXing.Net在WPF中生成条形码,二维码的小例子,仅供学习分享使用,如有不足之处,还请指正. 什么是ZXing.Net? ZXing是一个开放源码的,用Java实现的多种格式的1D/2 ...
Carbon 一个在线代码美图生成工具
官网 GitHub demo1 demo2 转载于:https://juejin.im/post/5aa77061518825557c0128b9
11个最流行的静态(博客)网站生成工具
11个最流行的静态(博客)网站生成工具最近特别流行使用静态网站搭建博客,本博客就是host在GitHub Pages的静态网站.静态网站非常适合专注于内容的网站,例如,博客.那你可能会问,为什么不用 ...
工具推荐-css3渐变生成工具
今天工作用到了css3渐变,但是写起来才发现太麻烦了,而却很浪费时间,所以在这里向大家推荐一个在线的css3 渐变生成工具地址是:http://www.colorzilla.com/gradient ...
Swagger：后端文档生成工具
Swagger 在公司的项目中通常使用 swagger, 由后端来模拟业务数据. swagger 是一个 REST APIs 文档生成工具,它从代码注释中自动生成文档,可以跨平台,开源,支持大部分语言 ...

一个优雅的目录树生成工具

一个优雅的目录树