repo-visualizer

Repo Visualizer

GitHub 此操作会创建您的仓库的 SVG 图表。请阅读 详细说明。 请注意,这是一个实验。如果您有功能请求,请提交 PR 或分支,并按照需要使用代码。 如需完整演示,请查看 githubocto/repo-visualizer-demo 仓库。

输入

output_file

一个路径 (相对于仓库的根目录),用于指定图表所在的位置。 例如: images/diagram.svg 默认: diagram.svg

excluded_paths

从图表中排除的文件夹路径列表,以逗号分隔。 例如: dist、node_modules

默认值: node_modules, bower_components, dist, out, build, eject, .next, .Netlify, yarn, vscode, package-lock.json, yarn.lock

excluded_globs

用 微匹配 语法指定要从图中排除的文件 glob 数组,以分号分隔。提供为数组。 例如:

excluded_globs: "frontend/*.spec.js;**/*.{png,jpg};**/!(*.module).ts"
# Guide:
# - 'frontend/*.spec.js' # exclude frontend tests
# - '**/*.{png,ico,md}'  # all png, ico, md files in any directory
# - '**/!(*.module).ts'  # all TS files except module files

root_path

要在图中显示的目录(及其子目录),相对于仓库根目录。 例如: src/ 默认值: '''' (当前目录)

max_depth

显示文件的最大嵌套文件夹数量。数量越大,渲染时间就越长。 默认值: 9

should_push

是否使用图表进行新的提交并将其推送到原始仓库。应为布尔值，即 true 或 false。有关如何自定义提交的详细信息，请参阅 commit_message 和 branch。