dgeniを使用して、typescriptファイルのドキュメントコメントを解析する方法

Question

dgeniは、既存のjavascriptファイルからマークダウンドキュメントを抽出するように設定されています。私もtypescriptファイルを解析するためにそれを拡張しようとしています。

error: Error processing docs: Error: No file reader found for javascript/components/main.ts 
    at matchFileReader (node_modules\dgeni-packages\base\processors\read-files.js:130:25) 
    at node_modules\dgeni-packages\base\processors\read-files.js:66:99 
    at <anonymous> 

私はdgeni-packages:3e07adee84b7a795a0fb02d7181effa593fb9b4fようないくつかのコミットを見つけて、私は再び検索すると、セットアップdgeniにどのように探しています：私は、ソースファイルへ.tsファイルを追加すると思っ

は、問題を解決するが、それはいくつかのエラーを発生させます含まれています。あまりにも、typescriptですファイルを解析するためにdgeni取得する簡単な方法はあり

'use strict'; 

const path = require('canonical-path'); 
const {Dgeni, Package} = require('dgeni'); 

const docs= new Package('docs', [ 
    require('dgeni-markdown') 
]) 
    .processor(require('./indexPage')) 
    .config(function (log, readFilesProcessor, writeFilesProcessor, templateFinder, apiPagesProcessor) { 
    log.level = 'warn'; 
    readFilesProcessor.basePath = path.resolve(__dirname, '..'); 
    readFilesProcessor.sourceFiles = [ 
     { 
     include: 'src/main/javascript/**/*.js', 
     basePath: 'src/main/javascript' 
     }, 
    ]; 
    templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); 
    apiPagesProcessor.pathFromOutputToRootFolder = '../..'; 
    writeFilesProcessor.outputFolder = 'docs/generated'; 
    }); 
const dgeni = new Dgeni([docs]); 

module.exports =() => dgeni.generate().then(done); 

dgeni.generate().then(done); 

function done() { 
    console.log('Generated documentation.'); 
} 

：

私たちは、と私たちのドキュメントを生成しますか？同じようなコメントのために：私はdgeni-markdown前dgeni-packages/typescriptパッケージを追加

/** 
* @ngdoc directive 
* @module we.components 
* @name contactSlideout 
* @restrict E 
* 
* @description 
* Contact Slideout. 
* 
*/ 

Answer 1

、readTypeScriptModulesを設定し、ドキュメントが直接輸出を上回っていることを確認しました。

const docs = new Package('docs', [ 
    require('dgeni-packages/typescript'), 
    require('dgeni-markdown') 
]) 
.config(function (readTypeScriptModules) { 
    readTypeScriptModules.basePath = path.resolve(__dirname, '..'); 
    readTypeScriptModules.sourceFiles = [ 
    { 
     include: 'src/main/javascript/**/*.ts', 
     basePath: 'src/main/javascript' 
    }]; 
}); 

ドキュメントがエクスポートのすぐ上にあることを確認してください。

/** 
* @ngdoc directive 
* @module we.components 
* @name contactSlideout 
* @restrict E 
* 
* @description 
* Der Tooltip-Teil vom Contact-Menü. Zu verwenden zusammen mit hmContactSlideout. 
* 
*/ 
export default module.component('contactSlideout', { 

typescriptですサポートがある追加そのコミット：3e07adee8、深く掘るする必要がある人のために。