@dcyjs/dirgen

@dcyjs/dirgen：是一个用于生成你项目文件夹结构树的cli工具，它会以一个clean和易于阅读的md文件格式输出你的项目文件结构。搭配 vscode 插件 koroFileHeader 食用

1. 解析文件注释信息
2. 生成目录嵌套列表，包含作者名和描述内容
3. 自动更新目录树到项目根目录的README.md

pnpm add @dcyjs/dirgen -D

# 使用
npx dcy-dirgen

此工具接受以下几个参数：

• -e 或 --exclude :（可选）你想要在文件树中排除的文件或文件夹，可以使用 '|' 分隔关键词，默认为 .nuxt|node_modules|.output。
• -c 或 --charLength :（可选）统一排版渲染长度

目录结构和说明

dirgen
├── .editorconfig
├── .eslintignore
├── .gitattributes
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   └── feature_request.md
│   └── workflows
│       ├── release.yml
│       └── test.yml
├── .gitignore
├── .npmrc
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md                                                                    # 说明：🔥  作者：suk.bear [e-mail]
├── SECURITY.md
├── bin
│   └── dcy-dirgen.js
├── dist
│   ├── cli.js
│   ├── cli.mjs
│   ├── dirgen-BZDjEwj5.js                                                       # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
│   ├── dirgen-BnYmMNQh.js                                                       # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
│   ├── dirgen-CMxfFIZX.js                                                       # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
│   ├── index.js                                                                 # 说明：入口文件  作者：suk.bear [e-mail]
│   └── index.mjs                                                                # 说明：入口文件  作者：suk.bear [e-mail]
├── package.json
├── pnpm-lock.yaml
├── renovate.json
├── rollup.config.ts                                                             # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
├── scripts
│   ├── clean.js
│   └── init
│       ├── bin.js
│       └── rename.js
├── src
│   ├── .env.dev                                                                 # 说明：开发环境变量变量 .env  作者：熊志伟
│   ├── .env.local                                                               # 说明：本地环境变量变量 .env  作者：杨帆
│   ├── README.md                                                                # 说明：我是 sukbearai  作者：熊志伟
│   ├── cli.ts                                                                   # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
│   ├── dirgen.ts                                                                # 说明：dirgen  作者：suk.bear [e-mail]
│   ├── example.ts                                                               # 说明：我是神仙  作者：杨帆
│   ├── index.ts                                                                 # 说明：入口文件  作者：suk.bear [e-mail]
│   ├── parseFileComment.ts                                                      # 说明：这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE  作者：suk.bear [e-mail]
│   ├── test.ts                                                                  # 说明：测试文件😁  作者：suk.bear [e-mail]
│   ├── tree.ts
│   ├── types.ts                                                                 # 说明：测试js  作者：suk.bear [e-mail]
│   └── updDirDesc.ts
├── stats
│   ├── .gitkeep
│   ├── cjs.html
│   └── esm.html
├── test
│   ├── __snapshots__
│   │   └── rollup.test.ts.snap
│   ├── dts.test.ts
│   ├── index.test.ts
│   └── rollup.test.ts
├── tsconfig.build.json
├── tsconfig.dts.json
├── tsconfig.json
├── types
│   ├── cli.d.ts
│   ├── dirgen.d.ts
│   ├── example.d.ts
│   ├── index.d.ts
│   ├── parseFileComment.d.ts
│   ├── test.d.ts
│   ├── tree.d.ts
│   ├── types.d.ts
│   └── updDirDesc.d.ts
├── vitest.config.ts
└── vitest.setup.ts