node-tree-sitter代码调用解析报错，CLI执行正常如何解决

问题描述 #

我尝试用tree-sitter解析自定义测试语言，编写了如下JS代码：

#!node
const Parser = require('tree-sitter');
const Kram = require('.');

const parser = new Parser();
parser.setLanguage(Kram);

const sourceCode = `
func foo(): bool {
    return 5;
}
`
const tree = parser.parse(sourceCode);

console.log(tree.rootNode.toString());

执行后始终输出(ERROR (UNEXPECTED 'f'))，提示解析第一个字符失败。但使用命令npm run tree-sitter parse examples/hello.kram解析包含相同代码的文件时，解析正常，输出正确语法树：

(source_file [2, 0] - [5, 0]
  (function_definition [2, 0] - [4, 1]
    (identifier [2, 5] - [2, 8])
    (parameter_list [2, 8] - [2, 10])
    (block [2, 17] - [4, 1]
      (return_statement [3, 4] - [3, 13]
        (number [3, 11] - [3, 12])))))

我的package.json中main字段已指向bindings/node，与tree-sitter-javascript的配置一致，请问还需进行哪些操作才能在JS中正常使用该解析器？

解决步骤 #

• 重新编译Node.js语言绑定
  命令行工具能正常解析不代表Node.js绑定已正确编译。执行以下命令重新生成并编译绑定：

  npx tree-sitter generate && npx tree-sitter build --bindings node
  

  编译完成后检查bindings/node目录下是否存在index.node文件，这是Node.js可加载的原生模块文件。

• 验证导入的语言对象有效性
  在代码中添加打印语句，确认require('.')返回的是合法的tree-sitter语言对象：

  console.log(Kram);
  

  正常的语言对象应包含name、grammar、nodeTypes属性，且存在_binding字段指向原生模块。若输出异常，需排查package.json的main路径或绑定编译过程。

• 排除空白字符干扰
  尝试移除源码开头的换行符，直接从func开始定义源码：

  const sourceCode = `func foo(): bool {
      return 5;
  }`;
  

  排除开头空白字符导致的解析异常。

• 修复Node.js版本兼容性问题
  若之前用不同版本Node.js编译过绑定，可能出现兼容性问题。执行以下命令清理后重新安装编译：

  rm -rf node_modules bindings
  npm install
  npx tree-sitter build --bindings node
  

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