ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

dagger develop 之后如何配置 IDE 获得 Dagger 模块的代码补全和类型检查

dagger develop 之后如何配置 IDE 获得 Dagger 模块的代码补全和类型检查 dagger develop 之后如何配置 IDE 获得 Dagger 模块的代码补全和类型检查【免费下载链接】daggerAutomation engine to build, test and ship any codebase. Runs locally, in CI, or directly in the cloud项目地址: https://gitcode.com/GitHub_Trending/da/dagger你用dagger init初始化了一个 Dagger 模块并跑过dagger develop之后代码补全和类型检查并不会自动生效IDE 还看不到dagger develop生成到本地的那份 SDK 客户端代码。这一步的任务就是让 IDE 正确解析这份生成代码——Go 模块靠go.work工作区Python 模块靠装好依赖的虚拟环境TypeScript 靠tsconfig.json的路径映射PHP 靠composer.json的 path 仓库Java 靠以 Maven 项目方式导入。本文按语言给出 IDE Setup 文档 中的配置路径以及每种语言下“配置完成”的判断标准。前置步骤先跑通 dagger init 和 dagger developDagger 底层用 GraphQL 作为语言无关的 API 查询语言各语言 SDK 会基于这个 API 为所有依赖生成原生代码绑定——这正是 IDE 能获得类型检查和代码补全的来源。dagger init用所选语言的模板引导bootstrap一个 Dagger 模块。dagger develop设置或更新开发模块所需的全部资源。根据 CLI 参考该命令幂等可反复执行它依次会确保 SDK 已安装确保自定义 SDK 配置已应用在需要时更新目标引擎版本确保模块实现存在不存在则创建起步模板为 Dagger API 和已安装依赖生成最新的客户端绑定。在“模块仓库的新检出”这一场景下文档明确列出dagger develop的用途之一就是“make sure IDE auto-complete is up-to-date”。所以配置 IDE 之前先在模块目录里跑一次dagger develop让本地sdk/客户端代码是最新的。Go 模块用 go.work 把模块纳入工作区Go SDK 在首次生成模块时会为模块单独创建一个go.mod。如果模块位于外层 Go 项目的子目录如默认的dagger/外层go.mod和模块go.mod并存会迷惑 IDE。Language-native packaging 文档说明 Dagger 模块创建时会自动尝试加入根目录已有的go.work否则之后可手动添加。在仓库根目录执行# in the root of your repository go work init go work use ./ go work use ./path/to/mod./path/to/mod替换为你模块的实际子目录。go.work内容形如// go.work go 1.21.7 use ( ./path/to/mymodule )go.work大多数情况下不应提交进仓库按文档建议把它加入.gitignoreecho go.work .gitignore echo go.work.sum .gitignore另外dagger develop生成的本地 Go 文件并不是运行模块所必需的文档也提示可以把它们排除出版本控制。如何判断成功重启 IDE 后即使从项目根目录编辑dagger/main.gogo-to-definition 等 IDE 功能也应该可用文档原话。如果你希望连模块间跳转也能工作见下一节。可选分支改用外层项目的 go.mod如果父目录已有一个你想沿用的go.mod可以删除新生成的go.mod和go.sumDagger 会转而使用父目录的。文档提醒如果模块依赖了一些与核心产品无关的东西这种做法并不理想因为多数使用者会偏好更窄的依赖集合。跨模块类型导航Source-maps多个相互依赖的 Dagger 模块之间跳转比较困难时source-maps 提供了解法它记录了每个类型声明在源码中对应的文件、行号和列号。Go SDK 在模块初始化生成类型定义时会自动把 source-map 以./path/to/filename:line形式的行注释附在生成代码上。多数主流 IDE 原生或借助插件支持 source-mapsVS Code 文档中点名了 Open file 插件。Python 模块在激活的虚拟环境中安装生成的客户端对 Python 模块让 IDE 认识模块和其中新增的 Dagger 模块依赖的前提是所有依赖都安装在一个激活的虚拟环境里例如与pyproject.toml同目录的.venv这可以手动完成也可以交给包管理器透明处理。先跑dagger develop拿到本地的sdk/目录再按你使用的锁文件方式安装。使用 uv.lock较新的默认方式uv sync对于没有uv.lock的旧模块可以用下面命令创建这会删除requirements.lock请确认锁文件方式确实要切换为uv.lockuv add --editable ./sdk rm requirements.lock文档特别说明使用uvuv.lock时SDK 库dagger-io生成于./sdk需要定义为生产依赖与其他安装方式作为开发依赖不同。使用 requirements.lock 的旧模块uv 的 pip 接口可以替代多个工具同时管理 Python 安装、虚拟环境创建和依赖安装uv venv uv pip install -r requirements.lock -e ./sdk -e .注意uv venv默认创建 Python 3.13 环境。如果要本地和 Dagger 中同时固定 Python 3.12先执行echo 3.12 .python-version用 pip 或 Hatch、Poetrypip 路径先确认 Python 版本与 Dagger 使用的一致默认 3.13除非在pyproject.toml或.python-version中覆盖python -m venv .venv source .venv/bin/activate python -m pip install -r requirements.lock -e ./sdk -e .Hatch 路径先在pyproject.toml中允许直接引用并把本地 SDK 库dagger-io加为dev依赖[project] name main version 0.0.0 [tool.hatch.metadata] allow-direct-references true [tool.hatch.envs.dev] dependencies [ dagger-io {root:uri}/sdk, ]{root:uri}是 Hatch 自身的模板变量指向项目根目录保留原样即可。然后用dev环境打开编辑器hatch run dev:vim .Poetry 路径poetry add --groupdev -e ./sdk poetry run vim .文档提示Hatch 和 Poetry 默认把项目环境放在中心位置而不是.venvPyCharm 也能创建和管理项目环境但对uv.lock的支持可能还不完善最好直接从终端跑uv。在 VS Code 或 PyCharm 中打开VS Code最简单的做法是用装有 Python 扩展的 VS Code 打开包含.venv在pyproject.toml旁边的目录IDE 在工作区根目录发现.venv时会自动接管dagger develop uv run code .NeoVim 等终端编辑器则把code换成vim。不经过终端也可以用 VS Code 的File-Open Folder打开同一个目录效果相同。PyCharm最简单的方式是在包含.venv和pyproject.toml的目录中打开 IDE终端或 GUI 均可。如何判断成功打开编辑器后文档给出的验证点就是“functioning autocompletions”——在模块代码中引用dagger包时自动补全能工作。虚拟环境放在模块内时的清理如果.venv位于模块内部除了加入.gitignore还要在dagger.json中加include: [!.venv]避免把这些文件不必要地上传到运行时容器。TypeScript 模块确认 tsconfig.json 的 paths 配置在 IDE 中打开生成的dagger/src/index.ts时只要tsconfig.json配置了指向./sdk的路径多数 IDE 会自动识别dagger.io/dagger包。dagger init生成的默认模板已经是这样配置的experimentalDecorators: true, paths: { dagger.io/dagger: [./sdk] }这套配置不需要单独安装依赖就能启用类型提示等 IDE 功能。所以 TypeScript 模块的“配置”通常就是确认这段paths还在、且./sdk已由dagger develop生成。TypeScript SDK 同样会自动附加 source-maps格式为./path/to/filename:line的行注释用于跨模块的类型声明跳转支持情况和 Go 部分相同。如何判断成功在dagger/src/index.ts中引用 Dagger 类型时能获得类型提示不需要额外安装依赖。PHP 模块composer.json 指向 ./sdk让 IDE 认识 Dagger PHP 模块前提是composer.json配置了指向生成包dagger/dagger位于模块的sdk目录的 path 仓库。dagger init的默认模板已经是repositories: [ { type: path, url: ./sdk } ], require: { dagger/dagger: *dev },各 IDE 的补全设置PhpStorm在包含模块composer.json的目录中打开 IDE 即可从任意包含该模块的父目录如整个项目打开也可以。Visual Studio Code安装 Intelephense 或 Phpactor 扩展然后在包含composer.json的目录中打开父目录同样可以。Emacs使用内置 LSP 客户端 Eglot并单独安装 PHP LSP如 Phpactor可选安装 PHP Mode 做语法高亮和缩进。在init.el中加入(require eglot) (with-eval-after-load eglot (add-to-list eglot-server-programs (php-mode . phpactor)) (add-hook php-mode-hook eglot-ensure))然后在composer.json作用域内的任意 PHP 文件中打开 Emacs。如何判断成功文档给出的验证方式就是 IDE 中出现 autocompletions 和 IntelliSense。Java 模块按 Maven 项目导入即可生成 Java 模块时会在模块目录创建pom.xml以模块名your-module为例示例源码位于src/main/java/io/dagger/modules/yourmodule/YourModule.java而基于 Dagger 引擎版本和模块依赖生成的 Dagger 依赖代码位于target/generated-sources。这是一套标准的 Maven 项目结构把它作为 Maven 项目导入你的 IDEIDE 会自动识别 Dagger 依赖并开箱提供代码补全等功能。常见支持 Maven 的 IDE 如 IntelliJ IDEA 或 Visual Studio Code 都在文档列举范围内。文档给出的两条限制需要保留target目录默认已在.gitignore中其中的生成代码只服务于 IDE 补全运行模块不需要它重新跑一次dagger develop即可刷新。pom.xml中配置了maven-compiler-plugin运行 Dagger 专用注解处理器、maven-shade-plugin设置模块主类和build-helper-maven-plugin把生成的 Java 文件加为源码以支持补全。这几段配置对模块正常工作是必需的不应修改pom.xml的其他部分可以自由更新。限制与常见边界Go vendor 目录目前不受支持见 Language-native packaging需要 vendor 方式的 Go 模块目前走不通。Python 锁文件方式决定安装路径uv.lock走uv sync只有requirements.lock的旧模块走 pip 接口或 Poetry/Hatch且第三方依赖若没有锁文件固定版本本地环境与 Dagger 执行环境可能装到不同版本。Go 的 go.work 不要提交它只是本地 IDE 的粘合层按文档建议放入.gitignore。Java 的target/是纯构建产物它已被 gitignore重新运行dagger develop可刷新其中的补全代码。配置完成后的整体判断标准以各语言文档给出的现象为准Go 是重启 IDE 后 go-to-definition 生效Python 是编辑器中自动补全工作TypeScript 是无需单独安装依赖即可类型提示PHP/Java 是 IDE 识别dagger包或 Maven 依赖后提供开箱补全。若某项不工作先回到前置步骤确认dagger develop已成功生成本地sdk/客户端再检查该语言的解析配置go.work、.venv、tsconfig.json、composer.json、pom.xml是否指向了这份生成代码。【免费下载链接】daggerAutomation engine to build, test and ship any codebase. Runs locally, in CI, or directly in the cloud项目地址: https://gitcode.com/GitHub_Trending/da/dagger创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表