【问题标题】:TypeDoc complains "Cannot find module"TypeDoc 抱怨“找不到模块”
【发布时间】:2016-07-08 12:19:21
【问题描述】:

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

typedoc --module commonjs --jsx react --out ../docs/ ./src/components/404/404.tsx

我得到一个错误:

Error: /path/to/project/src/components/404/404.tsx(0)
 Cannot find module 'react'.

事实上,React 已经安装好了。我已经尝试运行全局和本地安装的 TypeDoc,它没有区别(认为全局安装可能无法找到正确的 node_modules)。该应用程序从 Typescript 编译并运行良好...没有关于缺少模块或类型定义的抱怨...只是无法通过 TypeDoc 工作。

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

【问题讨论】:

    标签: reactjs typescript documentation typedoc


    【解决方案1】:

    可能对你有帮助:

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

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

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

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

    【讨论】:

    • 特别需要--ignoreCompilerErrors。它仍然抱怨找不到东西,但它仍然生成了文档。谢谢!
    • 这个答案和随后的评论正是我所需要的,即我所需要的只是--ignoreCompilerErrors。正如您所说,输出仍然会抱怨,但仍然会生成文档。在找到更好的解决方案之前,添加--logger none 可以消除抱怨,但仍然会留下有用的渲染进度条,即Rendering [===...===] 100%。请注意,使记录器静音可能还会抑制其他可能有意义的错误消息,因此请谨慎使用,并且可能在不静音的情况下每隔一段时间运行一次。
    • 我不得不运行npm i typedoc,而不是每次都使用npx typedoc --exclude... 拉动它。
    猜你喜欢
    • 2021-12-13
    • 2016-05-03
    • 1970-01-01
    • 1970-01-01
    • 2022-12-28
    • 1970-01-01
    • 2016-11-03
    • 1970-01-01
    • 2010-09-12
    相关资源
    最近更新 更多