使用Melos的Flutter项目中Dartdoc如何避免生成所有依赖库文档
Melos项目运行dartdoc排除第三方依赖生成文档的操作方案
--auto-include-dependencies 参数的默认逻辑是自动将项目所有依赖加入文档生成范围,如果你不需要生成第三方依赖的文档,可通过以下几种方式实现:
方法一:替换自动包含参数,手动指定仅生成内部包文档
直接放弃使用--auto-include-dependencies参数,改用--include参数指定你需要生成文档的Melos本地包名称即可,假设你的项目下有user_core、order_service两个内部包,运行命令如下:dartdoc --include user_core,order_service执行后只会生成你指定的内部包文档,不会引入任何第三方依赖的文档内容。
方法二:保留自动包含参数,通过配置文件添加排除规则
如果你需要保留--auto-include-dependencies来自动识别内部包,可在项目根目录新建/编辑dartdoc_options.yaml文件,配置排除的第三方依赖:dartdoc: # 填写所有不需要生成文档的第三方依赖包名 exclude: - dio - flutter_bloc - url_launcher # 可选:明确指定仅包含本地工作区的内部包,优先级高于自动识别 include: - user_core - order_service配置完成后再运行
dartdoc --auto-include-dependencies,程序会自动跳过你配置的排除项,仅生成保留范围的文档。方法三:Melos专属批量生成方案
如果你需要给所有Melos管理的本地包批量生成文档,可直接在melos.yaml中配置专属执行脚本,不需要依赖dartdoc的自动包含参数:scripts: build_docs: run: melos exec --scope="你的包名前缀:*" -- "dartdoc" description: 为所有本地内部包生成文档,不包含第三方依赖配置完成后运行
melos run build_docs即可批量生成所有内部包的独立文档,全程不会引入第三方依赖的文档内容。
内容的提问来源于stack exchange,提问作者Alessandro Antonio Del Gaudio
相关产品推荐
相关产品推荐

