Node.js中支持控制流与迭代的YAML模板工具及实现问询

一、这类YAML模板的核心工作流程 #

Azure DevOps、GitHub Actions的YAML模板本质是带预处理逻辑的YAML扩展，核心流程分为三步：

1. 预处理：识别并执行模板语法 #

首先扫描YAML中的特殊标记（如${{ ... }}），优先执行标记内的循环、条件判断、变量引用等逻辑，生成纯YAML结构。
示例（Azure DevOps风格模板）：

# File: start.yml
parameters:
- name: buildSteps # 参数名称
  type: stepList # 参数类型为步骤列表
  default: [] # 默认空列表
stages:
- stage: secure_buildstage
  pool:
    vmImage: windows-latest
  jobs:
  - job: secure_buildjob
    steps:
    - script: echo This happens before code 
      displayName: 'Base: Pre-build'
    - script: echo Building
      displayName: 'Base: Build'

    - ${{ each step in parameters.buildSteps }}:
      - ${{ each pair in step }}:
          ${{ if ne(pair.value, 'CmdLine@2') }}:
            ${{ pair.key }}: ${{ pair.value }}       
          ${{ if eq(pair.value, 'CmdLine@2') }}: 
            # 通过语法错误拒绝该步骤
            '${{ pair.value }}': error         

    - script: echo This happens after code
      displayName: 'Base: Signing'

这段模板会先执行循环与条件判断，过滤掉CmdLine@2类型的步骤，再生成可执行的YAML。

2. 参数注入 #

将外部传入的参数（如用户定义的buildSteps）替换到模板对应位置，完成变量填充。

3. 执行与验证 #

将生成的纯YAML交给执行引擎，同时在预处理阶段可加入语法校验（如示例中拒绝非法步骤的逻辑）。

GitHub Actions的变量插值逻辑类似，示例：

name: GitHub Actions Demo
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v3
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

它会先将${{ github.event_name }}这类上下文变量替换为实际值，再执行步骤。

二、Node.js中可用的工具 #

1. 模板插值与逻辑处理 #

• Handlebars：与Azure DevOps使用的语法完全一致，支持循环、条件判断、自定义助手函数，可直接处理${{ ... }}风格的模板标记。
• EJS：支持嵌入原生JavaScript逻辑，灵活性更高，适合复杂预处理场景。
• Mustache：轻量级逻辑模板，适合简单变量插值，可通过扩展实现复杂逻辑。

2. YAML解析与序列化 #

• js-yaml：Node.js生态最常用的YAML处理库，支持YAML与JS对象互转，还支持自定义标签扩展。
• yaml：新一代YAML库，API更现代，性能更优，支持流式处理。

3. 典型工具链示例 #

用Handlebars + js-yaml的流程：

1. 读取YAML模板文件，作为文本传入Handlebars编译。
2. 传入参数上下文（如parameters、github变量），生成预处理后的纯YAML文本。
3. 用js-yaml解析生成的YAML，完成校验与执行准备。

三、手动实现的关键要点 #

若不想依赖现成引擎，自行实现核心逻辑需：

• 编写正则识别${{ ... }}标记，提取内部表达式。
• 实现表达式解析器：处理变量引用、each循环、if/eq/ne条件判断等逻辑。
• 将执行结果替换回原YAML文本，再解析为可执行结构。
• 添加校验逻辑：如预处理阶段检查非法步骤类型，抛出语法错误。

内容的提问来源于stack exchange，提问作者Lance Pollard