2016-03-21 18 views
1

Typsecript tabanlı bir tepki uygulamasına sahibim. İyi çalışıyor ama Mix için TypeDoc (Typescript için JSDoc düşünün) eklemek istiyorum. yüklemeden sonra (bu test sadece tek bir dosya işleme) komut satırından bu çalıştırın:TypeDoc, "Modül bulamıyor" şikayetinde bulundu

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

ve bir hata alıyorum:

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

, aslında, yüklü tepki. TypeDoc'u global olarak ve yerel olarak kurmayı denedim ve hiçbir fark yaratmıyor (belki de global yükleme doğru node_modules'u bulamadı). Uygulama, Dizilerden derler ve iyi çalışır ... eksik modüller veya tür hataları ile ilgili şikayetleriniz yok ... sadece TypeDoc ile çalışmaz.

Herhangi bir öneriniz var mı? Tipografik bir React projesinde dokümantasyon oluşturmak için TypeDoc'un kasabanın tek oyunu olduğu için biraz sıkışmış durumdayım.

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

Ve varsayılan tema ile package.json bazı hata ettim:

cevap

5

Muhtemelen size yardımcı olur

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

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

+1

Özellikle '--ignoreCompilerErrors' ihtiyaç vardı . Hala bir şey bulamamaktan şikayet ediyordu ama yine de belgeleri oluşturdu. Teşekkürler! – Stuart

+0

Bu cevap ve sonraki yorum tam olarak ihtiyacım olan şeydi, yani ihtiyacım olan tek şey '--ignoreCompilerErrors' idi. Söylediğiniz gibi, çıktı hala şikayet ediyor ama belgeler hala üretiliyor. Daha iyi bir çözüm bulunana kadar, '--logger none 'ifadesinin eklenmesi şikayeti susturur ancak yine de yararlı oluşturma ilerleme çubuğunu bırakır, yani. [=== ... ===]% 100'. Sadece logger'ı susturmanın muhtemelen diğer olası hata mesajlarını da bastırdığını, bu yüzden dikkatle kullanacağını ve belki de her seferinde susturmadan bir seferde çalıştırabileceğine dikkat edin. –