Node项目中如何获取JSON Pointer指定的YAML元素行号与列号

要实现这个需求，核心是用能保留源文件位置元数据的YAML解析库，然后根据JSON Pointer遍历解析后的AST（抽象语法树），提取对应元素的位置信息。下面是具体实现步骤：

1. 选择合适的解析库 #

推荐使用yaml（npm官方包），它原生支持解析时保留源标记（source tokens），能直接获取每个元素的行、列位置。安装方式：

npm install yaml

2. 解析YAML并保留位置信息 #

解析时开启keepSourceTokens: true选项，让每个AST节点都关联对应的源文件位置标记：

const yaml = require('yaml');

// 示例YAML内容
const yamlContent = `a: 1
b:
  - 42
  - foo # comment`;

// 解析为带源标记的文档对象
const doc = yaml.parseDocument(yamlContent, { keepSourceTokens: true });

3. 编写根据JSON Pointer获取位置的函数 #

需要处理JSON Pointer的转义规则（RFC6901），然后遍历AST找到目标节点并提取位置：

function getElementPosition(doc, jsonPointer) {
  // 拆分Pointer并处理转义：~0 → ~，~1 → /
  const pathParts = jsonPointer.slice(1).split('/').map(part => 
    part.replace(/~1/g, '/').replace(/~0/g, '~')
  );

  let currentNode = doc.contents;
  for (const part of pathParts) {
    // 处理对象节点（MAP类型）
    if (currentNode.type === 'MAP') {
      currentNode = currentNode.items.find(item => item.key.value === part)?.value;
    } 
    // 处理数组节点（SEQ类型）
    else if (currentNode.type === 'SEQ') {
      const index = parseInt(part, 10);
      currentNode = currentNode.items[index];
    }
    // 找不到对应节点时返回null
    if (!currentNode) return null;
  }

  // 提取源标记的位置信息
  const token = currentNode.sourceToken;
  if (!token) return null;

  // 转成用户习惯的1起始行列号（yaml库默认列是0起始）
  return {
    line: token.start.line,
    startCol: token.start.col + 1,
    endCol: token.end.col + 1,
    // 可选：保留库原生的0起始位置
    rawPosition: {
      start: { line: token.start.line, col: token.start.col },
      end: { line: token.end.line, col: token.end.col }
    }
  };
}

4. 测试示例 #

调用函数获取目标元素的位置：

const position = getElementPosition(doc, '/b/1');
console.log(position);

输出结果：

{
  line: 4,
  startCol: 4,
  endCol: 6,
  rawPosition: { start: { line: 4, col: 3 }, end: { line: 4, col: 5 } }
}

完全符合示例中/b/1位于第4行4-6列的预期。

关键注意事项 #

• 转义处理：必须严格遵循RFC6901规则处理Pointer中的转义字符，否则无法正确匹配带特殊字符的键（比如键包含/或~）。
• 注释忽略：YAML注释不会被解析为节点内容，所以位置信息只覆盖实际的元素值（比如示例中的# comment不会计入/b/1的范围）。
• 库版本差异：不同YAML解析库的位置信息格式可能不同，比如js-yaml需要通过自定义构造函数来捕获位置，复杂度更高，优先推荐yaml库。

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