Node.js读取tsconfig.json因首行注释无法解析为JSON如何解决

该类解析报错本质是：tsconfig.json 属于*JSONC（带注释的JSON）*格式，不是ECMA标准规定的严格JSON，原生JSON.parse仅识别无注释、无尾逗号的标准JSON，遇到文件头的块注释自然会抛出语法错误。

• 方案1：使用专用的JSONC解析库适配格式
  这种是最稳妥的零侵入方案，不需要修改tsconfig文件本身的注释，直接替换原有的JSON.parse逻辑即可。常用的适配库是jsonc-parser，这是TypeScript官方配套的解析工具，天生兼容tsconfig的注释语法。
  改造后的解析逻辑示例：

  // 先安装依赖：npm install jsonc-parser
  const tsConfigParser = require('jsonc-parser');
  
  function initTSConfig() {
    const filePath = path.join(__dirname, 'tsconfig.json');
    readFile(filePath)
      .then(content => {
        // 替换原有的JSON.parse逻辑
        const config = tsConfigParser.parse(content);
        console.log(config.compilerOptions.target);
        console.log(`---> TS Config was changed successfully`);
      })
      .catch(e => {
        console.log(`---> TS Config was not changed because of ${e}`);
      })
  }
  

• 方案2：通过TypeScript原生配置解析能力读取
  如果你项目本身已经依赖TypeScript，完全不需要额外安装库，直接用ts模块自带的配置解析方法即可。这个方法甚至能处理tsconfig里的extends继承路径、路径别名等特殊逻辑，解析精度最高。
  改造代码示例：

  // 项目已安装typescript可直接引入
  const ts = require('typescript');
  
  function initTSConfig() {
    const filePath = path.join(__dirname, 'tsconfig.json');
    // 直接读取解析tsconfig，自动处理注释
    const parsedConfig = ts.readConfigFile(filePath, ts.sys.readFile);
    if (parsedConfig.error) {
      throw new Error(parsedConfig.error.messageText);
    }
    const config = parsedConfig.config;
    console.log(config);
  }
  

• 方案3：手动剔除注释后走原生JSON.parse
  如果你不想引入任何第三方依赖，且确认你的tsconfig文件里的字符串值部分不会出现//或/*这类注释符号，可以用简单的正则把注释全部过滤后再解析。但要注意这个方法局限性很强，一旦配置值里写了带注释符号的字符串，就会出现解析错误，不推荐在生产环境使用。
  简单的过滤逻辑示例：

  const cleanContent = content
    // 过滤块注释
    .replace(/\/\*[\s\S]*?\*\//g, '')
    // 过滤行注释
    .replace(/\/\/.*$/g, '');
  const config = JSON.parse(cleanContent);
  

你当前实现的readFile函数存在逻辑漏洞：当文件读取报错执行reject后，没有中断后续执行逻辑，会继续走到resolve分支返回undefined，需要在reject语句后加return语句修正：

function readFile(filePath) {
  return new Promise((resolve, reject) => {
    fs.readFile(filePath, 'utf-8', (err, content) => {
      if (err) {
        console.warn(err);
        reject(err);
        // 中断后续执行，避免重复调用resolve
        return;
      }
      resolve(content);
    })
  })
}

额外注意：不要为了解析直接删除tsconfig里的注释，这类注释通常是框架脚手架自动生成的引导内容，删掉不影响运行但后续重新拉取模板时还会再次出现，本质还是要从解析层适配JSONC格式，而不是修改源文件。

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