TypeDoc抱怨"找不到模块"

rg8*_*g88 3 documentation typescript reactjs typedoc

我有一个基于Typsecript的反应应用程序.它工作正常,但我想添加TypeDoc(想想JSDoc for Typescript)混合.安装后我从命令行运行它(在我测试时只处理一个文件):

typedoc --module commonjs --jsx react --out ../docs/ ./src/components/404/404.tsx
Run Code Online (Sandbox Code Playgroud)

我收到一个错误:

Error: /path/to/project/src/components/404/404.tsx(0)
 Cannot find module 'react'.
Run Code Online (Sandbox Code Playgroud)

事实上,React已经安装好了.我已经尝试在全局和本地安装运行TypeDoc,它没有任何区别(想想可能全局安装无法找到正确的node_modules).该应用程序从Typescript编译并运行良好...没有关于丢失模块或类型defs的投诉......只是不能通过TypeDoc工作.

有什么建议?似乎为了在基于Typescript的React项目中生成文档,TypeDoc是城里唯一的游戏,所以我有点卡住了.

小智 6

可能它会帮助你:

'node ./node_modules/typedoc/bin/typedoc ' +
(path || './src/scripts/') +
'--exclude node_modules ' +
'--ignoreCompilerErrors ' +
'--experimentalDecorators ' +
'--target ES6 ' +
'--jsx react'
Run Code Online (Sandbox Code Playgroud)

我注意到package.json中有一些默认主题的错误:

-- "typedoc-default-themes": "0.4.0",

++ "typedoc-default-themes": "0.3.4",

  • 特别需要`--ignoreCompilerErrors`。它仍然抱怨找不到东西,但它仍然生成了文档。谢谢! (2认同)