feat(git-changelog): support git submodule

northword commented 1 month ago

closes: #185

变更描述

改变了插件工作的方式，原有的是通过 simple-git 整个仓库的 git log，然后从 git log 的每一次 commit 中解析贡献者和历史信息以及涉及的文件。但 simple-git 无法将子模块的 git log 合并输出。

此 pr 中：

通过 globby 遍历仓库中的 md 文件（['**/*.md', '!node_modules']）
对每一个 md 文件
1. git log （由于每次执行都是在 cwd 中，因此可以支持 submodule）
2. 获取提交信息
3. ~~将获取到的信息以 [path: string]: Commit[] 的格式存储，而不是先前的在每一个 commit 里包含 paths~~ 恢复原有的在每个commit里包含path（但不是paths），这是为了把commit.path传递给getRepoUrl等helper
从 vitepress useDate 获取文件的路径，而不是从路由推断文件路径
根据 md 文件的路径获取该文件的所有 commits

导致了一些破坏性更改：

由于引入了破坏性更改，我不确定是否有可能合并，如果您也同意这种修改方式，我将继续 clean code 以及修改 test。

includeDirs 和 includeExtensions 已弃用，二者合并为 include，include 为一个 glob 模式列表，支持 ! 否定。
如果 include 中的文件在 vitepress 项目根路径之外，需要设置 cwd 为能够读取到该文件的目录。（例如，在一个monorepo中，如果需要读取 docs/ 以外的文件，需要将 cwd 设置为 monorepo 的 root 而不是 vitepress 的 root）
RewritePaths 已弃用
原 RewritePaths 中配置重写 srcDir 的现在不需要再这样配置
RewritePaths 模式现在应将目标路径设置为相对于 srcDir 的文件系统路径，而不是路由（一般情况下，如果没有在 vitepress 中设置 rewrite ，文件系统路径就是路由）

includeDirs and includeExtensions have been deprecated and merged into include, which is a list of glob modes with ! negation.
If a file is outside the vitepress project root path, set cwd to the directory where the file can be read. (For example, in a monorepo, if you need to read a file outside of docs/, you need to set cwd to the root of the monorepo instead of the root of vitepress.)
Original RewritePaths is now deprecated.
Configuring RewritePaths to rewrite srcDir is no longer needed.
RewritePaths pattern should now set the destination path to the filesystem path relative to srcDir instead of the route (normally, if no rewrite is set in vitepress, the filesystem path is the route)

github-actions[bot] commented 1 month ago

Platform	Status	URL
Ubuntu	Success	https://66351db0783c732676f72dc5--nolebase-integrations.netlify.app
Windows	Success	https://66351dbc4567252067a1a728--nolebase-integrations.netlify.app