2016-03-21 12 views
1

私はTypsecriptベースの反応アプリを持っています。それはうまく動作しますが、私はMixにTypeDoc(Typescript用のJSDocを考えてください)を追加したいと思います。それをインストールした後、私は(私はこれをテストとしてだけで1つのファイルを処理する)、コマンドラインからこれを実行します。TypeDocは「モジュールを見つけることができません」と苦情を言います

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'. 

は、実際には、インストールされて反応します。私はTypeDocをグローバルに、そしてローカルにインストールしてみましたが、違いはありません(グローバルインストールで正しいnode_modulesが見つからない可能性があります)。このアプリはTypescriptからコンパイルされ、うまく動作します...欠落しているモジュールやタイプの不具合についての苦情はありません。TypeDocでは動作しません。

提案がありますか? TypescriptベースのReactプロジェクトでドキュメンテーションを生成するためには、TypeDocが唯一の町でのゲームなので、ちょっと残念です。

答えて

5

おそらくそれはあなたを助けます:

'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",

+1

具体 '--ignoreCompilerErrors'が必要でした。それはまだ物事を見つけることについて不平を言ったが、それはまだドキュメンテーションを生成した。ありがとう! – Stuart

+0

この回答とそれ以降のコメントはまさに私が必要としていたものです。つまり、必要なのは '--ignoreCompilerErrors'でした。あなたが言うように、出力はまだ文句を言うが、ドキュメントはまだ生成されています。より良い解決策が見つかるまで、 '--logger none'を追加すると、不平を消しますが、有用なレンダリングプログレスバー、つまり'レンダリング[=== ... ===] 100% 'を残します。ロガーを消音することはおそらく他の意味のあるエラーメッセージも抑制することに注意してください。慎重に使用してください。 –

関連する問題