执行从 bazel 规则作为参数传递的打字稿文件

Question

我正在 js 中为单声道回购编写 bazel 规则。 这背后的想法是 Mono repo（微服务）中的服务在开放的 api 模式文件中定义了 api 规范。 在我们的例子中，这些模式在 ts 文件中，因为规范被破坏，因为每个路由和最终规范文件导入每个路由模式并集成到最终对象。

我想在一个集中位置编写一个 bazel 规则，以便每个项目都可以加载规则并使用它的架构文件调用它

generate_yaml_from_ts(
    name = 'generate_yaml',
    schema = "src/api/routes/openapi.schema.ts"
)

我不确定是否所有架构文件（ openapi.schema.ts 导入其他 ts 文件）都需要对规则可用。

在规则中，我有一个 ts 代码，我想在其中引用传递的架构文件并生成yaml文件。 （如下所示，我知道静态导入不起作用）

import fs from 'fs';

import YAML from 'yaml';

import openapiJson from './src/api/routes/openapi.schema';

fs.writeFileSync(process.argv[2], YAML.stringify(openapiJson));

我创建了一个节点可执行文件以使用ts-node从代码运行，但问题是我们提供的输入也是ts文件，因此需要先编译。

我可以想到两种可能的方法来解决这个问题，但我都不确定该怎么做。

1. 在从服务传递到规则之前编译架构ts 。 （使用ts_library并将输出传递给规则？）
2. 在规则中创建 ts 可执行文件（在 bzl 文件中使用ts-node ）传递源文件连接generateYml.ts和传递的模式文件。

带有 bazel 设置的简单项目可在github 上找到

我写了一个规则来从项目中获取一个 json 文件并生成 yaml build/rules/json2yaml工作。

努力在build/rules/ts-yaml使用 type script it 做同样的事情。

我的问题如下

• 我可以使用ts_library并通过输出 bazel 规则吗？
• 我可以从服务传递 ts 文件并从规则 sile 编译和执行逻辑（更好）吗？

Answer 1

我能够找到一种方法来完成这件事，所以我会尝试解释它，所以如果其他人必须这样做，这可能会挽救他的一天。

首先，将ts文件作为参数传递的问题是它们需要在运行前编译。 通常，当您使用ts-node 、 ts_project或nodejs_binary创建可执行文件时，您已经拥有的处理部分会被编译，但参数不会。

所以我需要的是在运行时编译和执行打字稿的东西。 以下是我找到的解决方案。

您可以使用 require('ts-node').register({ /* options */ }) 来要求 ts-node 并注册加载器以备将来使用。 您还可以使用文件快捷方式 - node -r ts-node/register 或 node -r ts-node/register/transpile-only - 取决于您的偏好。 文档在这里

基本上，您可以在运行时执行以下操作并导入打字稿。

    require('ts-node').register({/* options */})
    
    const something = require('some-ts-file`);

所以我的 yaml 生成器代码可以使用它来导入作为参数传递的 ts 文件。

首先是规则的 BUILD.bazel

load("@build_bazel_rules_nodejs//:index.bzl", "nodejs_binary")

nodejs_binary(
    name = "ys-2-yaml",
    data = [
        "main.js",
        "@npm//yaml",
        "@npm//openapi-core",
        "@npm//ts-node"
    ],
    entry_point = "main.js",
    visibility = ["//visibility:public"],
)

main.js是要进行处理的文件。 它需要来自 npm 的yaml库，因此提供了ts-node以在运行时加载打字稿文件。

巴泽尔规则如下

"""Generate the openapi yml file from the JSON version."""
def _generateYaml(ctx):
    inputs = [] +   ctx.files.schemas
    inputs.extend(ctx.attr.generator[DefaultInfo].data_runfiles.files.to_list())

    ctx.actions.run(
        inputs = inputs,
        outputs = [ctx.outputs.yaml],
        arguments = [ctx.outputs.yaml.path, ctx.file.main_file.path],
        executable = ctx.executable.generator,
    )

ts_2_yaml = rule(
    implementation = _generateYaml,
    attrs = {
        "generator": attr.label(
            default = "//build/rules/tsnoderegister:ys-2-yaml",
            cfg = "target",
            executable = True,
        ),
        "schemas": attr.label_list(default = [], allow_files = True),
        "main_file": attr.label(
            allow_single_file = True,
            mandatory = True,
        ),
    },
    outputs = {
        "yaml": "openapi.yaml",
    },
)
    

可执行文件（生成器）是之前的nodejs_binary目标。 rule 需要两个参数。 schemas是 ts 代码中的架构文件。 这是多个文件的原因是模式被分解为不同的对象并与每个路由一起存储以提高可读性。 所以主模式文件导入并将所有内容附加在一起。 我需要另一个变量，以便规则知道哪个是主架构文件。 因此，通过传递给inputs和主 ts 文件使可执行文件可用的模式文件作为参数传递。

以下是main.js文件。

const fs = require("fs");
const yaml = require("yaml");

require("ts-node").register({
  transpileOnly: true,
  // insert other options with a boolean flag here
});

const schemaFile = require("../../../" + process.argv[3]);

fs.writeFileSync(process.argv[2], yaml.stringify(schemaFile));

基本上它导入传递的打字稿文件并解析为yaml并将其保存到文件中。 路径（因此../../../ ）存在一些问题，我需要更优雅地做。

最后的规则可用于传递模式的包中，如下所示。

load("//build/rules/tsnoderegister:runtimets.bzl", "ts_2_yaml")

ts_2_yaml(
    name = "generate_yaml",
    schemas = glob(["src/**/*schema.ts"]),
    main_file = "src/api/routes/openapi.schema.ts"
)

运行目标和规则将生成 yaml 文件

bazel build //services/my-sample-service:generate_yaml

bazel build //services/my-sample-service:generate_yaml
INFO: Analyzed target //services/my-sample-service:generate_yaml (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //services/my-sample-service:generate_yaml up-to-date:
  bazel-bin/services/my-sample-service/openapi.yaml
INFO: Elapsed time: 0.053s, Critical Path: 0.00s
INFO: 1 process: 1 internal.
INFO: Build completed successfully, 1 total action

链接到这个例子的 gihub代码