GitHub 操作中的 dartdoc / dart 文档会创建冗长的文件名

Question

在我的 flutter 项目中，我尝试通过 GitHub 操作自动生成文档，然后通过 GitHub 页面自动提供文档。 我的工作流程步骤是：

sudo snap install flutter --classic
flutter
cd project
dart doc --output ../docs

该操作生成最新文档后，最近的拉取尝试失败，因为 git 尝试拉取文件名长度超出 Windows 字符限制的文件。

我查看了一下，发现生成的文件名是源代码文件的整个静态路径，以

file-___home_runner_work_my-project_my-project_project_lib

开头。

奇怪的是，日志显示它为“库”生成文档 - 当为单个

.dart

文件生成文档时。

Generating docs for library main.dart from file:///home/runner/work/my-project/my-project/project/lib/main.dart...

日志还告诉我们：

Running in /home/runner/work/my-project/my-project

以相同的方式在本地运行

dart doc

会产生类似的结果，只是文件名至少短一点，因为它们连接的不是文件名的整个路径（命名以

lib

的子目录开头） 。但文件的日志也略有不同。

Generating docs for library main.dart from package:project/main.dart...

其他帖子提到设置

$FLUTTER_ROOT

[1]，[2]。 我尝试在调用

export FLUTTER_ROOT=~/dev/flutter

之前添加

dart doc

但这并没有改变任何东西。

这个过程似乎只是错过了一个环境变量或类似的东西，但我无法通过 dart doc 和 dartdoc 文档页面弄清楚它。

Answer 1

dart 文档提到：

要生成文档，您必须首先运行 dart pub get 并且您的包必须通过 dart 分析且没有错误。

并且dartdoc还提到：

您必须首先运行 dart pub get 或 flutter pub get

我忽略了这个信息。然而，即使没有

flutter pub get

，文档仍然功能齐全，所以直到

git pull

不再工作时我才注意到。

现在 GitHub 运行程序生成与我的本地设备相同的文件。文件名仍然相当于其相应的源代码路径，但名称仅包含以下子路径

lib

。