@aappddeevv/graphql-codegen-scala 中文文档教程

Question

graphql-codegen-scala

@graphql-codegen 工具链的 scala 代码生成器。

代码生成器的开发似乎已经从 这个插件的基础 apollo 工具。 @graphql-codgen 使用 插件的概念允许您在不同的代码生成器上分层 任务以达到预期的输出。

这个代码生成器目前专注于为 scala.js 前端。

npm -i -D @graphql-codegen/cli @graphql-codegen/add
npm i -D @aappddeevv/graphql-codegen-scala

您应该使用其他@graphql-codgen 插件来实现 所需的输出包：

# yml configuration
schema: "schema.json" //generated separately from server
documents: "awesome_sub_project/src/main/graphql/*.graphql
generates:
  awesome_sub_project/target/scala-2.13/src_managed/main/cli_codegen/graphql.scala
    plugins:
      - @aappddeevv/graphql-codgen-scala
      - add: "// DO NOT EDIT"
      - add: "package awesome"
    config:
      gqlImport: "apollo_boost._#gql 
    hooks:
      afterOneFileWrite:
        - scalafmt

`

如果你想阅读干净的源代码，你只需要 scalafmt 钩子。 跳过 gqlImport 意味着文档没有内联到 操作对象。 apollo_boost 是 scala.js 发布的包 它有一个 gql 函数，它接受一个字符串并产生一个 graphql DocumentNode 通过 graphql 包编写 javascript 并由 apollo_boost scala.js 门面作为门面。

您不必对输出路径进行硬编码，您可以通过 将 sbt 的信息输出到“运行”脚本中。

sbt

您将希望直接将源代码生成到 项目的 src_generated 目录，然后 确保观看内容。 你可以拥有这个代码生成器 使用 sbt-cli-codgen 自动触发 插件并简单地将其配置为在源时运行 改变。

将 sbt-cli-codgen 插件安装到 project/plugins.sbt 中，然后：

// build.sbt
mycommand = (files: Seq[String]) => (Seq("npx", "graphql-codegen"), Seq("graphql.scala"))
lazy val proja = project.in(file("proja"))
  .enablePlugins(CLICodgenPlugin)
  .settings(
     // optional: watch the codegen config file itself
     watchSources += baseDirectory.value / "codegen.yml",
     codegenCommand := mycommand,
     // In this case, you could also add the schema.json file since the codegen config is independent
     // of the scala config.
     codegenInputSources := Seq(sourceDirectory.value.toGlob / "proja/src/main/graphql/*.graphql")
  )

上面的配置假定了一些 sbt-cli-codegen 默认值。 mycommand 制定了 要运行的命令和输出文件。 如果你需要将 sbt 中的内容插入到 yaml 配置文件，您可以在函数内部执行副作用。

您可以使用 sbt 触发重新运行或使用 @graphql-codegen 上的监视标志。

Evolution

codegen 插件没有处理所有的 graphql 构造，处于 flux，同时它增加了更多的 graphql 功能。