TypeDoc beschwert sich "Modul kann nicht gefunden werden"

Ich habe eine Typsecript basierte React App. Es funktioniert gut, aber ich möchte TypeDoc (denke JSDoc für Typescript) zu der Mischung hinzufügen. Ich betreiben diese von der Kommandozeile nach der Installation (nur eine einzelne Datei Verarbeitung, wie ich dies zu testen):TypeDoc beschwert sich "Modul kann nicht gefunden werden"

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

und ich erhalte eine Fehlermeldung:

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

Reagieren ist in der Tat installiert. Ich habe versucht, TypeDoc global und lokal installiert zu starten und es macht keinen Unterschied (dachte vielleicht, die globale Installation konnte nicht die richtigen node_module finden). Die App kompiliert von Typescript und läuft gut ... keine Beschwerden über fehlende Module oder Typ-Defs ... funktioniert einfach nicht über TypeDoc.

Irgendwelche Vorschläge? Es scheint, dass TypeDoc das einzige Spiel in der Stadt ist, um Dokumentation in einem typoskriptbasierten React-Projekt zu generieren.

Quelle

2016-03-21 Stuart

Wahrscheinlich hilft es Ihnen:

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

Und ich bemerkte, einige Fehler in package.json mit Standard-Theme:

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

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

Quelle

2016-03-22 13:38:55 Alerkesi

Insbesondere '--ignoreCompilerErrors' benötigt wurde . Es beschwerte sich immer noch darüber, keine Sachen zu finden, aber es erzeugte immer noch die Dokumentation. Vielen Dank! – Stuart

Diese Antwort und der folgende Kommentar war genau das, was ich brauchte, d. H. Alles was ich brauchte, war '--ignoreCompilerErrors'. Wie Sie sagen, beschwert sich die Ausgabe immer noch, aber die Dokumentation wird noch generiert. Bis eine bessere Lösung gefunden werden kann, wird durch das Hinzufügen von '--logger none' die Reklamation zum Schweigen gebracht, aber immer noch der hilfreiche Rendering-Fortschrittsbalken, d. H.' Rendering [=== ... ===] 100% '. Beachten Sie, dass das Stummschalten des Loggers wahrscheinlich auch andere möglicherweise aussagekräftige Fehlermeldungen unterdrückt, also verwenden Sie diese mit Vorsicht und führen Sie sie möglicherweise gelegentlich ohne Silencing aus. –

TypeDoc beschwert sich "Modul kann nicht gefunden werden"

Antwort

Verwandte Themen