启动JSDoc解析README.md时pipelineOperator插件配置错误如何解决

报错根因 #

该报错是JSDoc内置的Markdown解析器误将README文件里的Markdown一级标题#语法，识别为JavaScript管道运算符hack提案的主题引用语法导致的，和你提交的README内容合规性无关。

可执行解决方案 #

• 方案1：修改JSDoc配置文件（通常为jsdoc.json或.jsdoc.conf.json），指定使用GFM（GitHub Flavored Markdown）作为Markdown解析器，示例配置如下：

{
  "source": {
    "include": ["src", "README.md"]
  },
  "markdown": {
    "parser": "gfm"
  }
}

修改配置后重新启动JSDoc即可生效。

• 方案2：如果需要保留默认解析器，可在配置中添加Babel解析器参数，明确指定管道运算符的提案类型：

{
  "babelParserOpts": {
    "plugins": [
      ["pipelineOperator", { "proposal": "hack" }]
    ]
  }
}

• 方案3：升级JSDoc到最新稳定版，该语法误判问题在新版本中已得到修复。

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