typedoc 0.15.4 → 0.15.8

package/dist/lib/application.js

@@ -138,7 +138,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         ].join(typescript.sys.newLine);
     }
 };
-Application.VERSION = '0.15.4';
+Application.VERSION = '0.15.8';
 __decorate([
     component_1.Option({
         name: 'logger',

package/dist/lib/converter/converter.js

@@ -146,6 +146,9 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         includedSourceFiles.forEach((sourceFile) => {
             this.convertNode(context, sourceFile);
         });
+        if (this.application.ignoreCompilerErrors) {
+            return [];
+        }
         let diagnostics = program.getOptionsDiagnostics().filter(isRelevantError);
         if (diagnostics.length) {
             return diagnostics;

package/dist/lib/converter/converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/lib/converter/converter.ts"],"names":[],"mappings":";;;;;;;;;AAAA,iCAAiC;AAEjC,4BAA4B;AAG5B,8DAA6D;AAE7D,uCAAoC;AACpC,6CAAwI;AACxI,kDAA2F;AAC3F,oCAA4C;AAC5C,0CAAiD;AAqBjD,IAAa,SAAS,iBAAtB,MAAa,SAAU,SAAQ,8BAAmD;IAkK9E,UAAU;QACN,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,YAAY,CAA2C,IAAY,EAAE,cAAqC;QACtG,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC3D,IAAI,SAAS,YAAY,mCAAsB,EAAE;YAC7C,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;SACpC;aAAM,IAAI,SAAS,YAAY,mCAAsB,EAAE;YACpD,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;SACpC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,gBAAgB,CAAC,SAAsC;QAC3D,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,QAAQ,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;SAC7C;IACL,CAAC;IAEO,gBAAgB,CAAC,SAAiC;QACtD,IAAI,cAAc,IAAI,SAAS,IAAI,aAAa,IAAI,SAAS,EAAE;YAC3D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAA+B,SAAS,CAAC,CAAC;YACtE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;QAED,IAAI,cAAc,IAAI,SAAS,IAAI,aAAa,IAAI,SAAS,EAAE;YAC3D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAA0B,SAAS,CAAC,CAAC;YACjE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;IACL,CAAC;IAED,eAAe,CAAC,IAAY;QACxB,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,SAAS,YAAY,mCAAsB,EAAE;YAC7C,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SACvC;aAAM,IAAI,SAAS,YAAY,mCAAsB,EAAE;YACpD,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SACvC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,mBAAmB,CAAC,SAAsC;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;QACvC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACpB,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC/B,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;aAC1B;SACJ;IACL,CAAC;IAEO,mBAAmB,CAAC,SAAiC;QACzD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAO,SAAS,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;YAClB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAChD;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAO,SAAS,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;YAClB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAChD;IACL,CAAC;IAED,mBAAmB;QACf,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IACjC,CAAC;IAOD,OAAO,CAAC,SAAmB;QACvB,MAAM,eAAe,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAa,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;QACjG,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAErE,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO;YACH,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,OAAO;SACnB,CAAC;IACN,CAAC;IAWD,WAAW,CAAC,OAAgB,EAAE,IAAa;QACvC,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACnC,OAAO;SACV;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3C,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,MAA8B,CAAC;QACnC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE;YAClC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAClE;QAED,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC;QACnC,OAAO,MAAM,CAAC;IAClB,CAAC;IAUD,WAAW,CAAC,OAAgB,EAAE,IAAc,EAAE,IAAc;QAExD,IAAI,IAAI,EAAE;YACN,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAE/C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBAC7C,IAAI,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE;oBAC7C,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;iBACrD;aACJ;SACJ;QAGD,IAAI,IAAI,EAAE;YACN,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBAC7C,IAAI,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;oBACvC,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC/C;aACJ;SACJ;IACL,CAAC;IAQD,YAAY,CAAC,OAAgB,EAAE,QAAgC,EAAE,EAAE,QAAgC,EAAE;QACjG,MAAM,MAAM,GAAW,EAAE,CAAC;QAC1B,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACzC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,EAAE;gBACX,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1B;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAQO,OAAO,CAAC,OAAgB;QAC5B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAEhC,MAAM,OAAO,GAAG,uBAAe,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,UAAU,GAAG,CAAC,IAAmB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAExF,MAAM,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE;aAC/C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACvC,MAAM,eAAe,GAAG,CAAC,EAAE,IAAI,EAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjG,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACvC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,WAAW,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC1E,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACxE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACrE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,OAAO,EAAE,CAAC;IACd,CAAC;IAQO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAEhC,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,WAAW,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE;gBACzC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;SAC3E;QAED,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC;IACnB,CAAC;IAOD,aAAa;QACT,OAAO,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACnF,CAAC;CACJ,CAAA;AA7UU,qBAAW,GAAG,OAAO,CAAC;AAOtB,mBAAS,GAAG,KAAK,CAAC;AAWlB,0BAAgB,GAAG,WAAW,CAAC;AAO/B,kCAAwB,GAAG,mBAAmB,CAAC;AAO/C,gCAAsB,GAAG,iBAAiB,CAAC;AAO3C,gCAAsB,GAAG,iBAAiB,CAAC;AAO3C,qCAA2B,GAAG,qBAAqB,CAAC;AAOpD,uCAA6B,GAAG,wBAAwB,CAAC;AAWzD,6BAAmB,GAAG,cAAc,CAAC;AAOrC,uBAAa,GAAG,mBAAmB,CAAC;AAOpC,2BAAiB,GAAG,YAAY,CAAC;AAlJxC;IAJC,kBAAM,CAAC;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,8EAA8E;KACvF,CAAC;uCACY;AAOd;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,qEAAqE;QAC3E,IAAI,EAAE,2BAAa,CAAC,KAAK;KAC5B,CAAC;kDAC8B;AAOhC;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,6CAA6C;QACnD,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;sDAC4B;AAO9B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,qEAAqE;QAC3E,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;mDACyB;AAO3B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,8DAA8D;QACpE,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;qDAC2B;AAO7B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,uCAAuC;QAC7C,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;iDACuB;AAOzB;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,yCAAyC;QAC/C,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;mDACyB;AAlDlB,SAAS;IADrB,qBAAS,CAAC,EAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,+BAAkB,EAAC,CAAC;GAClE,SAAS,CAyZrB;AAzZY,8BAAS","sourcesContent":["import * as ts from 'typescript';\nimport * as _ts from '../ts-internal';\nimport * as _ from 'lodash';\n\nimport { Application } from '../application';\nimport { ParameterType } from '../utils/options/declaration';\nimport { Reflection, Type, ProjectReflection } from '../models/index';\nimport { Context } from './context';\nimport { ConverterComponent, ConverterNodeComponent, ConverterTypeComponent, TypeTypeConverter, TypeNodeConverter } from './components';\nimport { Component, Option, ChildableComponent, ComponentClass } from '../utils/component';\nimport { normalizePath } from '../utils/fs';\nimport { createMinimatch } from '../utils/paths';\n\n/**\n * Result structure of the [[Converter.convert]] method.\n */\nexport interface ConverterResult {\n    /**\n     * An array containing all errors generated by the TypeScript compiler.\n     */\n    errors: ReadonlyArray<ts.Diagnostic>;\n\n    /**\n     * The resulting project reflection.\n     */\n    project: ProjectReflection;\n}\n\n/**\n * Compiles source files using TypeScript and converts compiler symbols to reflections.\n */\n@Component({name: 'converter', internal: true, childClass: ConverterComponent})\nexport class Converter extends ChildableComponent<Application, ConverterComponent> {\n    /**\n     * The human readable name of the project. Used within the templates to set the title of the document.\n     */\n    @Option({\n        name: 'name',\n        help: 'Set the name of the project that will be used in the header of the template.'\n    })\n    name!: string;\n\n    @Option({\n        name: 'externalPattern',\n        help: 'Define patterns for files that should be considered being external.',\n        type: ParameterType.Array\n    })\n    externalPattern!: Array<string>;\n\n    @Option({\n        name: 'includeDeclarations',\n        help: 'Turn on parsing of .d.ts declaration files.',\n        type: ParameterType.Boolean\n    })\n    includeDeclarations!: boolean;\n\n    @Option({\n        name: 'excludeExternals',\n        help: 'Prevent externally resolved TypeScript files from being documented.',\n        type: ParameterType.Boolean\n    })\n    excludeExternals!: boolean;\n\n    @Option({\n        name: 'excludeNotExported',\n        help: 'Prevent symbols that are not exported from being documented.',\n        type: ParameterType.Boolean\n    })\n    excludeNotExported!: boolean;\n\n    @Option({\n        name: 'excludePrivate',\n        help: 'Ignores private variables and methods',\n        type: ParameterType.Boolean\n    })\n    excludePrivate!: boolean;\n\n    @Option({\n        name: 'excludeProtected',\n        help: 'Ignores protected variables and methods',\n        type: ParameterType.Boolean\n    })\n    excludeProtected!: boolean;\n\n    /**\n     * Defined in the initialize method\n     */\n    private nodeConverters!: {[syntaxKind: number]: ConverterNodeComponent<ts.Node>};\n\n    /**\n     * Defined in the initialize method\n     */\n    private typeNodeConverters!: TypeNodeConverter<ts.Type, ts.Node>[];\n\n    /**\n     * Defined in the initialize method\n     */\n    private typeTypeConverters!: TypeTypeConverter<ts.Type>[];\n\n    /**\n     * General events\n     */\n\n    /**\n     * Triggered when the converter begins converting a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_BEGIN = 'begin';\n\n    /**\n     * Triggered when the converter has finished converting a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_END = 'end';\n\n    /**\n     * Factory events\n     */\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_FILE_BEGIN = 'fileBegin';\n\n    /**\n     * Triggered when the converter has created a declaration reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_DECLARATION = 'createDeclaration';\n\n    /**\n     * Triggered when the converter has created a signature reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_SIGNATURE = 'createSignature';\n\n    /**\n     * Triggered when the converter has created a parameter reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_PARAMETER = 'createParameter';\n\n    /**\n     * Triggered when the converter has created a type parameter reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_TYPE_PARAMETER = 'createTypeParameter';\n\n    /**\n     * Triggered when the converter has found a function implementation.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_FUNCTION_IMPLEMENTATION = 'functionImplementation';\n\n    /**\n     * Resolve events\n     */\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE_BEGIN = 'resolveBegin';\n\n    /**\n     * Triggered when the converter resolves a reflection.\n     * The listener should implement [[IConverterResolveCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE = 'resolveReflection';\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE_END = 'resolveEnd';\n\n    /**\n     * Create a new Converter instance.\n     *\n     * @param application  The application instance this converter relies on. The application\n     *   must expose the settings that should be used and serves as a global logging endpoint.\n     */\n    initialize() {\n        this.nodeConverters = {};\n        this.typeTypeConverters = [];\n        this.typeNodeConverters = [];\n    }\n\n    addComponent<T extends ConverterComponent & Component>(name: string, componentClass: T | ComponentClass<T>): T {\n        const component = super.addComponent(name, componentClass);\n        if (component instanceof ConverterNodeComponent) {\n            this.addNodeConverter(component);\n        } else if (component instanceof ConverterTypeComponent) {\n            this.addTypeConverter(component);\n        }\n\n        return component;\n    }\n\n    private addNodeConverter(converter: ConverterNodeComponent<any>) {\n        for (const supports of converter.supports) {\n            this.nodeConverters[supports] = converter;\n        }\n    }\n\n    private addTypeConverter(converter: ConverterTypeComponent) {\n        if ('supportsNode' in converter && 'convertNode' in converter) {\n            this.typeNodeConverters.push(<TypeNodeConverter<any, any>> converter);\n            this.typeNodeConverters.sort((a, b) => b.priority - a.priority);\n        }\n\n        if ('supportsType' in converter && 'convertType' in converter) {\n            this.typeTypeConverters.push(<TypeTypeConverter<any>> converter);\n            this.typeTypeConverters.sort((a, b) => b.priority - a.priority);\n        }\n    }\n\n    removeComponent(name: string): ConverterComponent | undefined {\n        const component = super.removeComponent(name);\n        if (component instanceof ConverterNodeComponent) {\n            this.removeNodeConverter(component);\n        } else if (component instanceof ConverterTypeComponent) {\n            this.removeTypeConverter(component);\n        }\n\n        return component;\n    }\n\n    private removeNodeConverter(converter: ConverterNodeComponent<any>) {\n        const converters = this.nodeConverters;\n        const keys = _.keys(this.nodeConverters);\n        for (const key of keys) {\n            if (converters[key] === converter) {\n                delete converters[key];\n            }\n        }\n    }\n\n    private removeTypeConverter(converter: ConverterTypeComponent) {\n        const typeIndex = this.typeTypeConverters.indexOf(<any> converter);\n        if (typeIndex !== -1) {\n            this.typeTypeConverters.splice(typeIndex, 1);\n        }\n\n        const nodeIndex = this.typeNodeConverters.indexOf(<any> converter);\n        if (nodeIndex !== -1) {\n            this.typeNodeConverters.splice(nodeIndex, 1);\n        }\n    }\n\n    removeAllComponents() {\n        super.removeAllComponents();\n\n        this.nodeConverters = {};\n        this.typeTypeConverters = [];\n        this.typeNodeConverters = [];\n    }\n\n    /**\n     * Compile the given source files and create a project reflection for them.\n     *\n     * @param fileNames  Array of the file names that should be compiled.\n     */\n    convert(fileNames: string[]): ConverterResult {\n        const normalizedFiles = fileNames.map(normalizePath);\n\n        const program = ts.createProgram(normalizedFiles, this.application.options.getCompilerOptions());\n        const checker = program.getTypeChecker();\n        const context = new Context(this, normalizedFiles, checker, program);\n\n        this.trigger(Converter.EVENT_BEGIN, context);\n\n        const errors = this.compile(context);\n        const project = this.resolve(context);\n\n        this.trigger(Converter.EVENT_END, context);\n\n        return {\n            errors: errors,\n            project: project\n        };\n    }\n\n    /**\n     * Analyze the given node and create a suitable reflection.\n     *\n     * This function checks the kind of the node and delegates to the matching function implementation.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node     The compiler node that should be analyzed.\n     * @return The resulting reflection or undefined.\n     */\n    convertNode(context: Context, node: ts.Node): Reflection | undefined {\n        if (context.visitStack.includes(node)) {\n            return;\n        }\n\n        const oldVisitStack = context.visitStack;\n        context.visitStack = oldVisitStack.slice();\n        context.visitStack.push(node);\n\n        let result: Reflection | undefined;\n        if (node.kind in this.nodeConverters) {\n            result = this.nodeConverters[node.kind].convert(context, node);\n        }\n\n        context.visitStack = oldVisitStack;\n        return result;\n    }\n\n    /**\n     * Convert the given TypeScript type into its TypeDoc type reflection.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node  The node whose type should be reflected.\n     * @param type  The type of the node if already known.\n     * @returns The TypeDoc type reflection representing the given node and type.\n     */\n    convertType(context: Context, node?: ts.Node, type?: ts.Type): Type | undefined {\n        // Run all node based type conversions\n        if (node) {\n            type = type || context.getTypeAtLocation(node);\n\n            for (const converter of this.typeNodeConverters) {\n                if (converter.supportsNode(context, node, type)) {\n                    return converter.convertNode(context, node, type);\n                }\n            }\n        }\n\n        // Run all type based type conversions\n        if (type) {\n            for (const converter of this.typeTypeConverters) {\n                if (converter.supportsType(context, type)) {\n                    return converter.convertType(context, type);\n                }\n            }\n        }\n    }\n\n    /**\n     * Helper function to convert multiple types at once, filtering out types which fail to convert.\n     *\n     * @param context\n     * @param nodes\n     */\n    convertTypes(context: Context, nodes: ReadonlyArray<ts.Node> = [], types: ReadonlyArray<ts.Type> = []): Type[] {\n        const result: Type[] = [];\n        _.zip(nodes, types).forEach(([node, type]) => {\n            const converted = this.convertType(context, node, type);\n            if (converted) {\n                result.push(converted);\n            }\n        });\n        return result;\n    }\n\n    /**\n     * Compile the files within the given context and convert the compiler symbols to reflections.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @returns An array containing all errors generated by the TypeScript compiler.\n     */\n    private compile(context: Context): ReadonlyArray<ts.Diagnostic> {\n        const program = context.program;\n\n        const exclude = createMinimatch(this.application.exclude || []);\n        const isExcluded = (file: ts.SourceFile) => exclude.some(mm => mm.match(file.fileName));\n\n        const includedSourceFiles = program.getSourceFiles()\n            .filter(file => !isExcluded(file));\n        const isRelevantError = ({ file }: ts.Diagnostic) => !file || includedSourceFiles.includes(file);\n\n        includedSourceFiles.forEach((sourceFile) => {\n            this.convertNode(context, sourceFile);\n        });\n\n        let diagnostics = program.getOptionsDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getSyntacticDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getGlobalDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getSemanticDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        return [];\n    }\n\n    /**\n     * Resolve the project within the given context.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @returns The final project reflection.\n     */\n    private resolve(context: Context): ProjectReflection {\n        this.trigger(Converter.EVENT_RESOLVE_BEGIN, context);\n        const project = context.project;\n\n        for (const id in project.reflections) {\n            if (!project.reflections.hasOwnProperty(id)) {\n                continue;\n            }\n            this.trigger(Converter.EVENT_RESOLVE, context, project.reflections[id]);\n        }\n\n        this.trigger(Converter.EVENT_RESOLVE_END, context);\n        return project;\n    }\n\n    /**\n     * Return the basename of the default library that should be used.\n     *\n     * @returns The basename of the default library.\n     */\n    getDefaultLib(): string {\n        return ts.getDefaultLibFileName(this.application.options.getCompilerOptions());\n    }\n}\n"]}
+{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/lib/converter/converter.ts"],"names":[],"mappings":";;;;;;;;;AAAA,iCAAiC;AAEjC,4BAA4B;AAG5B,8DAA6D;AAE7D,uCAAoC;AACpC,6CAAwI;AACxI,kDAA2F;AAC3F,oCAA4C;AAC5C,0CAAiD;AAqBjD,IAAa,SAAS,iBAAtB,MAAa,SAAU,SAAQ,8BAAmD;IAkK9E,UAAU;QACN,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,YAAY,CAA2C,IAAY,EAAE,cAAqC;QACtG,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC3D,IAAI,SAAS,YAAY,mCAAsB,EAAE;YAC7C,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;SACpC;aAAM,IAAI,SAAS,YAAY,mCAAsB,EAAE;YACpD,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;SACpC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,gBAAgB,CAAC,SAAsC;QAC3D,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,QAAQ,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;SAC7C;IACL,CAAC;IAEO,gBAAgB,CAAC,SAAiC;QACtD,IAAI,cAAc,IAAI,SAAS,IAAI,aAAa,IAAI,SAAS,EAAE;YAC3D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAA+B,SAAS,CAAC,CAAC;YACtE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;QAED,IAAI,cAAc,IAAI,SAAS,IAAI,aAAa,IAAI,SAAS,EAAE;YAC3D,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAA0B,SAAS,CAAC,CAAC;YACjE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;IACL,CAAC;IAED,eAAe,CAAC,IAAY;QACxB,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,SAAS,YAAY,mCAAsB,EAAE;YAC7C,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SACvC;aAAM,IAAI,SAAS,YAAY,mCAAsB,EAAE;YACpD,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;SACvC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,mBAAmB,CAAC,SAAsC;QAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC;QACvC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACpB,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC/B,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;aAC1B;SACJ;IACL,CAAC;IAEO,mBAAmB,CAAC,SAAiC;QACzD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAO,SAAS,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;YAClB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAChD;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAO,SAAS,CAAC,CAAC;QACnE,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;YAClB,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SAChD;IACL,CAAC;IAED,mBAAmB;QACf,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IACjC,CAAC;IAOD,OAAO,CAAC,SAAmB;QACvB,MAAM,eAAe,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAa,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;QACjG,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAErE,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE7C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO;YACH,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,OAAO;SACnB,CAAC;IACN,CAAC;IAWD,WAAW,CAAC,OAAgB,EAAE,IAAa;QACvC,IAAI,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACnC,OAAO;SACV;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3C,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,MAA8B,CAAC;QACnC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE;YAClC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAClE;QAED,OAAO,CAAC,UAAU,GAAG,aAAa,CAAC;QACnC,OAAO,MAAM,CAAC;IAClB,CAAC;IAUD,WAAW,CAAC,OAAgB,EAAE,IAAc,EAAE,IAAc;QAExD,IAAI,IAAI,EAAE;YACN,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAE/C,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBAC7C,IAAI,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE;oBAC7C,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;iBACrD;aACJ;SACJ;QAGD,IAAI,IAAI,EAAE;YACN,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBAC7C,IAAI,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;oBACvC,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC/C;aACJ;SACJ;IACL,CAAC;IAQD,YAAY,CAAC,OAAgB,EAAE,QAAgC,EAAE,EAAE,QAAgC,EAAE;QACjG,MAAM,MAAM,GAAW,EAAE,CAAC;QAC1B,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACzC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,EAAE;gBACX,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1B;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAQO,OAAO,CAAC,OAAgB;QAC5B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAEhC,MAAM,OAAO,GAAG,uBAAe,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAChE,MAAM,UAAU,GAAG,CAAC,IAAmB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAExF,MAAM,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE;aAC/C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACvC,MAAM,eAAe,GAAG,CAAC,EAAE,IAAI,EAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjG,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACvC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;YACvC,OAAO,EAAE,CAAC;SACb;QAED,IAAI,WAAW,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC1E,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACxE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACrE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,WAAW,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,WAAW,CAAC,MAAM,EAAE;YACpB,OAAO,WAAW,CAAC;SACtB;QAED,OAAO,EAAE,CAAC;IACd,CAAC;IAQO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAEhC,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,WAAW,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE;gBACzC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;SAC3E;QAED,IAAI,CAAC,OAAO,CAAC,WAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,OAAO,CAAC;IACnB,CAAC;IAOD,aAAa;QACT,OAAO,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACnF,CAAC;CACJ,CAAA;AAjVU,qBAAW,GAAG,OAAO,CAAC;AAOtB,mBAAS,GAAG,KAAK,CAAC;AAWlB,0BAAgB,GAAG,WAAW,CAAC;AAO/B,kCAAwB,GAAG,mBAAmB,CAAC;AAO/C,gCAAsB,GAAG,iBAAiB,CAAC;AAO3C,gCAAsB,GAAG,iBAAiB,CAAC;AAO3C,qCAA2B,GAAG,qBAAqB,CAAC;AAOpD,uCAA6B,GAAG,wBAAwB,CAAC;AAWzD,6BAAmB,GAAG,cAAc,CAAC;AAOrC,uBAAa,GAAG,mBAAmB,CAAC;AAOpC,2BAAiB,GAAG,YAAY,CAAC;AAlJxC;IAJC,kBAAM,CAAC;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,8EAA8E;KACvF,CAAC;uCACY;AAOd;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,qEAAqE;QAC3E,IAAI,EAAE,2BAAa,CAAC,KAAK;KAC5B,CAAC;kDAC8B;AAOhC;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,6CAA6C;QACnD,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;sDAC4B;AAO9B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,qEAAqE;QAC3E,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;mDACyB;AAO3B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,8DAA8D;QACpE,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;qDAC2B;AAO7B;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,uCAAuC;QAC7C,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;iDACuB;AAOzB;IALC,kBAAM,CAAC;QACJ,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,yCAAyC;QAC/C,IAAI,EAAE,2BAAa,CAAC,OAAO;KAC9B,CAAC;mDACyB;AAlDlB,SAAS;IADrB,qBAAS,CAAC,EAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,+BAAkB,EAAC,CAAC;GAClE,SAAS,CA6ZrB;AA7ZY,8BAAS","sourcesContent":["import * as ts from 'typescript';\nimport * as _ts from '../ts-internal';\nimport * as _ from 'lodash';\n\nimport { Application } from '../application';\nimport { ParameterType } from '../utils/options/declaration';\nimport { Reflection, Type, ProjectReflection } from '../models/index';\nimport { Context } from './context';\nimport { ConverterComponent, ConverterNodeComponent, ConverterTypeComponent, TypeTypeConverter, TypeNodeConverter } from './components';\nimport { Component, Option, ChildableComponent, ComponentClass } from '../utils/component';\nimport { normalizePath } from '../utils/fs';\nimport { createMinimatch } from '../utils/paths';\n\n/**\n * Result structure of the [[Converter.convert]] method.\n */\nexport interface ConverterResult {\n    /**\n     * An array containing all errors generated by the TypeScript compiler.\n     */\n    errors: ReadonlyArray<ts.Diagnostic>;\n\n    /**\n     * The resulting project reflection.\n     */\n    project: ProjectReflection;\n}\n\n/**\n * Compiles source files using TypeScript and converts compiler symbols to reflections.\n */\n@Component({name: 'converter', internal: true, childClass: ConverterComponent})\nexport class Converter extends ChildableComponent<Application, ConverterComponent> {\n    /**\n     * The human readable name of the project. Used within the templates to set the title of the document.\n     */\n    @Option({\n        name: 'name',\n        help: 'Set the name of the project that will be used in the header of the template.'\n    })\n    name!: string;\n\n    @Option({\n        name: 'externalPattern',\n        help: 'Define patterns for files that should be considered being external.',\n        type: ParameterType.Array\n    })\n    externalPattern!: Array<string>;\n\n    @Option({\n        name: 'includeDeclarations',\n        help: 'Turn on parsing of .d.ts declaration files.',\n        type: ParameterType.Boolean\n    })\n    includeDeclarations!: boolean;\n\n    @Option({\n        name: 'excludeExternals',\n        help: 'Prevent externally resolved TypeScript files from being documented.',\n        type: ParameterType.Boolean\n    })\n    excludeExternals!: boolean;\n\n    @Option({\n        name: 'excludeNotExported',\n        help: 'Prevent symbols that are not exported from being documented.',\n        type: ParameterType.Boolean\n    })\n    excludeNotExported!: boolean;\n\n    @Option({\n        name: 'excludePrivate',\n        help: 'Ignores private variables and methods',\n        type: ParameterType.Boolean\n    })\n    excludePrivate!: boolean;\n\n    @Option({\n        name: 'excludeProtected',\n        help: 'Ignores protected variables and methods',\n        type: ParameterType.Boolean\n    })\n    excludeProtected!: boolean;\n\n    /**\n     * Defined in the initialize method\n     */\n    private nodeConverters!: {[syntaxKind: number]: ConverterNodeComponent<ts.Node>};\n\n    /**\n     * Defined in the initialize method\n     */\n    private typeNodeConverters!: TypeNodeConverter<ts.Type, ts.Node>[];\n\n    /**\n     * Defined in the initialize method\n     */\n    private typeTypeConverters!: TypeTypeConverter<ts.Type>[];\n\n    /**\n     * General events\n     */\n\n    /**\n     * Triggered when the converter begins converting a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_BEGIN = 'begin';\n\n    /**\n     * Triggered when the converter has finished converting a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_END = 'end';\n\n    /**\n     * Factory events\n     */\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_FILE_BEGIN = 'fileBegin';\n\n    /**\n     * Triggered when the converter has created a declaration reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_DECLARATION = 'createDeclaration';\n\n    /**\n     * Triggered when the converter has created a signature reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_SIGNATURE = 'createSignature';\n\n    /**\n     * Triggered when the converter has created a parameter reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_PARAMETER = 'createParameter';\n\n    /**\n     * Triggered when the converter has created a type parameter reflection.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_CREATE_TYPE_PARAMETER = 'createTypeParameter';\n\n    /**\n     * Triggered when the converter has found a function implementation.\n     * The listener should implement [[IConverterNodeCallback]].\n     * @event\n     */\n    static EVENT_FUNCTION_IMPLEMENTATION = 'functionImplementation';\n\n    /**\n     * Resolve events\n     */\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE_BEGIN = 'resolveBegin';\n\n    /**\n     * Triggered when the converter resolves a reflection.\n     * The listener should implement [[IConverterResolveCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE = 'resolveReflection';\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     * The listener should implement [[IConverterCallback]].\n     * @event\n     */\n    static EVENT_RESOLVE_END = 'resolveEnd';\n\n    /**\n     * Create a new Converter instance.\n     *\n     * @param application  The application instance this converter relies on. The application\n     *   must expose the settings that should be used and serves as a global logging endpoint.\n     */\n    initialize() {\n        this.nodeConverters = {};\n        this.typeTypeConverters = [];\n        this.typeNodeConverters = [];\n    }\n\n    addComponent<T extends ConverterComponent & Component>(name: string, componentClass: T | ComponentClass<T>): T {\n        const component = super.addComponent(name, componentClass);\n        if (component instanceof ConverterNodeComponent) {\n            this.addNodeConverter(component);\n        } else if (component instanceof ConverterTypeComponent) {\n            this.addTypeConverter(component);\n        }\n\n        return component;\n    }\n\n    private addNodeConverter(converter: ConverterNodeComponent<any>) {\n        for (const supports of converter.supports) {\n            this.nodeConverters[supports] = converter;\n        }\n    }\n\n    private addTypeConverter(converter: ConverterTypeComponent) {\n        if ('supportsNode' in converter && 'convertNode' in converter) {\n            this.typeNodeConverters.push(<TypeNodeConverter<any, any>> converter);\n            this.typeNodeConverters.sort((a, b) => b.priority - a.priority);\n        }\n\n        if ('supportsType' in converter && 'convertType' in converter) {\n            this.typeTypeConverters.push(<TypeTypeConverter<any>> converter);\n            this.typeTypeConverters.sort((a, b) => b.priority - a.priority);\n        }\n    }\n\n    removeComponent(name: string): ConverterComponent | undefined {\n        const component = super.removeComponent(name);\n        if (component instanceof ConverterNodeComponent) {\n            this.removeNodeConverter(component);\n        } else if (component instanceof ConverterTypeComponent) {\n            this.removeTypeConverter(component);\n        }\n\n        return component;\n    }\n\n    private removeNodeConverter(converter: ConverterNodeComponent<any>) {\n        const converters = this.nodeConverters;\n        const keys = _.keys(this.nodeConverters);\n        for (const key of keys) {\n            if (converters[key] === converter) {\n                delete converters[key];\n            }\n        }\n    }\n\n    private removeTypeConverter(converter: ConverterTypeComponent) {\n        const typeIndex = this.typeTypeConverters.indexOf(<any> converter);\n        if (typeIndex !== -1) {\n            this.typeTypeConverters.splice(typeIndex, 1);\n        }\n\n        const nodeIndex = this.typeNodeConverters.indexOf(<any> converter);\n        if (nodeIndex !== -1) {\n            this.typeNodeConverters.splice(nodeIndex, 1);\n        }\n    }\n\n    removeAllComponents() {\n        super.removeAllComponents();\n\n        this.nodeConverters = {};\n        this.typeTypeConverters = [];\n        this.typeNodeConverters = [];\n    }\n\n    /**\n     * Compile the given source files and create a project reflection for them.\n     *\n     * @param fileNames  Array of the file names that should be compiled.\n     */\n    convert(fileNames: string[]): ConverterResult {\n        const normalizedFiles = fileNames.map(normalizePath);\n\n        const program = ts.createProgram(normalizedFiles, this.application.options.getCompilerOptions());\n        const checker = program.getTypeChecker();\n        const context = new Context(this, normalizedFiles, checker, program);\n\n        this.trigger(Converter.EVENT_BEGIN, context);\n\n        const errors = this.compile(context);\n        const project = this.resolve(context);\n\n        this.trigger(Converter.EVENT_END, context);\n\n        return {\n            errors: errors,\n            project: project\n        };\n    }\n\n    /**\n     * Analyze the given node and create a suitable reflection.\n     *\n     * This function checks the kind of the node and delegates to the matching function implementation.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node     The compiler node that should be analyzed.\n     * @return The resulting reflection or undefined.\n     */\n    convertNode(context: Context, node: ts.Node): Reflection | undefined {\n        if (context.visitStack.includes(node)) {\n            return;\n        }\n\n        const oldVisitStack = context.visitStack;\n        context.visitStack = oldVisitStack.slice();\n        context.visitStack.push(node);\n\n        let result: Reflection | undefined;\n        if (node.kind in this.nodeConverters) {\n            result = this.nodeConverters[node.kind].convert(context, node);\n        }\n\n        context.visitStack = oldVisitStack;\n        return result;\n    }\n\n    /**\n     * Convert the given TypeScript type into its TypeDoc type reflection.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node  The node whose type should be reflected.\n     * @param type  The type of the node if already known.\n     * @returns The TypeDoc type reflection representing the given node and type.\n     */\n    convertType(context: Context, node?: ts.Node, type?: ts.Type): Type | undefined {\n        // Run all node based type conversions\n        if (node) {\n            type = type || context.getTypeAtLocation(node);\n\n            for (const converter of this.typeNodeConverters) {\n                if (converter.supportsNode(context, node, type)) {\n                    return converter.convertNode(context, node, type);\n                }\n            }\n        }\n\n        // Run all type based type conversions\n        if (type) {\n            for (const converter of this.typeTypeConverters) {\n                if (converter.supportsType(context, type)) {\n                    return converter.convertType(context, type);\n                }\n            }\n        }\n    }\n\n    /**\n     * Helper function to convert multiple types at once, filtering out types which fail to convert.\n     *\n     * @param context\n     * @param nodes\n     */\n    convertTypes(context: Context, nodes: ReadonlyArray<ts.Node> = [], types: ReadonlyArray<ts.Type> = []): Type[] {\n        const result: Type[] = [];\n        _.zip(nodes, types).forEach(([node, type]) => {\n            const converted = this.convertType(context, node, type);\n            if (converted) {\n                result.push(converted);\n            }\n        });\n        return result;\n    }\n\n    /**\n     * Compile the files within the given context and convert the compiler symbols to reflections.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @returns An array containing all errors generated by the TypeScript compiler.\n     */\n    private compile(context: Context): ReadonlyArray<ts.Diagnostic> {\n        const program = context.program;\n\n        const exclude = createMinimatch(this.application.exclude || []);\n        const isExcluded = (file: ts.SourceFile) => exclude.some(mm => mm.match(file.fileName));\n\n        const includedSourceFiles = program.getSourceFiles()\n            .filter(file => !isExcluded(file));\n        const isRelevantError = ({ file }: ts.Diagnostic) => !file || includedSourceFiles.includes(file);\n\n        includedSourceFiles.forEach((sourceFile) => {\n            this.convertNode(context, sourceFile);\n        });\n\n        if (this.application.ignoreCompilerErrors) {\n            return [];\n        }\n\n        let diagnostics = program.getOptionsDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getSyntacticDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getGlobalDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        diagnostics = program.getSemanticDiagnostics().filter(isRelevantError);\n        if (diagnostics.length) {\n            return diagnostics;\n        }\n\n        return [];\n    }\n\n    /**\n     * Resolve the project within the given context.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @returns The final project reflection.\n     */\n    private resolve(context: Context): ProjectReflection {\n        this.trigger(Converter.EVENT_RESOLVE_BEGIN, context);\n        const project = context.project;\n\n        for (const id in project.reflections) {\n            if (!project.reflections.hasOwnProperty(id)) {\n                continue;\n            }\n            this.trigger(Converter.EVENT_RESOLVE, context, project.reflections[id]);\n        }\n\n        this.trigger(Converter.EVENT_RESOLVE_END, context);\n        return project;\n    }\n\n    /**\n     * Return the basename of the default library that should be used.\n     *\n     * @returns The basename of the default library.\n     */\n    getDefaultLib(): string {\n        return ts.getDefaultLibFileName(this.application.options.getCompilerOptions());\n    }\n}\n"]}

package/dist/lib/converter/factories/comment.js

@@ -55,14 +55,23 @@ function getRawComment(node) {
     const comments = getJSDocCommentRanges(node, sourceFile.text);
     if (comments.length) {
         let comment;
+        const explicitPackageComment = comments.find(comment => sourceFile.text.substring(comment.pos, comment.end).includes('@packageDocumentation'));
         if (node.kind === ts.SyntaxKind.SourceFile) {
-            if (comments.length === 1) {
+            if (explicitPackageComment) {
+                comment = explicitPackageComment;
+            }
+            else if (comments.length > 1) {
+                comment = comments[0];
+            }
+            else {
                 return;
             }
-            comment = comments[0];
         }
         else {
             comment = comments[comments.length - 1];
+            if (sourceFile.text.substring(comment.pos, comment.end).includes('@packageDocumentation')) {
+                return;
+            }
         }
         return sourceFile.text.substring(comment.pos, comment.end);
     }

package/dist/lib/converter/factories/comment.js.map

@@ -1 +1 @@
-{"version":3,"file":"comment.js","sourceRoot":"","sources":["../../../../src/lib/converter/factories/comment.ts"],"names":[],"mappings":";;AAAA,iCAAiC;AACjC,mCAAiC;AAEjC,uDAAkE;AAQlE,SAAgB,aAAa,CAAC,IAAa;IACvC,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,OAAO,EAAE;QACV,OAAO;KACV;IAED,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAPD,sCAOC;AAeD,SAAS,0BAA0B,CAAC,IAA0B;IAC1D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;AACrD,CAAC;AAYD,SAAS,wBAAwB,CAAC,IAA0B;IACxD,OAAO,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACxE,MAAM,MAAM,GAA0B,IAAI,CAAC,MAAM,CAAC;QAClD,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE;YACvC,IAAI,GAAG,MAAM,CAAC;SACjB;aAAM;YACH,MAAM;SACT;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAQD,SAAS,qBAAqB,CAAC,IAAa,EAAE,IAAY;IACtD,MAAM,wBAAwB,GAAG;QAC7B,EAAE,CAAC,UAAU,CAAC,SAAS;QACvB,EAAE,CAAC,UAAU,CAAC,kBAAkB;QAChC,EAAE,CAAC,UAAU,CAAC,aAAa;QAC3B,EAAE,CAAC,UAAU,CAAC,uBAAuB;KACxC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtB,IAAI,aAAa,GAAG,gBAAO,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACxE,IAAI,wBAAwB,EAAE;QAC1B,aAAa,GAAG,gBAAO,CAAC,EAAE,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;KAC9F;IAGD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;AACrG,CAAC;AAQD,SAAgB,aAAa,CAAC,IAAa;IACvC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE;QAC3E,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7B;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACtD,IAAI,CAAC,0BAA0B,CAAwB,IAAI,CAAC,EAAE;YAC1D,OAAO;SACV;aAAM;YACH,IAAI,GAAG,wBAAwB,CAAwB,IAAI,CAAC,CAAC;SAChE;KACJ;IAED,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,IAAI,QAAQ,CAAC,MAAM,EAAE;QACjB,IAAI,OAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE;YACxC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO;aACV;YACD,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;SACzB;aAAM;YACH,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAC3C;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;KAC9D;SAAM;QACH,OAAO;KACV;AACL,CAAC;AA5BD,sCA4BC;AASD,SAAgB,YAAY,CAAC,IAAY,EAAE,UAAmB,IAAI,eAAO,EAAE;IACvE,IAAI,UAAsB,CAAC;IAC3B,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,SAAS,eAAe,CAAC,IAAY;QACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,SAAS,YAAY,CAAC,IAAY;QAC9B,IAAI,UAAU,EAAE;YACZ,UAAU,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC;SAClC;aAAM,IAAI,IAAI,KAAK,EAAE,IAAI,SAAS,KAAK,CAAC,EAAE;SAE1C;aAAM,IAAI,IAAI,KAAK,EAAE,IAAI,SAAS,KAAK,CAAC,EAAE;YACvC,SAAS,GAAG,CAAC,CAAC;SACjB;aAAM;YACH,IAAI,SAAS,KAAK,CAAC,EAAE;gBACjB,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;aAC5D;iBAAM;gBACH,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;gBACnE,SAAS,GAAG,CAAC,CAAC;aACjB;SACJ;IACL,CAAC;IAED,SAAS,WAAW,CAAC,IAAY,EAAE,GAAoB;QACnD,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,SAA6B,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAE9C,IAAI,OAAO,KAAK,QAAQ,EAAE;YAAE,OAAO,GAAG,SAAS,CAAC;SAAE;QAClD,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,WAAW,EAAE;YAChD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE;gBACP,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACnD;YACD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SACrC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE;YAC9B,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;SAChC;QAED,UAAU,GAAG,IAAI,kBAAU,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAAE,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC;SAAE;QACzC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,UAAU,GAAG,kBAAkB,CAAC;IACtC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,SAAS,QAAQ,CAAC,IAAY;QAC1B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEhC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAG;YAC1B,MAAM,GAAG,CAAC,MAAM,CAAC;SAClB;QAED,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,GAAG,EAAE;gBACP,OAAO,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aAC/B;SACF;QACD,YAAY,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzC,OAAO,OAAO,CAAC;AACnB,CAAC;AA3ED,oCA2EC","sourcesContent":["import * as ts from 'typescript';\nimport { toArray } from 'lodash';\n\nimport { Comment, CommentTag } from '../../models/comments/index';\n\n/**\n * Return the parsed comment of the given TypeScript node.\n *\n * @param node  The node whose comment should be returned.\n * @return The parsed comment as a [[Comment]] instance or undefined if no comment is present.\n */\nexport function createComment(node: ts.Node): Comment | undefined {\n    const comment = getRawComment(node);\n    if (!comment) {\n        return;\n    }\n\n    return parseComment(comment);\n}\n\n/**\n * Check whether the given module declaration is the topmost.\n *\n * This function returns TRUE if there is no trailing module defined, in\n * the following example this would be the case only for module <code>C</code>.\n *\n * ```\n * module A.B.C { }\n * ```\n *\n * @param node  The module definition that should be tested.\n * @return TRUE if the given node is the topmost module declaration, FALSE otherwise.\n */\nfunction isTopmostModuleDeclaration(node: ts.ModuleDeclaration): boolean {\n    return node.getChildren().some(ts.isModuleBlock);\n}\n\n/**\n * Return the root module declaration of the given module declaration.\n *\n * In the following example this function would always return module\n * <code>A</code> no matter which of the modules was passed in.\n *\n * ```\n * module A.B.C { }\n * ```\n */\nfunction getRootModuleDeclaration(node: ts.ModuleDeclaration): ts.Node {\n    while (node.parent && node.parent.kind === ts.SyntaxKind.ModuleDeclaration) {\n        const parent = <ts.ModuleDeclaration> node.parent;\n        if (node.name.pos === parent.name.end + 1) {\n            node = parent;\n        } else {\n            break;\n        }\n    }\n\n    return node;\n}\n\n/**\n * Derived from the internal ts utility\n * https://github.com/Microsoft/TypeScript/blob/v3.2.2/src/compiler/utilities.ts#L954\n * @param node\n * @param text\n */\nfunction getJSDocCommentRanges(node: ts.Node, text: string): ts.CommentRange[] {\n    const hasTrailingCommentRanges = [\n        ts.SyntaxKind.Parameter,\n        ts.SyntaxKind.FunctionExpression,\n        ts.SyntaxKind.ArrowFunction,\n        ts.SyntaxKind.ParenthesizedExpression\n    ].includes(node.kind);\n\n    let commentRanges = toArray(ts.getLeadingCommentRanges(text, node.pos));\n    if (hasTrailingCommentRanges) {\n        commentRanges = toArray(ts.getTrailingCommentRanges(text, node.pos)).concat(commentRanges);\n    }\n\n    // True if the comment starts with '/**' but not if it is '/**/'\n    return commentRanges.filter(({ pos }) => text.substr(pos, 3) === '/**' && text[pos + 4] !== '/');\n}\n\n/**\n * Return the raw comment string for the given node.\n *\n * @param node  The node whose comment should be resolved.\n * @returns     The raw comment string or undefined if no comment could be found.\n */\nexport function getRawComment(node: ts.Node): string | undefined {\n    if (node.parent && node.parent.kind === ts.SyntaxKind.VariableDeclarationList) {\n        node = node.parent.parent;\n    } else if (node.kind === ts.SyntaxKind.ModuleDeclaration) {\n        if (!isTopmostModuleDeclaration(<ts.ModuleDeclaration> node)) {\n            return;\n        } else {\n            node = getRootModuleDeclaration(<ts.ModuleDeclaration> node);\n        }\n    }\n\n    const sourceFile = node.getSourceFile();\n    const comments = getJSDocCommentRanges(node, sourceFile.text);\n    if (comments.length) {\n        let comment: ts.CommentRange;\n        if (node.kind === ts.SyntaxKind.SourceFile) {\n            if (comments.length === 1) {\n                return;\n            }\n            comment = comments[0];\n        } else {\n            comment = comments[comments.length - 1];\n        }\n\n        return sourceFile.text.substring(comment.pos, comment.end);\n    } else {\n        return;\n    }\n}\n\n/**\n * Parse the given doc comment string.\n *\n * @param text     The doc comment string that should be parsed.\n * @param comment  The [[Models.Comment]] instance the parsed results should be stored into.\n * @returns        A populated [[Models.Comment]] instance.\n */\nexport function parseComment(text: string, comment: Comment = new Comment()): Comment {\n    let currentTag: CommentTag;\n    let shortText = 0;\n\n    function consumeTypeData(line: string): string {\n        line = line.replace(/^\\{[^\\}]*\\}+/, '');\n        line = line.replace(/^\\[[^\\[][^\\]]*\\]+/, '');\n        return line.trim();\n    }\n\n    function readBareLine(line: string) {\n        if (currentTag) {\n            currentTag.text += '\\n' + line;\n        } else if (line === '' && shortText === 0) {\n            // Ignore\n        } else if (line === '' && shortText === 1) {\n            shortText = 2;\n        } else {\n            if (shortText === 2) {\n                comment.text += (comment.text === '' ? '' : '\\n') + line;\n            } else {\n                comment.shortText += (comment.shortText === '' ? '' : '\\n') + line;\n                shortText = 1;\n            }\n        }\n    }\n\n    function readTagLine(line: string, tag: RegExpExecArray) {\n        let tagName = tag[1].toLowerCase();\n        let paramName: string | undefined;\n        line = line.substr(tagName.length + 1).trim();\n\n        if (tagName === 'return') { tagName = 'returns'; }\n        if (tagName === 'param' || tagName === 'typeparam') {\n            line = consumeTypeData(line);\n            const param = /[^\\s]+/.exec(line);\n            if (param) {\n                paramName = param[0];\n                line = line.substr(paramName.length + 1).trim();\n            }\n            line = consumeTypeData(line);\n            line = line.replace(/^\\-\\s+/, '');\n        } else if (tagName === 'returns') {\n            line = consumeTypeData(line);\n        }\n\n        currentTag = new CommentTag(tagName, paramName, line);\n        if (!comment.tags) { comment.tags = []; }\n        comment.tags.push(currentTag);\n    }\n\n    const CODE_FENCE = /^\\s*```(?!.*```)/;\n    let inCode = false;\n    function readLine(line: string) {\n        line = line.replace(/^\\s*\\*? ?/, '');\n        line = line.replace(/\\s*$/, '');\n\n        if (CODE_FENCE.test(line) ) {\n          inCode = !inCode;\n        }\n\n        if (!inCode) {\n          const tag = /^@(\\S+)/.exec(line);\n          if (tag) {\n            return readTagLine(line, tag);\n          }\n        }\n        readBareLine(line);\n    }\n\n    text = text.replace(/^\\s*\\/\\*+/, '');\n    text = text.replace(/\\*+\\/\\s*$/, '');\n    text.split(/\\r\\n?|\\n/).forEach(readLine);\n\n    return comment;\n}\n"]}
+{"version":3,"file":"comment.js","sourceRoot":"","sources":["../../../../src/lib/converter/factories/comment.ts"],"names":[],"mappings":";;AAAA,iCAAiC;AACjC,mCAAiC;AAEjC,uDAAkE;AAQlE,SAAgB,aAAa,CAAC,IAAa;IACvC,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,OAAO,EAAE;QACV,OAAO;KACV;IAED,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAPD,sCAOC;AAeD,SAAS,0BAA0B,CAAC,IAA0B;IAC1D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;AACrD,CAAC;AAYD,SAAS,wBAAwB,CAAC,IAA0B;IACxD,OAAO,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACxE,MAAM,MAAM,GAA0B,IAAI,CAAC,MAAM,CAAC;QAClD,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE;YACvC,IAAI,GAAG,MAAM,CAAC;SACjB;aAAM;YACH,MAAM;SACT;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAQD,SAAS,qBAAqB,CAAC,IAAa,EAAE,IAAY;IACtD,MAAM,wBAAwB,GAAG;QAC7B,EAAE,CAAC,UAAU,CAAC,SAAS;QACvB,EAAE,CAAC,UAAU,CAAC,kBAAkB;QAChC,EAAE,CAAC,UAAU,CAAC,aAAa;QAC3B,EAAE,CAAC,UAAU,CAAC,uBAAuB;KACxC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEtB,IAAI,aAAa,GAAG,gBAAO,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACxE,IAAI,wBAAwB,EAAE;QAC1B,aAAa,GAAG,gBAAO,CAAC,EAAE,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;KAC9F;IAGD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;AACrG,CAAC;AAQD,SAAgB,aAAa,CAAC,IAAa;IACvC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE;QAC3E,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7B;SAAM,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,EAAE;QACtD,IAAI,CAAC,0BAA0B,CAAwB,IAAI,CAAC,EAAE;YAC1D,OAAO;SACV;aAAM;YACH,IAAI,GAAG,wBAAwB,CAAwB,IAAI,CAAC,CAAC;SAChE;KACJ;IAED,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;IACxC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,IAAI,QAAQ,CAAC,MAAM,EAAE;QACjB,IAAI,OAAwB,CAAC;QAC7B,MAAM,sBAAsB,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CACnD,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC3F,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE;YACxC,IAAI,sBAAsB,EAAE;gBACxB,OAAO,GAAG,sBAAsB,CAAC;aACpC;iBAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBAG5B,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;aACzB;iBAAM;gBAEH,OAAO;aACV;SACJ;aAAM;YACH,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAGxC,IAAI,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;gBACvF,OAAO;aACV;SACJ;QAED,OAAO,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;KAC9D;SAAM;QACH,OAAO;KACV;AACL,CAAC;AAzCD,sCAyCC;AASD,SAAgB,YAAY,CAAC,IAAY,EAAE,UAAmB,IAAI,eAAO,EAAE;IACvE,IAAI,UAAsB,CAAC;IAC3B,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,SAAS,eAAe,CAAC,IAAY;QACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QACxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,SAAS,YAAY,CAAC,IAAY;QAC9B,IAAI,UAAU,EAAE;YACZ,UAAU,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC;SAClC;aAAM,IAAI,IAAI,KAAK,EAAE,IAAI,SAAS,KAAK,CAAC,EAAE;SAE1C;aAAM,IAAI,IAAI,KAAK,EAAE,IAAI,SAAS,KAAK,CAAC,EAAE;YACvC,SAAS,GAAG,CAAC,CAAC;SACjB;aAAM;YACH,IAAI,SAAS,KAAK,CAAC,EAAE;gBACjB,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;aAC5D;iBAAM;gBACH,OAAO,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;gBACnE,SAAS,GAAG,CAAC,CAAC;aACjB;SACJ;IACL,CAAC;IAED,SAAS,WAAW,CAAC,IAAY,EAAE,GAAoB;QACnD,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,SAA6B,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAE9C,IAAI,OAAO,KAAK,QAAQ,EAAE;YAAE,OAAO,GAAG,SAAS,CAAC;SAAE;QAClD,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,WAAW,EAAE;YAChD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,IAAI,KAAK,EAAE;gBACP,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACnD;YACD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SACrC;aAAM,IAAI,OAAO,KAAK,SAAS,EAAE;YAC9B,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;SAChC;QAED,UAAU,GAAG,IAAI,kBAAU,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAAE,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC;SAAE;QACzC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,UAAU,GAAG,kBAAkB,CAAC;IACtC,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,SAAS,QAAQ,CAAC,IAAY;QAC1B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACrC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEhC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAG;YAC1B,MAAM,GAAG,CAAC,MAAM,CAAC;SAClB;QAED,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,GAAG,EAAE;gBACP,OAAO,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;aAC/B;SACF;QACD,YAAY,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzC,OAAO,OAAO,CAAC;AACnB,CAAC;AA3ED,oCA2EC","sourcesContent":["import * as ts from 'typescript';\nimport { toArray } from 'lodash';\n\nimport { Comment, CommentTag } from '../../models/comments/index';\n\n/**\n * Return the parsed comment of the given TypeScript node.\n *\n * @param node  The node whose comment should be returned.\n * @return The parsed comment as a [[Comment]] instance or undefined if no comment is present.\n */\nexport function createComment(node: ts.Node): Comment | undefined {\n    const comment = getRawComment(node);\n    if (!comment) {\n        return;\n    }\n\n    return parseComment(comment);\n}\n\n/**\n * Check whether the given module declaration is the topmost.\n *\n * This function returns TRUE if there is no trailing module defined, in\n * the following example this would be the case only for module <code>C</code>.\n *\n * ```\n * module A.B.C { }\n * ```\n *\n * @param node  The module definition that should be tested.\n * @return TRUE if the given node is the topmost module declaration, FALSE otherwise.\n */\nfunction isTopmostModuleDeclaration(node: ts.ModuleDeclaration): boolean {\n    return node.getChildren().some(ts.isModuleBlock);\n}\n\n/**\n * Return the root module declaration of the given module declaration.\n *\n * In the following example this function would always return module\n * <code>A</code> no matter which of the modules was passed in.\n *\n * ```\n * module A.B.C { }\n * ```\n */\nfunction getRootModuleDeclaration(node: ts.ModuleDeclaration): ts.Node {\n    while (node.parent && node.parent.kind === ts.SyntaxKind.ModuleDeclaration) {\n        const parent = <ts.ModuleDeclaration> node.parent;\n        if (node.name.pos === parent.name.end + 1) {\n            node = parent;\n        } else {\n            break;\n        }\n    }\n\n    return node;\n}\n\n/**\n * Derived from the internal ts utility\n * https://github.com/Microsoft/TypeScript/blob/v3.2.2/src/compiler/utilities.ts#L954\n * @param node\n * @param text\n */\nfunction getJSDocCommentRanges(node: ts.Node, text: string): ts.CommentRange[] {\n    const hasTrailingCommentRanges = [\n        ts.SyntaxKind.Parameter,\n        ts.SyntaxKind.FunctionExpression,\n        ts.SyntaxKind.ArrowFunction,\n        ts.SyntaxKind.ParenthesizedExpression\n    ].includes(node.kind);\n\n    let commentRanges = toArray(ts.getLeadingCommentRanges(text, node.pos));\n    if (hasTrailingCommentRanges) {\n        commentRanges = toArray(ts.getTrailingCommentRanges(text, node.pos)).concat(commentRanges);\n    }\n\n    // True if the comment starts with '/**' but not if it is '/**/'\n    return commentRanges.filter(({ pos }) => text.substr(pos, 3) === '/**' && text[pos + 4] !== '/');\n}\n\n/**\n * Return the raw comment string for the given node.\n *\n * @param node  The node whose comment should be resolved.\n * @returns     The raw comment string or undefined if no comment could be found.\n */\nexport function getRawComment(node: ts.Node): string | undefined {\n    if (node.parent && node.parent.kind === ts.SyntaxKind.VariableDeclarationList) {\n        node = node.parent.parent;\n    } else if (node.kind === ts.SyntaxKind.ModuleDeclaration) {\n        if (!isTopmostModuleDeclaration(<ts.ModuleDeclaration> node)) {\n            return;\n        } else {\n            node = getRootModuleDeclaration(<ts.ModuleDeclaration> node);\n        }\n    }\n\n    const sourceFile = node.getSourceFile();\n    const comments = getJSDocCommentRanges(node, sourceFile.text);\n    if (comments.length) {\n        let comment: ts.CommentRange;\n        const explicitPackageComment = comments.find(comment =>\n            sourceFile.text.substring(comment.pos, comment.end).includes('@packageDocumentation'));\n        if (node.kind === ts.SyntaxKind.SourceFile) {\n            if (explicitPackageComment) {\n                comment = explicitPackageComment;\n            } else if (comments.length > 1) {\n                // Legacy behavior, require more than one comment and use the first comment.\n                // TODO: GH#1083, follow deprecation process to phase this out.\n                comment = comments[0];\n            } else {\n                // Single comment that may be a license comment, bail.\n                return;\n            }\n        } else {\n            comment = comments[comments.length - 1];\n            // If a non-SourceFile node comment has this tag, it should not be attached to the node\n            // as it documents the whole file by convention.\n            if (sourceFile.text.substring(comment.pos, comment.end).includes('@packageDocumentation')) {\n                return;\n            }\n        }\n\n        return sourceFile.text.substring(comment.pos, comment.end);\n    } else {\n        return;\n    }\n}\n\n/**\n * Parse the given doc comment string.\n *\n * @param text     The doc comment string that should be parsed.\n * @param comment  The [[Models.Comment]] instance the parsed results should be stored into.\n * @returns        A populated [[Models.Comment]] instance.\n */\nexport function parseComment(text: string, comment: Comment = new Comment()): Comment {\n    let currentTag: CommentTag;\n    let shortText = 0;\n\n    function consumeTypeData(line: string): string {\n        line = line.replace(/^\\{[^\\}]*\\}+/, '');\n        line = line.replace(/^\\[[^\\[][^\\]]*\\]+/, '');\n        return line.trim();\n    }\n\n    function readBareLine(line: string) {\n        if (currentTag) {\n            currentTag.text += '\\n' + line;\n        } else if (line === '' && shortText === 0) {\n            // Ignore\n        } else if (line === '' && shortText === 1) {\n            shortText = 2;\n        } else {\n            if (shortText === 2) {\n                comment.text += (comment.text === '' ? '' : '\\n') + line;\n            } else {\n                comment.shortText += (comment.shortText === '' ? '' : '\\n') + line;\n                shortText = 1;\n            }\n        }\n    }\n\n    function readTagLine(line: string, tag: RegExpExecArray) {\n        let tagName = tag[1].toLowerCase();\n        let paramName: string | undefined;\n        line = line.substr(tagName.length + 1).trim();\n\n        if (tagName === 'return') { tagName = 'returns'; }\n        if (tagName === 'param' || tagName === 'typeparam') {\n            line = consumeTypeData(line);\n            const param = /[^\\s]+/.exec(line);\n            if (param) {\n                paramName = param[0];\n                line = line.substr(paramName.length + 1).trim();\n            }\n            line = consumeTypeData(line);\n            line = line.replace(/^\\-\\s+/, '');\n        } else if (tagName === 'returns') {\n            line = consumeTypeData(line);\n        }\n\n        currentTag = new CommentTag(tagName, paramName, line);\n        if (!comment.tags) { comment.tags = []; }\n        comment.tags.push(currentTag);\n    }\n\n    const CODE_FENCE = /^\\s*```(?!.*```)/;\n    let inCode = false;\n    function readLine(line: string) {\n        line = line.replace(/^\\s*\\*? ?/, '');\n        line = line.replace(/\\s*$/, '');\n\n        if (CODE_FENCE.test(line) ) {\n          inCode = !inCode;\n        }\n\n        if (!inCode) {\n          const tag = /^@(\\S+)/.exec(line);\n          if (tag) {\n            return readTagLine(line, tag);\n          }\n        }\n        readBareLine(line);\n    }\n\n    text = text.replace(/^\\s*\\/\\*+/, '');\n    text = text.replace(/\\*+\\/\\s*$/, '');\n    text.split(/\\r\\n?|\\n/).forEach(readLine);\n\n    return comment;\n}\n"]}

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -68,6 +68,9 @@ let CommentPlugin = CommentPlugin_1 = class CommentPlugin extends components_1.C
             }
             this.hidden.push(reflection);
         }
+        if (reflection.kindOf(index_3.ReflectionKind.ExternalModule)) {
+            CommentPlugin_1.removeTags(comment, 'packagedocumentation');
+        }
     }
     onBegin(context) {
         this.hidden = undefined;

package/dist/lib/converter/plugins/CommentPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommentPlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/CommentPlugin.ts"],"names":[],"mappings":";;;;;;;;;AAEA,uDAAkE;AAClE,oDAAyD;AACzD,0DAEqF;AACrF,8CAA8D;AAC9D,kDAAmE;AACnE,4CAAyC;AA4BzC,IAAa,aAAa,qBAA1B,MAAa,aAAc,SAAQ,+BAAkB;IAejD,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAoB,IAAI,CAAC,OAAO;YACvD,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAO,IAAI,CAAC,aAAa;YAC7D,CAAC,qBAAS,CAAC,sBAAsB,CAAC,EAAS,IAAI,CAAC,aAAa;YAC7D,CAAC,qBAAS,CAAC,2BAA2B,CAAC,EAAI,IAAI,CAAC,qBAAqB;YACrE,CAAC,qBAAS,CAAC,6BAA6B,CAAC,EAAE,IAAI,CAAC,wBAAwB;YACxE,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAY,IAAI,CAAC,cAAc;YAC9D,CAAC,qBAAS,CAAC,aAAa,CAAC,EAAkB,IAAI,CAAC,SAAS;SAC5D,CAAC,CAAC;IACP,CAAC;IAEO,kBAAkB,CAAC,OAAe,EAAE,UAAsB;QAC9D,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QAEnE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC7E,OAAO;aACV;YAED,IAAI,CAAC,QAAQ,GAAM,OAAO,CAAC;YAC3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;aAAM;YACH,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG;gBAC3B,UAAU,EAAG,UAAU;gBACvB,QAAQ,EAAK,OAAO;gBACpB,WAAW,EAAE,WAAW;aAC3B,CAAC;SACL;IACL,CAAC;IAQO,cAAc,CAAC,UAAsB,EAAE,OAAgB;QAC3D,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YAC3B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,OAAO,CAAC,CAAC;YAC3C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;SAChD;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;YAC7B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,SAAS,CAAC,CAAC;YAC7C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;SAClD;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC1B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;YAC1C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/C;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YACzB,UAAU,CAAC,IAAI,GAAG,sBAAc,CAAC,KAAK,CAAC;YAEvC,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9C;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;eACrB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;eACxB,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,aAAa,CAAC,EAChG;YACE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACpB;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;IACL,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IASO,qBAAqB,CAAC,OAAgB,EAAE,UAAmC,EAAE,IAAc;QAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;QAC/D,IAAI,OAAO,EAAE;YACT,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aAClD;YAED,IAAI,GAAG,EAAE;gBACL,UAAU,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAE3C,OAAO,CAAC,IAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;aACvD;SACJ;IACL,CAAC;IAWO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QACD,MAAM,UAAU,GAAG,uBAAa,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,EAAE;YACb,OAAO;SACV;QAED,IAAI,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE;YAC7H,MAAM,OAAO,GAAG,sBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;SAC5C;aAAM,IAAI,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,MAAM,CAAC,EAAE;YACjD,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SACnD;aAAM;YACH,MAAM,OAAO,GAAG,sBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACzC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;SAChC;IACL,CAAC;IASO,wBAAwB,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QACrF,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QAED,MAAM,OAAO,GAAG,uBAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,EAAE;YACT,UAAU,CAAC,OAAO,GAAG,sBAAY,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;SAClE;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE;gBACnC,SAAS;aACZ;YAED,MAAM,IAAI,GAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,OAAO,GAAG,sBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAE/C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;SACrC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,eAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACzD;IACL,CAAC;IAcO,SAAS,CAAC,OAAgB,EAAE,UAAiC;QACjE,IAAI,CAAC,CAAC,UAAU,YAAY,6BAAqB,CAAC,EAAE;YAChD,OAAO;SACV;QAED,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACjD,IAAI,UAAU,CAAC,MAAM,EAAE;YACnB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;gBACtC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC,IAAI,CAAC;gBAClD,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAChD;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC7B,IAAI,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;gBACrC,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;oBAChD,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC,IAAI,CAAC;oBAC5D,eAAa,CAAC,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;iBACrD;gBAED,IAAI,OAAO,EAAE;oBACT,IAAI,CAAC,YAAY,EAAE;wBACf,YAAY,GAAG,SAAS,CAAC,OAAO,GAAG,IAAI,eAAO,EAAE,CAAC;qBACpD;oBAED,YAAY,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC;oBACrE,YAAY,CAAC,IAAI,GAAQ,YAAY,CAAC,IAAI,IAAS,OAAO,CAAC,IAAI,CAAC;oBAChE,YAAY,CAAC,OAAO,GAAK,YAAY,CAAC,OAAO,IAAM,OAAO,CAAC,OAAO,CAAC;iBACtE;gBAED,IAAI,SAAS,CAAC,UAAU,EAAE;oBACtB,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;wBACvC,IAAI,GAA2B,CAAC;wBAChC,IAAI,YAAY,EAAE;4BACd,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;yBACtD;wBACD,IAAI,OAAO,IAAI,CAAC,GAAG,EAAE;4BACjB,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;yBACjD;wBACD,IAAI,GAAG,EAAE;4BACL,SAAS,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;yBAC7C;oBACL,CAAC,CAAC,CAAC;iBACN;gBAED,eAAa,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YAEH,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAQD,MAAM,CAAC,UAAU,CAAC,OAA4B,EAAE,OAAe;QAC3D,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3B,OAAO;SACV;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,EAAE;YACV,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,EAAE;gBACrC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,CAAC,EAAE,CAAC;aACP;iBAAM;gBACH,CAAC,EAAE,CAAC;aACP;SACJ;IACL,CAAC;IAKD,MAAM,CAAC,iBAAiB,CAAC,OAA0B,EAAE,WAAyB;QAC1E,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/B,eAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE;YACrC,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC9F,OAAO,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAKD,MAAM,CAAC,gBAAgB,CAAC,OAA0B,EAAE,UAAsB,EAAE,UAAqB;QAC7F,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QAE3F,MAAM,MAAM,GAA2B,UAAU,CAAC,MAAM,CAAC;QACzD,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAiB,EAAE,QAA0B,EAAE,EAAE;YAC9D,IAAI,KAAK,KAAK,UAAU,EAAE;gBACtB,QAAQ,QAAQ,EAAE;oBACd,KAAK,wBAAgB,CAAC,QAAQ;wBAC1B,IAAI,MAAM,CAAC,QAAQ,EAAE;4BACjB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAyB,UAAU,CAAC,CAAC;4BAC1E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BACpC;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,YAAY;wBAC9B,OAAO,MAAM,CAAC,YAAY,CAAC;wBAC3B,MAAM;oBACV,KAAK,wBAAgB,CAAC,cAAc;wBAChC,OAAO,MAAM,CAAC,cAAc,CAAC;wBAC7B,MAAM;oBACV,KAAK,wBAAgB,CAAC,UAAU;wBAC5B,IAA2B,UAAU,CAAC,MAAO,CAAC,UAAU,EAAE;4BACtD,MAAM,KAAK,GAA0B,UAAU,CAAC,MAAO,CAAC,UAAW,CAAC,OAAO,CAAuB,UAAU,CAAC,CAAC;4BAC9G,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACS,UAAU,CAAC,MAAO,CAAC,UAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BAC1E;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,YAAY;wBAC9B,OAAO,MAAM,CAAC,YAAY,CAAC;wBAC3B,MAAM;oBACV,KAAK,wBAAgB,CAAC,UAAU;wBAC5B,IAAI,MAAM,CAAC,UAAU,EAAE;4BACnB,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAuB,UAAU,CAAC,CAAC;4BAC1E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BACtC;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,WAAW;wBAC7B,MAAM,CAAC,IAAI,GAAG,IAAI,qBAAa,CAAC,QAAQ,CAAC,CAAC;wBAC1C,MAAM;oBACV,KAAK,wBAAgB,CAAC,aAAa;wBAC/B,IAAI,MAAM,CAAC,cAAc,EAAE;4BACvB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAA2B,UAAU,CAAC,CAAC;4BAClF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BAC1C;yBACJ;wBACD,MAAM;iBACb;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAG/B,IAAI,UAAU,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACvB;aAAM;YACH,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE;gBACrC,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;oBAChF,OAAO,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;iBACrC;aACJ;SACJ;IAEL,CAAC;CACJ,CAAA;AAlXY,aAAa;IADzB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,aAAa,CAkXzB;AAlXY,sCAAa","sourcesContent":["import * as ts from 'typescript';\n\nimport { Comment, CommentTag } from '../../models/comments/index';\nimport { IntrinsicType } from '../../models/types/index';\nimport { Reflection, ReflectionFlag, ReflectionKind, TraverseProperty,\n    TypeParameterReflection, DeclarationReflection, ProjectReflection,\n    SignatureReflection, ParameterReflection } from '../../models/reflections/index';\nimport { Component, ConverterComponent } from '../components';\nimport { parseComment, getRawComment } from '../factories/comment';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\n\n/**\n * Structure used by [[ContainerCommentHandler]] to store discovered module comments.\n */\ninterface ModuleComment {\n    /**\n     * The module reflection this comment is targeting.\n     */\n    reflection: Reflection;\n\n    /**\n     * The full text of the best matched comment.\n     */\n    fullText: string;\n\n    /**\n     * Has the full text been marked as being preferred?\n     */\n    isPreferred: boolean;\n}\n\n/**\n * A handler that parses javadoc comments and attaches [[Models.Comment]] instances to\n * the generated reflections.\n */\n@Component({name: 'comment'})\nexport class CommentPlugin extends ConverterComponent {\n    /**\n     * List of discovered module comments.\n     * Defined in this.onBegin\n     */\n    private comments!: {[id: number]: ModuleComment};\n\n    /**\n     * List of hidden reflections.\n     */\n    private hidden?: Reflection[];\n\n    /**\n     * Create a new CommentPlugin instance.\n     */\n    initialize() {\n        this.listenTo(this.owner, {\n            [Converter.EVENT_BEGIN]:                   this.onBegin,\n            [Converter.EVENT_CREATE_DECLARATION]:      this.onDeclaration,\n            [Converter.EVENT_CREATE_SIGNATURE]:        this.onDeclaration,\n            [Converter.EVENT_CREATE_TYPE_PARAMETER]:   this.onCreateTypeParameter,\n            [Converter.EVENT_FUNCTION_IMPLEMENTATION]: this.onFunctionImplementation,\n            [Converter.EVENT_RESOLVE_BEGIN]:           this.onBeginResolve,\n            [Converter.EVENT_RESOLVE]:                 this.onResolve\n        });\n    }\n\n    private storeModuleComment(comment: string, reflection: Reflection) {\n        const isPreferred = (comment.toLowerCase().includes('@preferred'));\n\n        if (this.comments[reflection.id]) {\n            const info = this.comments[reflection.id];\n            if (!isPreferred && (info.isPreferred || info.fullText.length > comment.length)) {\n                return;\n            }\n\n            info.fullText    = comment;\n            info.isPreferred = isPreferred;\n        } else {\n            this.comments[reflection.id] = {\n                reflection:  reflection,\n                fullText:    comment,\n                isPreferred: isPreferred\n            };\n        }\n    }\n\n    /**\n     * Apply all comment tag modifiers to the given reflection.\n     *\n     * @param reflection  The reflection the modifiers should be applied to.\n     * @param comment  The comment that should be searched for modifiers.\n     */\n    private applyModifiers(reflection: Reflection, comment: Comment) {\n        if (comment.hasTag('private')) {\n            reflection.setFlag(ReflectionFlag.Private);\n            CommentPlugin.removeTags(comment, 'private');\n        }\n\n        if (comment.hasTag('protected')) {\n            reflection.setFlag(ReflectionFlag.Protected);\n            CommentPlugin.removeTags(comment, 'protected');\n        }\n\n        if (comment.hasTag('public')) {\n            reflection.setFlag(ReflectionFlag.Public);\n            CommentPlugin.removeTags(comment, 'public');\n        }\n\n        if (comment.hasTag('event')) {\n            reflection.kind = ReflectionKind.Event;\n            // reflection.setFlag(ReflectionFlag.Event);\n            CommentPlugin.removeTags(comment, 'event');\n        }\n\n        if (comment.hasTag('hidden')\n            || comment.hasTag('ignore')\n            || (comment.hasTag('internal') && this.application.options.getCompilerOptions().stripInternal)\n        ) {\n            if (!this.hidden) {\n                this.hidden = [];\n            }\n            this.hidden.push(reflection);\n        }\n    }\n\n    /**\n     * Triggered when the converter begins converting a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBegin(context: Context) {\n        this.hidden = undefined;\n        this.comments = {};\n    }\n\n    /**\n     * Triggered when the converter has created a type parameter reflection.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onCreateTypeParameter(context: Context, reflection: TypeParameterReflection, node?: ts.Node) {\n        const comment = reflection.parent && reflection.parent.comment;\n        if (comment) {\n            let tag = comment.getTag('typeparam', reflection.name);\n            if (!tag) {\n                tag = comment.getTag('param', `<${reflection.name}>`);\n            }\n            if (!tag) {\n                tag = comment.getTag('param', reflection.name);\n            }\n\n            if (tag) {\n                reflection.comment = new Comment(tag.text);\n                // comment.tags must be set if we found a tag.\n                comment.tags!.splice(comment.tags!.indexOf(tag), 1);\n            }\n        }\n    }\n\n    /**\n     * Triggered when the converter has created a declaration or signature reflection.\n     *\n     * Invokes the comment parser.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onDeclaration(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (!node) {\n            return;\n        }\n        const rawComment = getRawComment(node);\n        if (!rawComment) {\n            return;\n        }\n\n        if (reflection.kindOf(ReflectionKind.FunctionOrMethod) || (reflection.kindOf(ReflectionKind.Event) && reflection['signatures'])) {\n            const comment = parseComment(rawComment, reflection.comment);\n            this.applyModifiers(reflection, comment);\n        } else if (reflection.kindOf(ReflectionKind.Module)) {\n            this.storeModuleComment(rawComment, reflection);\n        } else {\n            const comment = parseComment(rawComment, reflection.comment);\n            this.applyModifiers(reflection, comment);\n            reflection.comment = comment;\n        }\n    }\n\n    /**\n     * Triggered when the converter has found a function implementation.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onFunctionImplementation(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (!node) {\n            return;\n        }\n\n        const comment = getRawComment(node);\n        if (comment) {\n            reflection.comment = parseComment(comment, reflection.comment);\n        }\n    }\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBeginResolve(context: Context) {\n        for (const id in this.comments) {\n            if (!this.comments.hasOwnProperty(id)) {\n                continue;\n            }\n\n            const info    = this.comments[id];\n            const comment = parseComment(info.fullText);\n            CommentPlugin.removeTags(comment, 'preferred');\n\n            this.applyModifiers(info.reflection, comment);\n            info.reflection.comment = comment;\n        }\n\n        if (this.hidden) {\n            const project = context.project;\n            CommentPlugin.removeReflections(project, this.hidden);\n        }\n    }\n\n    /**\n     * Triggered when the converter resolves a reflection.\n     *\n     * Cleans up comment tags related to signatures like @param or @return\n     * and moves their data to the corresponding parameter reflections.\n     *\n     * This hook also copies over the comment of function implementations to their\n     * signatures.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently resolved.\n     */\n    private onResolve(context: Context, reflection: DeclarationReflection) {\n        if (!(reflection instanceof DeclarationReflection)) {\n            return;\n        }\n\n        const signatures = reflection.getAllSignatures();\n        if (signatures.length) {\n            const comment = reflection.comment;\n            if (comment && comment.hasTag('returns')) {\n                comment.returns = comment.getTag('returns')!.text;\n                CommentPlugin.removeTags(comment, 'returns');\n            }\n\n            signatures.forEach((signature) => {\n                let childComment = signature.comment;\n                if (childComment && childComment.hasTag('returns')) {\n                    childComment.returns = childComment.getTag('returns')!.text;\n                    CommentPlugin.removeTags(childComment, 'returns');\n                }\n\n                if (comment) {\n                    if (!childComment) {\n                        childComment = signature.comment = new Comment();\n                    }\n\n                    childComment.shortText = childComment.shortText || comment.shortText;\n                    childComment.text      = childComment.text      || comment.text;\n                    childComment.returns   = childComment.returns   || comment.returns;\n                }\n\n                if (signature.parameters) {\n                    signature.parameters.forEach((parameter) => {\n                        let tag: CommentTag | undefined;\n                        if (childComment) {\n                            tag = childComment.getTag('param', parameter.name);\n                        }\n                        if (comment && !tag) {\n                            tag = comment.getTag('param', parameter.name);\n                        }\n                        if (tag) {\n                            parameter.comment = new Comment(tag.text);\n                        }\n                    });\n                }\n\n                CommentPlugin.removeTags(childComment, 'param');\n            });\n\n            CommentPlugin.removeTags(comment, 'param');\n        }\n    }\n\n    /**\n     * Remove all tags with the given name from the given comment instance.\n     *\n     * @param comment  The comment that should be modified.\n     * @param tagName  The name of the that that should be removed.\n     */\n    static removeTags(comment: Comment | undefined, tagName: string) {\n        if (!comment || !comment.tags) {\n            return;\n        }\n\n        let i = 0, c = comment.tags.length;\n        while (i < c) {\n            if (comment.tags[i].tagName === tagName) {\n                comment.tags.splice(i, 1);\n                c--;\n            } else {\n                i++;\n            }\n        }\n    }\n\n    /**\n     * Remove the specified reflections from the project.\n     */\n    static removeReflections(project: ProjectReflection, reflections: Reflection[]) {\n        const deletedIds: number[] = [];\n        reflections.forEach((reflection) => {\n            CommentPlugin.removeReflection(project, reflection, deletedIds);\n        });\n\n        for (const key in project.symbolMapping) {\n            if (project.symbolMapping.hasOwnProperty(key) && deletedIds.includes(project.symbolMapping[key])) {\n                delete project.symbolMapping[key];\n            }\n        }\n    }\n\n    /**\n     * Remove the given reflection from the project.\n     */\n    static removeReflection(project: ProjectReflection, reflection: Reflection, deletedIds?: number[]) {\n        reflection.traverse((child) => CommentPlugin.removeReflection(project, child, deletedIds));\n\n        const parent = <DeclarationReflection> reflection.parent;\n        parent.traverse((child: Reflection, property: TraverseProperty) => {\n            if (child === reflection) {\n                switch (property) {\n                    case TraverseProperty.Children:\n                        if (parent.children) {\n                            const index = parent.children.indexOf(<DeclarationReflection> reflection);\n                            if (index !== -1) {\n                                parent.children.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.GetSignature:\n                        delete parent.getSignature;\n                        break;\n                    case TraverseProperty.IndexSignature:\n                        delete parent.indexSignature;\n                        break;\n                    case TraverseProperty.Parameters:\n                        if ((<SignatureReflection> reflection.parent).parameters) {\n                            const index = (<SignatureReflection> reflection.parent).parameters!.indexOf(<ParameterReflection> reflection);\n                            if (index !== -1) {\n                                (<SignatureReflection> reflection.parent).parameters!.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.SetSignature:\n                        delete parent.setSignature;\n                        break;\n                    case TraverseProperty.Signatures:\n                        if (parent.signatures) {\n                            const index = parent.signatures.indexOf(<SignatureReflection> reflection);\n                            if (index !== -1) {\n                                parent.signatures.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.TypeLiteral:\n                        parent.type = new IntrinsicType('Object');\n                        break;\n                    case TraverseProperty.TypeParameter:\n                        if (parent.typeParameters) {\n                            const index = parent.typeParameters.indexOf(<TypeParameterReflection> reflection);\n                            if (index !== -1) {\n                                parent.typeParameters.splice(index, 1);\n                            }\n                        }\n                        break;\n                }\n            }\n        });\n\n        const id = reflection.id;\n        delete project.reflections[id];\n\n        // if an array was provided, keep track of the reflections that have been deleted, otherwise clean symbol mappings\n        if (deletedIds) {\n            deletedIds.push(id);\n        } else {\n            for (const key in project.symbolMapping) {\n                if (project.symbolMapping.hasOwnProperty(key) && project.symbolMapping[key] === id) {\n                    delete project.symbolMapping[key];\n                }\n            }\n        }\n\n    }\n}\n"]}
+{"version":3,"file":"CommentPlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/CommentPlugin.ts"],"names":[],"mappings":";;;;;;;;;AAEA,uDAAkE;AAClE,oDAAyD;AACzD,0DAEqF;AACrF,8CAA8D;AAC9D,kDAAmE;AACnE,4CAAyC;AA4BzC,IAAa,aAAa,qBAA1B,MAAa,aAAc,SAAQ,+BAAkB;IAejD,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAoB,IAAI,CAAC,OAAO;YACvD,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAO,IAAI,CAAC,aAAa;YAC7D,CAAC,qBAAS,CAAC,sBAAsB,CAAC,EAAS,IAAI,CAAC,aAAa;YAC7D,CAAC,qBAAS,CAAC,2BAA2B,CAAC,EAAI,IAAI,CAAC,qBAAqB;YACrE,CAAC,qBAAS,CAAC,6BAA6B,CAAC,EAAE,IAAI,CAAC,wBAAwB;YACxE,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAY,IAAI,CAAC,cAAc;YAC9D,CAAC,qBAAS,CAAC,aAAa,CAAC,EAAkB,IAAI,CAAC,SAAS;SAC5D,CAAC,CAAC;IACP,CAAC;IAEO,kBAAkB,CAAC,OAAe,EAAE,UAAsB;QAC9D,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;QAEnE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC1C,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC7E,OAAO;aACV;YAED,IAAI,CAAC,QAAQ,GAAM,OAAO,CAAC;YAC3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;aAAM;YACH,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG;gBAC3B,UAAU,EAAG,UAAU;gBACvB,QAAQ,EAAK,OAAO;gBACpB,WAAW,EAAE,WAAW;aAC3B,CAAC;SACL;IACL,CAAC;IAQO,cAAc,CAAC,UAAsB,EAAE,OAAgB;QAC3D,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;YAC3B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,OAAO,CAAC,CAAC;YAC3C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;SAChD;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;YAC7B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,SAAS,CAAC,CAAC;YAC7C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;SAClD;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC1B,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;YAC1C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC/C;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YACzB,UAAU,CAAC,IAAI,GAAG,sBAAc,CAAC,KAAK,CAAC;YAEvC,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9C;QAED,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;eACrB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;eACxB,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,aAAa,CAAC,EAChG;YACE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACpB;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAChC;QAED,IAAI,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,cAAc,CAAC,EAAE;YAClD,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;SAC7D;IACL,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IASO,qBAAqB,CAAC,OAAgB,EAAE,UAAmC,EAAE,IAAc;QAC/F,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;QAC/D,IAAI,OAAO,EAAE;YACT,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC;aACzD;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aAClD;YAED,IAAI,GAAG,EAAE;gBACL,UAAU,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAE3C,OAAO,CAAC,IAAK,CAAC,MAAM,CAAC,OAAO,CAAC,IAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;aACvD;SACJ;IACL,CAAC;IAWO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QACD,MAAM,UAAU,GAAG,uBAAa,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,EAAE;YACb,OAAO;SACV;QAED,IAAI,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE;YAC7H,MAAM,OAAO,GAAG,sBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;SAC5C;aAAM,IAAI,UAAU,CAAC,MAAM,CAAC,sBAAc,CAAC,MAAM,CAAC,EAAE;YACjD,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;SACnD;aAAM;YACH,MAAM,OAAO,GAAG,sBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;YAC7D,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACzC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;SAChC;IACL,CAAC;IASO,wBAAwB,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QACrF,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QAED,MAAM,OAAO,GAAG,uBAAa,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,EAAE;YACT,UAAU,CAAC,OAAO,GAAG,sBAAY,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;SAClE;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE;gBACnC,SAAS;aACZ;YAED,MAAM,IAAI,GAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,OAAO,GAAG,sBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5C,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YAE/C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;SACrC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAChC,eAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACzD;IACL,CAAC;IAcO,SAAS,CAAC,OAAgB,EAAE,UAAiC;QACjE,IAAI,CAAC,CAAC,UAAU,YAAY,6BAAqB,CAAC,EAAE;YAChD,OAAO;SACV;QAED,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACjD,IAAI,UAAU,CAAC,MAAM,EAAE;YACnB,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;gBACtC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC,IAAI,CAAC;gBAClD,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAChD;YAED,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC7B,IAAI,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC;gBACrC,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;oBAChD,YAAY,CAAC,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC,IAAI,CAAC;oBAC5D,eAAa,CAAC,UAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;iBACrD;gBAED,IAAI,OAAO,EAAE;oBACT,IAAI,CAAC,YAAY,EAAE;wBACf,YAAY,GAAG,SAAS,CAAC,OAAO,GAAG,IAAI,eAAO,EAAE,CAAC;qBACpD;oBAED,YAAY,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC;oBACrE,YAAY,CAAC,IAAI,GAAQ,YAAY,CAAC,IAAI,IAAS,OAAO,CAAC,IAAI,CAAC;oBAChE,YAAY,CAAC,OAAO,GAAK,YAAY,CAAC,OAAO,IAAM,OAAO,CAAC,OAAO,CAAC;iBACtE;gBAED,IAAI,SAAS,CAAC,UAAU,EAAE;oBACtB,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;wBACvC,IAAI,GAA2B,CAAC;wBAChC,IAAI,YAAY,EAAE;4BACd,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;yBACtD;wBACD,IAAI,OAAO,IAAI,CAAC,GAAG,EAAE;4BACjB,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;yBACjD;wBACD,IAAI,GAAG,EAAE;4BACL,SAAS,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;yBAC7C;oBACL,CAAC,CAAC,CAAC;iBACN;gBAED,eAAa,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;YAEH,eAAa,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC;IAQD,MAAM,CAAC,UAAU,CAAC,OAA4B,EAAE,OAAe;QAC3D,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3B,OAAO;SACV;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,EAAE;YACV,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,EAAE;gBACrC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,CAAC,EAAE,CAAC;aACP;iBAAM;gBACH,CAAC,EAAE,CAAC;aACP;SACJ;IACL,CAAC;IAKD,MAAM,CAAC,iBAAiB,CAAC,OAA0B,EAAE,WAAyB;QAC1E,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/B,eAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE;YACrC,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC9F,OAAO,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAKD,MAAM,CAAC,gBAAgB,CAAC,OAA0B,EAAE,UAAsB,EAAE,UAAqB;QAC7F,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QAE3F,MAAM,MAAM,GAA2B,UAAU,CAAC,MAAM,CAAC;QACzD,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAiB,EAAE,QAA0B,EAAE,EAAE;YAC9D,IAAI,KAAK,KAAK,UAAU,EAAE;gBACtB,QAAQ,QAAQ,EAAE;oBACd,KAAK,wBAAgB,CAAC,QAAQ;wBAC1B,IAAI,MAAM,CAAC,QAAQ,EAAE;4BACjB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAyB,UAAU,CAAC,CAAC;4BAC1E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BACpC;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,YAAY;wBAC9B,OAAO,MAAM,CAAC,YAAY,CAAC;wBAC3B,MAAM;oBACV,KAAK,wBAAgB,CAAC,cAAc;wBAChC,OAAO,MAAM,CAAC,cAAc,CAAC;wBAC7B,MAAM;oBACV,KAAK,wBAAgB,CAAC,UAAU;wBAC5B,IAA2B,UAAU,CAAC,MAAO,CAAC,UAAU,EAAE;4BACtD,MAAM,KAAK,GAA0B,UAAU,CAAC,MAAO,CAAC,UAAW,CAAC,OAAO,CAAuB,UAAU,CAAC,CAAC;4BAC9G,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACS,UAAU,CAAC,MAAO,CAAC,UAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BAC1E;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,YAAY;wBAC9B,OAAO,MAAM,CAAC,YAAY,CAAC;wBAC3B,MAAM;oBACV,KAAK,wBAAgB,CAAC,UAAU;wBAC5B,IAAI,MAAM,CAAC,UAAU,EAAE;4BACnB,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAuB,UAAU,CAAC,CAAC;4BAC1E,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BACtC;yBACJ;wBACD,MAAM;oBACV,KAAK,wBAAgB,CAAC,WAAW;wBAC7B,MAAM,CAAC,IAAI,GAAG,IAAI,qBAAa,CAAC,QAAQ,CAAC,CAAC;wBAC1C,MAAM;oBACV,KAAK,wBAAgB,CAAC,aAAa;wBAC/B,IAAI,MAAM,CAAC,cAAc,EAAE;4BACvB,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAA2B,UAAU,CAAC,CAAC;4BAClF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;gCACd,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;6BAC1C;yBACJ;wBACD,MAAM;iBACb;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAG/B,IAAI,UAAU,EAAE;YACZ,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACvB;aAAM;YACH,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE;gBACrC,IAAI,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;oBAChF,OAAO,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;iBACrC;aACJ;SACJ;IAEL,CAAC;CACJ,CAAA;AAtXY,aAAa;IADzB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,aAAa,CAsXzB;AAtXY,sCAAa","sourcesContent":["import * as ts from 'typescript';\n\nimport { Comment, CommentTag } from '../../models/comments/index';\nimport { IntrinsicType } from '../../models/types/index';\nimport { Reflection, ReflectionFlag, ReflectionKind, TraverseProperty,\n    TypeParameterReflection, DeclarationReflection, ProjectReflection,\n    SignatureReflection, ParameterReflection } from '../../models/reflections/index';\nimport { Component, ConverterComponent } from '../components';\nimport { parseComment, getRawComment } from '../factories/comment';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\n\n/**\n * Structure used by [[ContainerCommentHandler]] to store discovered module comments.\n */\ninterface ModuleComment {\n    /**\n     * The module reflection this comment is targeting.\n     */\n    reflection: Reflection;\n\n    /**\n     * The full text of the best matched comment.\n     */\n    fullText: string;\n\n    /**\n     * Has the full text been marked as being preferred?\n     */\n    isPreferred: boolean;\n}\n\n/**\n * A handler that parses javadoc comments and attaches [[Models.Comment]] instances to\n * the generated reflections.\n */\n@Component({name: 'comment'})\nexport class CommentPlugin extends ConverterComponent {\n    /**\n     * List of discovered module comments.\n     * Defined in this.onBegin\n     */\n    private comments!: {[id: number]: ModuleComment};\n\n    /**\n     * List of hidden reflections.\n     */\n    private hidden?: Reflection[];\n\n    /**\n     * Create a new CommentPlugin instance.\n     */\n    initialize() {\n        this.listenTo(this.owner, {\n            [Converter.EVENT_BEGIN]:                   this.onBegin,\n            [Converter.EVENT_CREATE_DECLARATION]:      this.onDeclaration,\n            [Converter.EVENT_CREATE_SIGNATURE]:        this.onDeclaration,\n            [Converter.EVENT_CREATE_TYPE_PARAMETER]:   this.onCreateTypeParameter,\n            [Converter.EVENT_FUNCTION_IMPLEMENTATION]: this.onFunctionImplementation,\n            [Converter.EVENT_RESOLVE_BEGIN]:           this.onBeginResolve,\n            [Converter.EVENT_RESOLVE]:                 this.onResolve\n        });\n    }\n\n    private storeModuleComment(comment: string, reflection: Reflection) {\n        const isPreferred = (comment.toLowerCase().includes('@preferred'));\n\n        if (this.comments[reflection.id]) {\n            const info = this.comments[reflection.id];\n            if (!isPreferred && (info.isPreferred || info.fullText.length > comment.length)) {\n                return;\n            }\n\n            info.fullText    = comment;\n            info.isPreferred = isPreferred;\n        } else {\n            this.comments[reflection.id] = {\n                reflection:  reflection,\n                fullText:    comment,\n                isPreferred: isPreferred\n            };\n        }\n    }\n\n    /**\n     * Apply all comment tag modifiers to the given reflection.\n     *\n     * @param reflection  The reflection the modifiers should be applied to.\n     * @param comment  The comment that should be searched for modifiers.\n     */\n    private applyModifiers(reflection: Reflection, comment: Comment) {\n        if (comment.hasTag('private')) {\n            reflection.setFlag(ReflectionFlag.Private);\n            CommentPlugin.removeTags(comment, 'private');\n        }\n\n        if (comment.hasTag('protected')) {\n            reflection.setFlag(ReflectionFlag.Protected);\n            CommentPlugin.removeTags(comment, 'protected');\n        }\n\n        if (comment.hasTag('public')) {\n            reflection.setFlag(ReflectionFlag.Public);\n            CommentPlugin.removeTags(comment, 'public');\n        }\n\n        if (comment.hasTag('event')) {\n            reflection.kind = ReflectionKind.Event;\n            // reflection.setFlag(ReflectionFlag.Event);\n            CommentPlugin.removeTags(comment, 'event');\n        }\n\n        if (comment.hasTag('hidden')\n            || comment.hasTag('ignore')\n            || (comment.hasTag('internal') && this.application.options.getCompilerOptions().stripInternal)\n        ) {\n            if (!this.hidden) {\n                this.hidden = [];\n            }\n            this.hidden.push(reflection);\n        }\n\n        if (reflection.kindOf(ReflectionKind.ExternalModule)) {\n            CommentPlugin.removeTags(comment, 'packagedocumentation');\n        }\n    }\n\n    /**\n     * Triggered when the converter begins converting a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBegin(context: Context) {\n        this.hidden = undefined;\n        this.comments = {};\n    }\n\n    /**\n     * Triggered when the converter has created a type parameter reflection.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onCreateTypeParameter(context: Context, reflection: TypeParameterReflection, node?: ts.Node) {\n        const comment = reflection.parent && reflection.parent.comment;\n        if (comment) {\n            let tag = comment.getTag('typeparam', reflection.name);\n            if (!tag) {\n                tag = comment.getTag('param', `<${reflection.name}>`);\n            }\n            if (!tag) {\n                tag = comment.getTag('param', reflection.name);\n            }\n\n            if (tag) {\n                reflection.comment = new Comment(tag.text);\n                // comment.tags must be set if we found a tag.\n                comment.tags!.splice(comment.tags!.indexOf(tag), 1);\n            }\n        }\n    }\n\n    /**\n     * Triggered when the converter has created a declaration or signature reflection.\n     *\n     * Invokes the comment parser.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onDeclaration(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (!node) {\n            return;\n        }\n        const rawComment = getRawComment(node);\n        if (!rawComment) {\n            return;\n        }\n\n        if (reflection.kindOf(ReflectionKind.FunctionOrMethod) || (reflection.kindOf(ReflectionKind.Event) && reflection['signatures'])) {\n            const comment = parseComment(rawComment, reflection.comment);\n            this.applyModifiers(reflection, comment);\n        } else if (reflection.kindOf(ReflectionKind.Module)) {\n            this.storeModuleComment(rawComment, reflection);\n        } else {\n            const comment = parseComment(rawComment, reflection.comment);\n            this.applyModifiers(reflection, comment);\n            reflection.comment = comment;\n        }\n    }\n\n    /**\n     * Triggered when the converter has found a function implementation.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onFunctionImplementation(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (!node) {\n            return;\n        }\n\n        const comment = getRawComment(node);\n        if (comment) {\n            reflection.comment = parseComment(comment, reflection.comment);\n        }\n    }\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBeginResolve(context: Context) {\n        for (const id in this.comments) {\n            if (!this.comments.hasOwnProperty(id)) {\n                continue;\n            }\n\n            const info    = this.comments[id];\n            const comment = parseComment(info.fullText);\n            CommentPlugin.removeTags(comment, 'preferred');\n\n            this.applyModifiers(info.reflection, comment);\n            info.reflection.comment = comment;\n        }\n\n        if (this.hidden) {\n            const project = context.project;\n            CommentPlugin.removeReflections(project, this.hidden);\n        }\n    }\n\n    /**\n     * Triggered when the converter resolves a reflection.\n     *\n     * Cleans up comment tags related to signatures like @param or @return\n     * and moves their data to the corresponding parameter reflections.\n     *\n     * This hook also copies over the comment of function implementations to their\n     * signatures.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently resolved.\n     */\n    private onResolve(context: Context, reflection: DeclarationReflection) {\n        if (!(reflection instanceof DeclarationReflection)) {\n            return;\n        }\n\n        const signatures = reflection.getAllSignatures();\n        if (signatures.length) {\n            const comment = reflection.comment;\n            if (comment && comment.hasTag('returns')) {\n                comment.returns = comment.getTag('returns')!.text;\n                CommentPlugin.removeTags(comment, 'returns');\n            }\n\n            signatures.forEach((signature) => {\n                let childComment = signature.comment;\n                if (childComment && childComment.hasTag('returns')) {\n                    childComment.returns = childComment.getTag('returns')!.text;\n                    CommentPlugin.removeTags(childComment, 'returns');\n                }\n\n                if (comment) {\n                    if (!childComment) {\n                        childComment = signature.comment = new Comment();\n                    }\n\n                    childComment.shortText = childComment.shortText || comment.shortText;\n                    childComment.text      = childComment.text      || comment.text;\n                    childComment.returns   = childComment.returns   || comment.returns;\n                }\n\n                if (signature.parameters) {\n                    signature.parameters.forEach((parameter) => {\n                        let tag: CommentTag | undefined;\n                        if (childComment) {\n                            tag = childComment.getTag('param', parameter.name);\n                        }\n                        if (comment && !tag) {\n                            tag = comment.getTag('param', parameter.name);\n                        }\n                        if (tag) {\n                            parameter.comment = new Comment(tag.text);\n                        }\n                    });\n                }\n\n                CommentPlugin.removeTags(childComment, 'param');\n            });\n\n            CommentPlugin.removeTags(comment, 'param');\n        }\n    }\n\n    /**\n     * Remove all tags with the given name from the given comment instance.\n     *\n     * @param comment  The comment that should be modified.\n     * @param tagName  The name of the that that should be removed.\n     */\n    static removeTags(comment: Comment | undefined, tagName: string) {\n        if (!comment || !comment.tags) {\n            return;\n        }\n\n        let i = 0, c = comment.tags.length;\n        while (i < c) {\n            if (comment.tags[i].tagName === tagName) {\n                comment.tags.splice(i, 1);\n                c--;\n            } else {\n                i++;\n            }\n        }\n    }\n\n    /**\n     * Remove the specified reflections from the project.\n     */\n    static removeReflections(project: ProjectReflection, reflections: Reflection[]) {\n        const deletedIds: number[] = [];\n        reflections.forEach((reflection) => {\n            CommentPlugin.removeReflection(project, reflection, deletedIds);\n        });\n\n        for (const key in project.symbolMapping) {\n            if (project.symbolMapping.hasOwnProperty(key) && deletedIds.includes(project.symbolMapping[key])) {\n                delete project.symbolMapping[key];\n            }\n        }\n    }\n\n    /**\n     * Remove the given reflection from the project.\n     */\n    static removeReflection(project: ProjectReflection, reflection: Reflection, deletedIds?: number[]) {\n        reflection.traverse((child) => CommentPlugin.removeReflection(project, child, deletedIds));\n\n        const parent = <DeclarationReflection> reflection.parent;\n        parent.traverse((child: Reflection, property: TraverseProperty) => {\n            if (child === reflection) {\n                switch (property) {\n                    case TraverseProperty.Children:\n                        if (parent.children) {\n                            const index = parent.children.indexOf(<DeclarationReflection> reflection);\n                            if (index !== -1) {\n                                parent.children.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.GetSignature:\n                        delete parent.getSignature;\n                        break;\n                    case TraverseProperty.IndexSignature:\n                        delete parent.indexSignature;\n                        break;\n                    case TraverseProperty.Parameters:\n                        if ((<SignatureReflection> reflection.parent).parameters) {\n                            const index = (<SignatureReflection> reflection.parent).parameters!.indexOf(<ParameterReflection> reflection);\n                            if (index !== -1) {\n                                (<SignatureReflection> reflection.parent).parameters!.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.SetSignature:\n                        delete parent.setSignature;\n                        break;\n                    case TraverseProperty.Signatures:\n                        if (parent.signatures) {\n                            const index = parent.signatures.indexOf(<SignatureReflection> reflection);\n                            if (index !== -1) {\n                                parent.signatures.splice(index, 1);\n                            }\n                        }\n                        break;\n                    case TraverseProperty.TypeLiteral:\n                        parent.type = new IntrinsicType('Object');\n                        break;\n                    case TraverseProperty.TypeParameter:\n                        if (parent.typeParameters) {\n                            const index = parent.typeParameters.indexOf(<TypeParameterReflection> reflection);\n                            if (index !== -1) {\n                                parent.typeParameters.splice(index, 1);\n                            }\n                        }\n                        break;\n                }\n            }\n        });\n\n        const id = reflection.id;\n        delete project.reflections[id];\n\n        // if an array was provided, keep track of the reflections that have been deleted, otherwise clean symbol mappings\n        if (deletedIds) {\n            deletedIds.push(id);\n        } else {\n            for (const key in project.symbolMapping) {\n                if (project.symbolMapping.hasOwnProperty(key) && project.symbolMapping[key] === id) {\n                    delete project.symbolMapping[key];\n                }\n            }\n        }\n\n    }\n}\n"]}

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -63,7 +63,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         if (this.packageFile) {
             project.packageInfo = JSON.parse(FS.readFileSync(this.packageFile, 'utf-8'));
             if (!project.name) {
-                project.name = project.packageInfo.name;
+                project.name = `${project.packageInfo.name} - v${project.packageInfo.version}`;
             }
         }
     }

package/dist/lib/converter/plugins/PackagePlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"PackagePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/PackagePlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,6BAA6B;AAC7B,yBAAyB;AAIzB,8CAA8D;AAC9D,4CAAyC;AAEzC,qDAA+C;AAW/C,IAAa,aAAa,GAA1B,MAAa,aAAc,SAAQ,+BAAkB;IA8BjD,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAU,IAAI,CAAC,OAAO;YAC7C,CAAC,qBAAS,CAAC,gBAAgB,CAAC,EAAK,IAAI,CAAC,eAAe;YACrD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAC,cAAc;SACvD,CAAC,CAAC;IACP,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,MAAM,EAAE;YAC9B,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBACvB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;aAC5B;SACJ;IACL,CAAC;IASO,eAAe,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAoB;QAClF,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC;QAC/F,MAAM,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1F,MAAM,gBAAgB,GAAG,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEnE,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC5F,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,iBAAiB,KAAK,WAAW,EAAE;oBAC7E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC9C;gBAED,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,iBAAiB,KAAK,cAAc,EAAE;oBAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC/C;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;SACpD;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;SAC9D;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;YAC7E,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;gBACf,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;aAC3C;SACJ;IACL,CAAC;CACJ,CAAA;AA1GG;IAJC,kBAAM,CAAC;QACJ,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,4JAA4J;KACrK,CAAC;6CACc;AALP,aAAa;IADzB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,aAAa,CA+GzB;AA/GY,sCAAa","sourcesContent":["import * as Path from 'path';\nimport * as FS from 'fs';\nimport * as ts from 'typescript';\n\nimport { Reflection } from '../../models/reflections/abstract';\nimport { Component, ConverterComponent } from '../components';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { Option } from '../../utils/component';\n\n/**\n * A handler that tries to find the package.json and readme.md files of the\n * current project.\n *\n * The handler traverses the file tree upwards for each file processed by the processor\n * and records the nearest package info files it can find. Within the resolve files, the\n * contents of the found files will be read and appended to the ProjectReflection.\n */\n@Component({name: 'package'})\nexport class PackagePlugin extends ConverterComponent {\n    @Option({\n        name: 'readme',\n        help: 'Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.'\n    })\n    readme!: string;\n\n    /**\n     * The file name of the found readme.md file.\n     */\n    private readmeFile?: string;\n\n    /**\n     * The file name of the found package.json file.\n     */\n    private packageFile?: string;\n\n    /**\n     * List of directories the handler already inspected.\n     */\n    private visited!: string[];\n\n    /**\n     * Should the readme file be ignored?\n     */\n    private noReadmeFile?: boolean;\n\n    /**\n     * Create a new PackageHandler instance.\n     */\n    initialize() {\n        this.listenTo(this.owner, {\n            [Converter.EVENT_BEGIN]:         this.onBegin,\n            [Converter.EVENT_FILE_BEGIN]:    this.onBeginDocument,\n            [Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve\n        });\n    }\n\n    /**\n     * Triggered when the converter begins converting a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBegin(context: Context) {\n        this.readmeFile = undefined;\n        this.packageFile = undefined;\n        this.visited = [];\n\n        let readme = this.readme;\n        this.noReadmeFile = (readme === 'none');\n        if (!this.noReadmeFile && readme) {\n            readme = Path.resolve(readme);\n            if (FS.existsSync(readme)) {\n                this.readmeFile = readme;\n            }\n        }\n    }\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onBeginDocument(context: Context, reflection: Reflection, node?: ts.SourceFile) {\n        const packageAndReadmeFound = () => (this.noReadmeFile || this.readmeFile) && this.packageFile;\n        const reachedTopDirectory = dirName => dirName === Path.resolve(Path.join(dirName, '..'));\n        const visitedDirBefore = dirName => this.visited.includes(dirName);\n\n        if (!node) {\n            return;\n        }\n\n        const fileName = node.fileName;\n        let dirName = Path.resolve(Path.dirname(fileName));\n        while (!packageAndReadmeFound() && !reachedTopDirectory(dirName) && !visitedDirBefore(dirName)) {\n            FS.readdirSync(dirName).forEach((file) => {\n                const lowercaseFileName = file.toLowerCase();\n                if (!this.noReadmeFile && !this.readmeFile && lowercaseFileName === 'readme.md') {\n                    this.readmeFile = Path.join(dirName, file);\n                }\n\n                if (!this.packageFile && lowercaseFileName === 'package.json') {\n                    this.packageFile = Path.join(dirName, file);\n                }\n            });\n\n            this.visited.push(dirName);\n            dirName = Path.resolve(Path.join(dirName, '..'));\n        }\n    }\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBeginResolve(context: Context) {\n        const project = context.project;\n        if (this.readmeFile) {\n            project.readme = FS.readFileSync(this.readmeFile, 'utf-8');\n        }\n\n        if (this.packageFile) {\n            project.packageInfo = JSON.parse(FS.readFileSync(this.packageFile, 'utf-8'));\n            if (!project.name) {\n                project.name = project.packageInfo.name;\n            }\n        }\n    }\n}\n"]}
+{"version":3,"file":"PackagePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/PackagePlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,6BAA6B;AAC7B,yBAAyB;AAIzB,8CAA8D;AAC9D,4CAAyC;AAEzC,qDAA+C;AAW/C,IAAa,aAAa,GAA1B,MAAa,aAAc,SAAQ,+BAAkB;IA8BjD,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAU,IAAI,CAAC,OAAO;YAC7C,CAAC,qBAAS,CAAC,gBAAgB,CAAC,EAAK,IAAI,CAAC,eAAe;YACrD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAC,cAAc;SACvD,CAAC,CAAC;IACP,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,MAAM,EAAE;YAC9B,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBACvB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;aAC5B;SACJ;IACL,CAAC;IASO,eAAe,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAoB;QAClF,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC;QAC/F,MAAM,mBAAmB,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1F,MAAM,gBAAgB,GAAG,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEnE,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC5F,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC7C,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,iBAAiB,KAAK,WAAW,EAAE;oBAC7E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC9C;gBAED,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,iBAAiB,KAAK,cAAc,EAAE;oBAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;iBAC/C;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;SACpD;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;SAC9D;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;YAC7E,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;gBACf,OAAO,CAAC,IAAI,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;aAClF;SACJ;IACL,CAAC;CACJ,CAAA;AA1GG;IAJC,kBAAM,CAAC;QACJ,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,4JAA4J;KACrK,CAAC;6CACc;AALP,aAAa;IADzB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,aAAa,CA+GzB;AA/GY,sCAAa","sourcesContent":["import * as Path from 'path';\nimport * as FS from 'fs';\nimport * as ts from 'typescript';\n\nimport { Reflection } from '../../models/reflections/abstract';\nimport { Component, ConverterComponent } from '../components';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { Option } from '../../utils/component';\n\n/**\n * A handler that tries to find the package.json and readme.md files of the\n * current project.\n *\n * The handler traverses the file tree upwards for each file processed by the processor\n * and records the nearest package info files it can find. Within the resolve files, the\n * contents of the found files will be read and appended to the ProjectReflection.\n */\n@Component({name: 'package'})\nexport class PackagePlugin extends ConverterComponent {\n    @Option({\n        name: 'readme',\n        help: 'Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.'\n    })\n    readme!: string;\n\n    /**\n     * The file name of the found readme.md file.\n     */\n    private readmeFile?: string;\n\n    /**\n     * The file name of the found package.json file.\n     */\n    private packageFile?: string;\n\n    /**\n     * List of directories the handler already inspected.\n     */\n    private visited!: string[];\n\n    /**\n     * Should the readme file be ignored?\n     */\n    private noReadmeFile?: boolean;\n\n    /**\n     * Create a new PackageHandler instance.\n     */\n    initialize() {\n        this.listenTo(this.owner, {\n            [Converter.EVENT_BEGIN]:         this.onBegin,\n            [Converter.EVENT_FILE_BEGIN]:    this.onBeginDocument,\n            [Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve\n        });\n    }\n\n    /**\n     * Triggered when the converter begins converting a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBegin(context: Context) {\n        this.readmeFile = undefined;\n        this.packageFile = undefined;\n        this.visited = [];\n\n        let readme = this.readme;\n        this.noReadmeFile = (readme === 'none');\n        if (!this.noReadmeFile && readme) {\n            readme = Path.resolve(readme);\n            if (FS.existsSync(readme)) {\n                this.readmeFile = readme;\n            }\n        }\n    }\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param reflection  The reflection that is currently processed.\n     * @param node  The node that is currently processed if available.\n     */\n    private onBeginDocument(context: Context, reflection: Reflection, node?: ts.SourceFile) {\n        const packageAndReadmeFound = () => (this.noReadmeFile || this.readmeFile) && this.packageFile;\n        const reachedTopDirectory = dirName => dirName === Path.resolve(Path.join(dirName, '..'));\n        const visitedDirBefore = dirName => this.visited.includes(dirName);\n\n        if (!node) {\n            return;\n        }\n\n        const fileName = node.fileName;\n        let dirName = Path.resolve(Path.dirname(fileName));\n        while (!packageAndReadmeFound() && !reachedTopDirectory(dirName) && !visitedDirBefore(dirName)) {\n            FS.readdirSync(dirName).forEach((file) => {\n                const lowercaseFileName = file.toLowerCase();\n                if (!this.noReadmeFile && !this.readmeFile && lowercaseFileName === 'readme.md') {\n                    this.readmeFile = Path.join(dirName, file);\n                }\n\n                if (!this.packageFile && lowercaseFileName === 'package.json') {\n                    this.packageFile = Path.join(dirName, file);\n                }\n            });\n\n            this.visited.push(dirName);\n            dirName = Path.resolve(Path.join(dirName, '..'));\n        }\n    }\n\n    /**\n     * Triggered when the converter begins resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onBeginResolve(context: Context) {\n        const project = context.project;\n        if (this.readmeFile) {\n            project.readme = FS.readFileSync(this.readmeFile, 'utf-8');\n        }\n\n        if (this.packageFile) {\n            project.packageInfo = JSON.parse(FS.readFileSync(this.packageFile, 'utf-8'));\n            if (!project.name) {\n                project.name = `${project.packageInfo.name} - v${project.packageInfo.version}`;\n            }\n        }\n    }\n}\n"]}

package/dist/lib/converter/types/conditional.d.ts

@@ -0,0 +1,10 @@
+import * as ts from 'typescript';
+import { ConditionalType } from '../../models/types';
+import { ConverterTypeComponent, TypeConverter } from '../components';
+import { Context } from '../context';
+export declare class ConditionalConverter extends ConverterTypeComponent implements TypeConverter<ts.ConditionalType, ts.ConditionalTypeNode> {
+    supportsNode(context: Context, node: ts.ConditionalTypeNode): boolean;
+    supportsType(context: Context, type: ts.ConditionalType): boolean;
+    convertNode(context: Context, node: ts.ConditionalTypeNode): ConditionalType | undefined;
+    convertType(context: Context, type: ts.ConditionalType): ConditionalType | undefined;
+}

package/dist/lib/converter/types/conditional.js

@@ -0,0 +1,38 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts = require("typescript");
+const types_1 = require("../../models/types");
+const components_1 = require("../components");
+let ConditionalConverter = class ConditionalConverter extends components_1.ConverterTypeComponent {
+    supportsNode(context, node) {
+        return node.kind === ts.SyntaxKind.ConditionalType;
+    }
+    supportsType(context, type) {
+        return !!(type.flags & ts.TypeFlags.Conditional);
+    }
+    convertNode(context, node) {
+        const types = this.owner.convertTypes(context, [node.checkType, node.extendsType, node.trueType, node.falseType]);
+        if (types.length !== 4) {
+            return undefined;
+        }
+        return new types_1.ConditionalType(...types);
+    }
+    convertType(context, type) {
+        const types = this.owner.convertTypes(context, [], [type.checkType, type.extendsType, type.resolvedTrueType, type.resolvedFalseType]);
+        if (types.length !== 4) {
+            return undefined;
+        }
+        return new types_1.ConditionalType(...types);
+    }
+};
+ConditionalConverter = __decorate([
+    components_1.Component({ name: 'type:conditional' })
+], ConditionalConverter);
+exports.ConditionalConverter = ConditionalConverter;
+//# sourceMappingURL=conditional.js.map

package/dist/lib/converter/types/conditional.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditional.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/conditional.ts"],"names":[],"mappings":";;;;;;;;AAAA,iCAAiC;AAEjC,8CAA2D;AAC3D,8CAAiF;AAIjF,IAAa,oBAAoB,GAAjC,MAAa,oBAAqB,SAAQ,mCAAsB;IAI5D,YAAY,CAAC,OAAgB,EAAE,IAA4B;QACvD,OAAO,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC;IACvD,CAAC;IAKD,YAAY,CAAC,OAAgB,EAAE,IAAwB;QACnD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAWD,WAAW,CAAC,OAAgB,EAAE,IAA4B;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAClH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,IAAI,uBAAe,CAAC,GAAG,KAAiC,CAAC,CAAC;IACrE,CAAC;IAWD,WAAW,CAAC,OAAgB,EAAE,IAAwB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACtI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,IAAI,uBAAe,CAAC,GAAG,KAAiC,CAAC,CAAC;IACrE,CAAC;CACJ,CAAA;AAhDY,oBAAoB;IADhC,sBAAS,CAAC,EAAC,IAAI,EAAE,kBAAkB,EAAC,CAAC;GACzB,oBAAoB,CAgDhC;AAhDY,oDAAoB","sourcesContent":["import * as ts from 'typescript';\n\nimport { ConditionalType, Type } from '../../models/types';\nimport { Component, ConverterTypeComponent, TypeConverter } from '../components';\nimport { Context } from '../context';\n\n@Component({name: 'type:conditional'})\nexport class ConditionalConverter extends ConverterTypeComponent implements TypeConverter<ts.ConditionalType, ts.ConditionalTypeNode> {\n    /**\n     * Test whether this converter can handle the given TypeScript node.\n     */\n    supportsNode(context: Context, node: ts.ConditionalTypeNode): boolean {\n        return node.kind === ts.SyntaxKind.ConditionalType;\n    }\n\n    /**\n     * Test whether this converter can handle the given TypeScript type.\n     */\n    supportsType(context: Context, type: ts.ConditionalType): boolean {\n        return !!(type.flags & ts.TypeFlags.Conditional);\n    }\n\n    /**\n     * Convert the given conditional type node to its type reflection.\n     *\n     * This is a node based converter, see [[convertType]] for the type equivalent.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node  The conditional or intersection type node that should be converted.\n     * @returns The type reflection representing the given conditional type node.\n     */\n    convertNode(context: Context, node: ts.ConditionalTypeNode): ConditionalType | undefined {\n        const types = this.owner.convertTypes(context, [node.checkType, node.extendsType, node.trueType, node.falseType]);\n        if (types.length !== 4) {\n            return undefined;\n        }\n        return new ConditionalType(...types as [Type, Type, Type, Type]);\n    }\n\n    /**\n     * Convert the given conditional type to its type reflection.\n     *\n     * This is a type based converter, see [[convertNode]] for the node equivalent.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param type  The conditional type that should be converted.\n     * @returns The type reflection representing the given conditional type.\n     */\n    convertType(context: Context, type: ts.ConditionalType): ConditionalType | undefined {\n        const types = this.owner.convertTypes(context, [], [type.checkType, type.extendsType, type.resolvedTrueType, type.resolvedFalseType]);\n        if (types.length !== 4) {\n            return undefined;\n        }\n        return new ConditionalType(...types as [Type, Type, Type, Type]);\n    }\n}\n"]}

package/dist/lib/converter/types/index.d.ts

@@ -2,7 +2,10 @@ export { AliasConverter } from './alias';
 export { ArrayConverter } from './array';
 export { BindingArrayConverter } from './binding-array';
 export { BindingObjectConverter } from './binding-object';
+export { ConditionalConverter } from './conditional';
 export { EnumConverter } from './enum';
+export { InferredConverter } from './inferred';
+export { IndexedAccessConverter } from './indexed-access';
 export { IntrinsicConverter } from './intrinsic';
 export { PredicateConverter } from './predicate';
 export { StringLiteralConverter } from './string-literal';

package/dist/lib/converter/types/index.js

@@ -8,8 +8,14 @@ var binding_array_1 = require("./binding-array");
 exports.BindingArrayConverter = binding_array_1.BindingArrayConverter;
 var binding_object_1 = require("./binding-object");
 exports.BindingObjectConverter = binding_object_1.BindingObjectConverter;
+var conditional_1 = require("./conditional");
+exports.ConditionalConverter = conditional_1.ConditionalConverter;
 var enum_1 = require("./enum");
 exports.EnumConverter = enum_1.EnumConverter;
+var inferred_1 = require("./inferred");
+exports.InferredConverter = inferred_1.InferredConverter;
+var indexed_access_1 = require("./indexed-access");
+exports.IndexedAccessConverter = indexed_access_1.IndexedAccessConverter;
 var intrinsic_1 = require("./intrinsic");
 exports.IntrinsicConverter = intrinsic_1.IntrinsicConverter;
 var predicate_1 = require("./predicate");

package/dist/lib/converter/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/index.ts"],"names":[],"mappings":";;AAAA,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,iDAAwD;AAA/C,gDAAA,qBAAqB,CAAA;AAC9B,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,+BAAuC;AAA9B,+BAAA,aAAa,CAAA;AACtB,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,+BAAuC;AAA9B,+BAAA,aAAa,CAAA;AACtB,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,iDAAwD;AAA/C,gDAAA,qBAAqB,CAAA;AAC9B,iEAAuE;AAA9D,+DAAA,4BAA4B,CAAA;AACrC,qCAA6C;AAApC,qCAAA,gBAAgB,CAAA","sourcesContent":["export { AliasConverter } from './alias';\nexport { ArrayConverter } from './array';\nexport { BindingArrayConverter } from './binding-array';\nexport { BindingObjectConverter } from './binding-object';\nexport { EnumConverter } from './enum';\nexport { IntrinsicConverter } from './intrinsic';\nexport { PredicateConverter } from './predicate';\nexport { StringLiteralConverter } from './string-literal';\nexport { ReferenceConverter } from './reference';\nexport { ThisConverter } from './this';\nexport { TupleConverter } from './tuple';\nexport { TypeParameterConverter } from './type-parameter';\nexport { TypeOperatorConverter } from './type-operator';\nexport { UnionOrIntersectionConverter } from './union-or-intersection';\nexport { UnknownConverter } from './unknown';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/index.ts"],"names":[],"mappings":";;AAAA,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,iDAAwD;AAA/C,gDAAA,qBAAqB,CAAA;AAC9B,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,6CAAqD;AAA5C,6CAAA,oBAAoB,CAAA;AAC7B,+BAAuC;AAA9B,+BAAA,aAAa,CAAA;AACtB,uCAA+C;AAAtC,uCAAA,iBAAiB,CAAA;AAC1B,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,yCAAiD;AAAxC,yCAAA,kBAAkB,CAAA;AAC3B,+BAAuC;AAA9B,+BAAA,aAAa,CAAA;AACtB,iCAAyC;AAAhC,iCAAA,cAAc,CAAA;AACvB,mDAA0D;AAAjD,kDAAA,sBAAsB,CAAA;AAC/B,iDAAwD;AAA/C,gDAAA,qBAAqB,CAAA;AAC9B,iEAAuE;AAA9D,+DAAA,4BAA4B,CAAA;AACrC,qCAA6C;AAApC,qCAAA,gBAAgB,CAAA","sourcesContent":["export { AliasConverter } from './alias';\nexport { ArrayConverter } from './array';\nexport { BindingArrayConverter } from './binding-array';\nexport { BindingObjectConverter } from './binding-object';\nexport { ConditionalConverter } from './conditional';\nexport { EnumConverter } from './enum';\nexport { InferredConverter } from './inferred';\nexport { IndexedAccessConverter } from './indexed-access';\nexport { IntrinsicConverter } from './intrinsic';\nexport { PredicateConverter } from './predicate';\nexport { StringLiteralConverter } from './string-literal';\nexport { ReferenceConverter } from './reference';\nexport { ThisConverter } from './this';\nexport { TupleConverter } from './tuple';\nexport { TypeParameterConverter } from './type-parameter';\nexport { TypeOperatorConverter } from './type-operator';\nexport { UnionOrIntersectionConverter } from './union-or-intersection';\nexport { UnknownConverter } from './unknown';\n"]}

package/dist/lib/converter/types/indexed-access.d.ts

@@ -0,0 +1,8 @@
+import * as ts from 'typescript';
+import { Type } from '../../models/index';
+import { ConverterTypeComponent, TypeNodeConverter } from '../components';
+import { Context } from '../context';
+export declare class IndexedAccessConverter extends ConverterTypeComponent implements TypeNodeConverter<ts.Type, ts.IndexedAccessTypeNode> {
+    supportsNode(context: Context, node: ts.TypeNode): boolean;
+    convertNode(context: Context, node: ts.IndexedAccessTypeNode): Type | undefined;
+}

package/dist/lib/converter/types/indexed-access.js

@@ -0,0 +1,32 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts = require("typescript");
+const index_1 = require("../../models/index");
+const components_1 = require("../components");
+let IndexedAccessConverter = class IndexedAccessConverter extends components_1.ConverterTypeComponent {
+    supportsNode(context, node) {
+        return ts.isIndexedAccessTypeNode(node);
+    }
+    convertNode(context, node) {
+        const objectType = this.owner.convertType(context, node.objectType);
+        if (!objectType) {
+            return;
+        }
+        const indexType = this.owner.convertType(context, node.indexType);
+        if (!indexType) {
+            return;
+        }
+        return new index_1.IndexedAccessType(objectType, indexType);
+    }
+};
+IndexedAccessConverter = __decorate([
+    components_1.Component({ name: 'type:indexed-access' })
+], IndexedAccessConverter);
+exports.IndexedAccessConverter = IndexedAccessConverter;
+//# sourceMappingURL=indexed-access.js.map

package/dist/lib/converter/types/indexed-access.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexed-access.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/indexed-access.ts"],"names":[],"mappings":";;;;;;;;AAAA,iCAAiC;AAEjC,8CAA6D;AAC7D,8CAIuB;AAIvB,IAAa,sBAAsB,GAAnC,MAAa,sBAAuB,SAAQ,mCAAsB;IAK9D,YAAY,CAAC,OAAgB,EAAE,IAAiB;QAC5C,OAAO,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,WAAW,CAAC,OAAgB,EAAE,IAA8B;QACxD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,UAAU,EAAE;YAAE,OAAO;SAAE;QAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,SAAS,EAAE;YAAE,OAAO;SAAE;QAC3B,OAAO,IAAI,yBAAiB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;CACJ,CAAA;AAhBY,sBAAsB;IADlC,sBAAS,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;GAC9B,sBAAsB,CAgBlC;AAhBY,wDAAsB","sourcesContent":["import * as ts from 'typescript';\n\nimport { Type, IndexedAccessType } from '../../models/index';\nimport {\n    Component,\n    ConverterTypeComponent,\n    TypeNodeConverter\n} from '../components';\nimport { Context } from '../context';\n\n@Component({ name: 'type:indexed-access' })\nexport class IndexedAccessConverter extends ConverterTypeComponent\n    implements TypeNodeConverter<ts.Type, ts.IndexedAccessTypeNode> {\n    /**\n     * Test whether this converter can handle the given TypeScript node.\n     */\n    supportsNode(context: Context, node: ts.TypeNode) {\n        return ts.isIndexedAccessTypeNode(node);\n    }\n\n    convertNode(context: Context, node: ts.IndexedAccessTypeNode): Type | undefined {\n        const objectType = this.owner.convertType(context, node.objectType);\n        if (!objectType) { return; }\n        const indexType = this.owner.convertType(context, node.indexType);\n        if (!indexType) { return; }\n        return new IndexedAccessType(objectType, indexType);\n    }\n}\n"]}

package/dist/lib/converter/types/inferred.d.ts

@@ -0,0 +1,8 @@
+import * as ts from 'typescript';
+import { InferredType } from '../../models/types';
+import { ConverterTypeComponent, TypeNodeConverter } from '../components';
+import { Context } from '../context';
+export declare class InferredConverter extends ConverterTypeComponent implements TypeNodeConverter<ts.Type, ts.InferTypeNode> {
+    supportsNode(_context: Context, node: ts.TypeNode): boolean;
+    convertNode(context: Context, node: ts.InferTypeNode): InferredType | undefined;
+}

package/dist/lib/converter/types/inferred.js

@@ -0,0 +1,24 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts = require("typescript");
+const types_1 = require("../../models/types");
+const components_1 = require("../components");
+let InferredConverter = class InferredConverter extends components_1.ConverterTypeComponent {
+    supportsNode(_context, node) {
+        return ts.isInferTypeNode(node);
+    }
+    convertNode(context, node) {
+        return new types_1.InferredType(node.typeParameter.getText());
+    }
+};
+InferredConverter = __decorate([
+    components_1.Component({ name: 'type:inferred' })
+], InferredConverter);
+exports.InferredConverter = InferredConverter;
+//# sourceMappingURL=inferred.js.map

package/dist/lib/converter/types/inferred.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inferred.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/inferred.ts"],"names":[],"mappings":";;;;;;;;AAAA,iCAAiC;AAEjC,8CAAkD;AAClD,8CAAqF;AAIrF,IAAa,iBAAiB,GAA9B,MAAa,iBAAkB,SAAQ,mCAAsB;IAIzD,YAAY,CAAC,QAAiB,EAAE,IAAiB;QAC7C,OAAO,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAWD,WAAW,CAAC,OAAgB,EAAE,IAAsB;QAChD,OAAO,IAAI,oBAAY,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;CACJ,CAAA;AApBY,iBAAiB;IAD7B,sBAAS,CAAC,EAAC,IAAI,EAAE,eAAe,EAAC,CAAC;GACtB,iBAAiB,CAoB7B;AApBY,8CAAiB","sourcesContent":["import * as ts from 'typescript';\n\nimport { InferredType } from '../../models/types';\nimport { Component, ConverterTypeComponent, TypeNodeConverter } from '../components';\nimport { Context } from '../context';\n\n@Component({name: 'type:inferred'})\nexport class InferredConverter extends ConverterTypeComponent implements TypeNodeConverter<ts.Type, ts.InferTypeNode> {\n    /**\n     * Test whether this converter can handle the given TypeScript node.\n     */\n    supportsNode(_context: Context, node: ts.TypeNode): boolean {\n        return ts.isInferTypeNode(node);\n    }\n\n    /**\n     * Convert the given conditional type node to its type reflection.\n     *\n     * This is a node based converter, see [[convertType]] for the type equivalent.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     * @param node  The conditional or intersection type node that should be converted.\n     * @returns The type reflection representing the given conditional type node.\n     */\n    convertNode(context: Context, node: ts.InferTypeNode): InferredType | undefined {\n        return new InferredType(node.typeParameter.getText());\n    }\n}\n"]}