typedoc 0.17.7 → 0.17.8

package/dist/lib/application.js

@@ -124,6 +124,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         function isExcluded(fileName) {
             return exclude.some(mm => mm.match(fileName));
         }
+        const includeJson = this.options.getCompilerOptions().resolveJsonModule;
         const supportedFileRegex = this.options.getCompilerOptions().allowJs ? /\.[tj]sx?$/ : /\.tsx?$/;
         function add(file, entryPoint) {
             let stats;
@@ -148,6 +149,9 @@ let Application = Application_1 = class Application extends component_1.Childabl
             else if (supportedFileRegex.test(file)) {
                 files.push(file);
             }
+            else if (includeJson && file.endsWith('.json')) {
+                files.push(file);
+            }
         }
         inputFiles.forEach(file => {
             add(Path.resolve(file), true);
@@ -163,7 +167,7 @@ let Application = Application_1 = class Application extends component_1.Childabl
         ].join(typescript.sys.newLine);
     }
 };
-Application.VERSION = '0.17.7';
+Application.VERSION = '0.17.8';
 __decorate([
     utils_1.BindOption('logger')
 ], Application.prototype, "loggerType", void 0);

package/dist/lib/application.js.map

@@ -1 +1 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/lib/application.ts"],"names":[],"mappings":";;;;;;;;;AAQA,6BAA6B;AAC7B,yBAAyB;AACzB,yCAAyC;AAEzC,6CAA8C;AAC9C,gDAA6C;AAC7C,mDAA6C;AAC7C,0CAAmD;AACnD,yCAAuG;AACvG,yCAAgD;AAEhD,iDAK2B;AAC3B,mCAA8C;AAkB9C,IAAa,WAAW,mBAAxB,MAAa,WAAY,SAAQ,8BAGhC;IAqDG;QACI,KAAK,CAAC,mCAAuB,CAAC,CAAC;QAE/B,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,IAAI,0BAAU,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAY,WAAW,EAAE,iBAAS,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,GAAI,IAAI,CAAC,YAAY,CAAW,UAAU,EAAE,mBAAQ,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAK,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,kBAAU,CAAC,CAAC;IAC9D,CAAC;IAOD,SAAS,CAAC,UAAwC,EAAE;QAChD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9C,IAAI;gBACA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAA2B,EAAE,GAAG,CAAC,CAAC;aAC3D;YAAC,WAAM;aAEP;SACJ;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,cAAM,EAAE,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAc,CAAO,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;aAAM,IAAI,MAAM,KAAK,MAAM,EAAE;YAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,cAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9C,IAAI;gBACA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAA2B,EAAE,GAAG,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACpC;SACJ;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,OAAO;YACH,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAClC,UAAU,EAAE,IAAI,CAAC,UAAU;SAC9B,CAAC;IACN,CAAC;IAKD,IAAI,WAAW;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAKM,iBAAiB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IACvD,CAAC;IAEM,oBAAoB;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAQM,OAAO,CAAC,GAAa;QACxB,IAAI,CAAC,MAAM,CAAC,OAAO,CACf,6BAA6B,EAC7B,IAAI,CAAC,oBAAoB,EAAE,EAC3B,IAAI,CAAC,iBAAiB,EAAE,CAC3B,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACvC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,IAAI,CAAC,oBAAoB,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC1B,OAAO,MAAM,CAAC,OAAO,CAAC;aACzB;iBAAM;gBACH,OAAO;aACV;SACJ;aAAM;YACH,OAAO,MAAM,CAAC,OAAO,CAAC;SACzB;IACL,CAAC;IAkBM,YAAY,CAAC,KAAmC,EAAE,GAAW;QAChE,MAAM,OAAO,GAAG,KAAK,YAAY,yBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;QAED,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;SACtF;aAAM;YACH,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;SAC7D;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAkBM,YAAY,CAAC,KAAmC,EAAE,GAAW;QAChE,MAAM,OAAO,GAAG,KAAK,YAAY,yBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;QAED,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACzF,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3F,iBAAS,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAYM,gBAAgB,CAAC,aAAuB,EAAE;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAElE,SAAS,UAAU,CAAC,QAAgB;YAChC,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAChG,SAAS,GAAG,CAAC,IAAY,EAAE,UAAmB;YAC1C,IAAI,KAAe,CAAC;YACpB,IAAI;gBACA,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aAC7B;YAAC,WAAM;gBAEJ,OAAO;aACV;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YACtC,IAAI,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAClC,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC;aACrB;YAED,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE;gBACrE,OAAO;aACV;YAED,IAAI,SAAS,EAAE;gBACX,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;gBACtC,CAAC,CAAC,CAAC;aACN;iBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACpB;QACL,CAAC;QAED,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACjB,CAAC;IAKD,QAAQ;QACJ,OAAO;YACH,EAAE;YACF,WAAW,aAAW,CAAC,OAAO,EAAE;YAChC,oBAAoB,IAAI,CAAC,oBAAoB,EAAE,SAAS,IAAI,CAAC,iBAAiB,EAAE,EAAE;YAClF,EAAE;SACL,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACJ,CAAA;AA5OU,mBAAO,GAAG,eAAe,CAAC;AApBjC;IADC,kBAAU,CAAC,QAAQ,CAAC;+CACU;AAG/B;IADC,kBAAU,CAAC,sBAAsB,CAAC;yDACJ;AAG/B;IADC,kBAAU,CAAC,SAAS,CAAC;4CACE;AAGxB;IADC,kBAAU,CAAC,YAAY,CAAC;+CACH;AAGtB;IADC,kBAAU,CAAC,SAAS,CAAC;gDACD;AAGrB;IADC,kBAAU,CAAC,UAAU,CAAC;4CACN;AA5CR,WAAW;IADvB,qBAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACtC,WAAW,CA6RvB;AA7RY,kCAAW","sourcesContent":["/**\n * The TypeDoc main module and namespace.\n *\n * The [[Application]] class holds the core logic of the cli application. All code related\n * to resolving reflections is stored in [[TypeDoc.Factories]], the actual data models can be found\n * in [[TypeDoc.Models]] and the final rendering is defined in [[TypeDoc.Output]].\n */\n\nimport * as Path from 'path';\nimport * as FS from 'fs';\nimport * as typescript from 'typescript';\n\nimport { Converter } from './converter/index';\nimport { Renderer } from './output/renderer';\nimport { Serializer } from './serialization';\nimport { ProjectReflection } from './models/index';\nimport { Logger, ConsoleLogger, CallbackLogger, PluginHost, writeFile, readFile } from './utils/index';\nimport { createMinimatch } from './utils/paths';\n\nimport {\n    AbstractComponent,\n    ChildableComponent,\n    Component,\n    DUMMY_APPLICATION_OWNER\n} from './utils/component';\nimport { Options, BindOption } from './utils';\nimport { TypeDocAndTSOptions, TypeDocOptions } from './utils/options/declaration';\n\n/**\n * The default TypeDoc main application class.\n *\n * This class holds the two main components of TypeDoc, the [[Dispatcher]] and\n * the [[Renderer]]. When running TypeDoc, first the [[Dispatcher]] is invoked which\n * generates a [[ProjectReflection]] from the passed in source files. The\n * [[ProjectReflection]] is a hierarchical model representation of the TypeScript\n * project. Afterwards the model is passed to the [[Renderer]] which uses an instance\n * of [[BaseTheme]] to generate the final documentation.\n *\n * Both the [[Dispatcher]] and the [[Renderer]] are subclasses of the [[EventDispatcher]]\n * and emit a series of events while processing the project. Subscribe to these Events\n * to control the application flow or alter the output.\n */\n@Component({ name: 'application', internal: true })\nexport class Application extends ChildableComponent<\n    Application,\n    AbstractComponent<Application>\n> {\n    /**\n     * The converter used to create the declaration reflections.\n     */\n    converter: Converter;\n\n    /**\n     * The renderer used to generate the documentation output.\n     */\n    renderer: Renderer;\n\n    /**\n     * The serializer used to generate JSON output.\n     */\n    serializer: Serializer;\n\n    /**\n     * The logger that should be used to output messages.\n     */\n    logger: Logger;\n\n    options: Options;\n\n    plugins: PluginHost;\n\n    @BindOption('logger')\n    loggerType!: string | Function;\n\n    @BindOption('ignoreCompilerErrors')\n    ignoreCompilerErrors!: boolean;\n\n    @BindOption('exclude')\n    exclude!: Array<string>;\n\n    @BindOption('inputFiles')\n    inputFiles!: string[];\n\n    @BindOption('options')\n    optionsFile!: string;\n\n    @BindOption('tsconfig')\n    project!: string;\n\n    /**\n     * The version number of TypeDoc.\n     */\n    static VERSION = '{{ VERSION }}';\n\n    /**\n     * Create a new TypeDoc application instance.\n     *\n     * @param options An object containing the options that should be used.\n     */\n    constructor() {\n        super(DUMMY_APPLICATION_OWNER);\n\n        this.logger = new ConsoleLogger();\n        this.options = new Options(this.logger);\n        this.options.addDefaultDeclarations();\n        this.serializer = new Serializer();\n        this.converter = this.addComponent<Converter>('converter', Converter);\n        this.renderer  = this.addComponent<Renderer>('renderer', Renderer);\n        this.plugins   = this.addComponent('plugins', PluginHost);\n    }\n\n    /**\n     * Initialize TypeDoc with the given options object.\n     *\n     * @param options  The desired options to set.\n     */\n    bootstrap(options: Partial<TypeDocAndTSOptions> = {}): { hasErrors: boolean, inputFiles: string[] } {\n        for (const [key, val] of Object.entries(options)) {\n            try {\n                this.options.setValue(key as keyof TypeDocOptions, val);\n            } catch {\n                // Ignore errors, plugins haven't been loaded yet and may declare an option.\n            }\n        }\n        this.options.read(new Logger());\n\n        const logger = this.loggerType;\n        if (typeof logger === 'function') {\n            this.logger = new CallbackLogger(<any> logger);\n            this.options.setLogger(this.logger);\n        } else if (logger === 'none') {\n            this.logger = new Logger();\n            this.options.setLogger(this.logger);\n        }\n\n        this.plugins.load();\n\n        this.options.reset();\n        for (const [key, val] of Object.entries(options)) {\n            try {\n                this.options.setValue(key as keyof TypeDocOptions, val);\n            } catch (error) {\n                this.logger.error(error.message);\n            }\n        }\n        this.options.read(this.logger);\n\n        return {\n            hasErrors: this.logger.hasErrors(),\n            inputFiles: this.inputFiles\n        };\n    }\n\n    /**\n     * Return the application / root component instance.\n     */\n    get application(): Application {\n        return this;\n    }\n\n    /**\n     * Return the path to the TypeScript compiler.\n     */\n    public getTypeScriptPath(): string {\n        return Path.dirname(require.resolve('typescript'));\n    }\n\n    public getTypeScriptVersion(): string {\n        const tsPath = this.getTypeScriptPath();\n        const json = JSON.parse(readFile(Path.join(tsPath, '..', 'package.json')));\n        return json.version;\n    }\n\n    /**\n     * Run the converter for the given set of files and return the generated reflections.\n     *\n     * @param src  A list of source that should be compiled and converted.\n     * @returns An instance of ProjectReflection on success, undefined otherwise.\n     */\n    public convert(src: string[]): ProjectReflection | undefined {\n        this.logger.writeln(\n            'Using TypeScript %s from %s',\n            this.getTypeScriptVersion(),\n            this.getTypeScriptPath()\n        );\n\n        const result = this.converter.convert(src);\n        if (result.errors && result.errors.length) {\n            this.logger.diagnostics(result.errors);\n            if (this.ignoreCompilerErrors) {\n                this.logger.resetErrors();\n                return result.project;\n            } else {\n                return;\n            }\n        } else {\n            return result.project;\n        }\n    }\n\n    /**\n     * @param src  A list of source files whose documentation should be generated.\n     */\n    public generateDocs(src: string[], out: string): boolean;\n\n    /**\n     * @param project  The project the documentation should be generated for.\n     */\n    public generateDocs(project: ProjectReflection, out: string): boolean;\n\n    /**\n     * Run the documentation generator for the given set of files.\n     *\n     * @param out  The path the documentation should be written to.\n     * @returns TRUE if the documentation could be generated successfully, otherwise FALSE.\n     */\n    public generateDocs(input: ProjectReflection | string[], out: string): boolean {\n        const project = input instanceof ProjectReflection ? input : this.convert(input);\n        if (!project) {\n            return false;\n        }\n\n        out = Path.resolve(out);\n        this.renderer.render(project, out);\n        if (this.logger.hasErrors()) {\n            this.logger.error('Documentation could not be generated due to the errors above.');\n        } else {\n            this.logger.success('Documentation generated at %s', out);\n        }\n\n        return true;\n    }\n\n    /**\n     * @param src  A list of source that should be compiled and converted.\n     */\n    public generateJson(src: string[], out: string): boolean;\n\n    /**\n     * @param project  The project that should be converted.\n     */\n    public generateJson(project: ProjectReflection, out: string): boolean;\n\n    /**\n     * Run the converter for the given set of files and write the reflections to a json file.\n     *\n     * @param out  The path and file name of the target file.\n     * @returns TRUE if the json file could be written successfully, otherwise FALSE.\n     */\n    public generateJson(input: ProjectReflection | string[], out: string): boolean {\n        const project = input instanceof ProjectReflection ? input : this.convert(input);\n        if (!project) {\n            return false;\n        }\n\n        out = Path.resolve(out);\n        const eventData = { outputDirectory: Path.dirname(out), outputFile: Path.basename(out) };\n        const ser = this.serializer.projectToObject(project, { begin: eventData, end: eventData });\n        writeFile(out, JSON.stringify(ser, null, '\\t'), false);\n        this.logger.success('JSON written to %s', out);\n\n        return true;\n    }\n\n    /**\n     * Expand a list of input files.\n     *\n     * Searches for directories in the input files list and replaces them with a\n     * listing of all TypeScript files within them. One may use the ```--exclude``` option\n     * to filter out files with a pattern.\n     *\n     * @param inputFiles  The list of files that should be expanded.\n     * @returns  The list of input files with expanded directories.\n     */\n    public expandInputFiles(inputFiles: string[] = []): string[] {\n        const files: string[] = [];\n\n        const exclude = this.exclude ? createMinimatch(this.exclude) : [];\n\n        function isExcluded(fileName: string): boolean {\n            return exclude.some(mm => mm.match(fileName));\n        }\n\n        const supportedFileRegex = this.options.getCompilerOptions().allowJs ? /\\.[tj]sx?$/ : /\\.tsx?$/;\n        function add(file: string, entryPoint: boolean) {\n            let stats: FS.Stats;\n            try {\n                stats = FS.statSync(file);\n            } catch {\n                // No permission or a symbolic link, do not resolve.\n                return;\n            }\n            const fileIsDir = stats.isDirectory();\n            if (fileIsDir && !file.endsWith('/')) {\n                file = `${file}/`;\n            }\n\n            if ((!fileIsDir || !entryPoint) && isExcluded(file.replace(/\\\\/g, '/'))) {\n                return;\n            }\n\n            if (fileIsDir) {\n                FS.readdirSync(file).forEach(next => {\n                    add(Path.join(file, next), false);\n                });\n            } else if (supportedFileRegex.test(file)) {\n                files.push(file);\n            }\n        }\n\n        inputFiles.forEach(file => {\n            add(Path.resolve(file), true);\n        });\n\n        return files;\n    }\n\n    /**\n     * Print the version number.\n     */\n    toString() {\n        return [\n            '',\n            `TypeDoc ${Application.VERSION}`,\n            `Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`,\n            ''\n        ].join(typescript.sys.newLine);\n    }\n}\n"]}
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/lib/application.ts"],"names":[],"mappings":";;;;;;;;;AAQA,6BAA6B;AAC7B,yBAAyB;AACzB,yCAAyC;AAEzC,6CAA8C;AAC9C,gDAA6C;AAC7C,mDAA6C;AAC7C,0CAAmD;AACnD,yCAAuG;AACvG,yCAAgD;AAEhD,iDAK2B;AAC3B,mCAA8C;AAkB9C,IAAa,WAAW,mBAAxB,MAAa,WAAY,SAAQ,8BAGhC;IAqDG;QACI,KAAK,CAAC,mCAAuB,CAAC,CAAC;QAE/B,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,IAAI,0BAAU,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAY,WAAW,EAAE,iBAAS,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,GAAI,IAAI,CAAC,YAAY,CAAW,UAAU,EAAE,mBAAQ,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAK,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,kBAAU,CAAC,CAAC;IAC9D,CAAC;IAOD,SAAS,CAAC,UAAwC,EAAE;QAChD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9C,IAAI;gBACA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAA2B,EAAE,GAAG,CAAC,CAAC;aAC3D;YAAC,WAAM;aAEP;SACJ;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,cAAM,EAAE,CAAC,CAAC;QAEhC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAc,CAAO,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;aAAM,IAAI,MAAM,KAAK,MAAM,EAAE;YAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,cAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9C,IAAI;gBACA,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAA2B,EAAE,GAAG,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACpC;SACJ;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,OAAO;YACH,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAClC,UAAU,EAAE,IAAI,CAAC,UAAU;SAC9B,CAAC;IACN,CAAC;IAKD,IAAI,WAAW;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAKM,iBAAiB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IACvD,CAAC;IAEM,oBAAoB;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAQM,OAAO,CAAC,GAAa;QACxB,IAAI,CAAC,MAAM,CAAC,OAAO,CACf,6BAA6B,EAC7B,IAAI,CAAC,oBAAoB,EAAE,EAC3B,IAAI,CAAC,iBAAiB,EAAE,CAC3B,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACvC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,IAAI,CAAC,oBAAoB,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC1B,OAAO,MAAM,CAAC,OAAO,CAAC;aACzB;iBAAM;gBACH,OAAO;aACV;SACJ;aAAM;YACH,OAAO,MAAM,CAAC,OAAO,CAAC;SACzB;IACL,CAAC;IAkBM,YAAY,CAAC,KAAmC,EAAE,GAAW;QAChE,MAAM,OAAO,GAAG,KAAK,YAAY,yBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;QAED,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;SACtF;aAAM;YACH,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;SAC7D;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAkBM,YAAY,CAAC,KAAmC,EAAE,GAAW;QAChE,MAAM,OAAO,GAAG,KAAK,YAAY,yBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,KAAK,CAAC;SAChB;QAED,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,SAAS,GAAG,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACzF,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3F,iBAAS,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAYM,gBAAgB,CAAC,aAAuB,EAAE;QAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAElE,SAAS,UAAU,CAAC,QAAgB;YAChC,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,iBAAiB,CAAC;QACxE,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAChG,SAAS,GAAG,CAAC,IAAY,EAAE,UAAmB;YAC1C,IAAI,KAAe,CAAC;YACpB,IAAI;gBACA,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aAC7B;YAAC,WAAM;gBAEJ,OAAO;aACV;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YACtC,IAAI,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAClC,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC;aACrB;YAED,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE;gBACrE,OAAO;aACV;YAED,IAAI,SAAS,EAAE;gBACX,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBAChC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;gBACtC,CAAC,CAAC,CAAC;aACN;iBAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACpB;iBAAM,IAAI,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC9C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACpB;QACL,CAAC;QAED,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACjB,CAAC;IAKD,QAAQ;QACJ,OAAO;YACH,EAAE;YACF,WAAW,aAAW,CAAC,OAAO,EAAE;YAChC,oBAAoB,IAAI,CAAC,oBAAoB,EAAE,SAAS,IAAI,CAAC,iBAAiB,EAAE,EAAE;YAClF,EAAE;SACL,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CACJ,CAAA;AA/OU,mBAAO,GAAG,eAAe,CAAC;AApBjC;IADC,kBAAU,CAAC,QAAQ,CAAC;+CACU;AAG/B;IADC,kBAAU,CAAC,sBAAsB,CAAC;yDACJ;AAG/B;IADC,kBAAU,CAAC,SAAS,CAAC;4CACE;AAGxB;IADC,kBAAU,CAAC,YAAY,CAAC;+CACH;AAGtB;IADC,kBAAU,CAAC,SAAS,CAAC;gDACD;AAGrB;IADC,kBAAU,CAAC,UAAU,CAAC;4CACN;AA5CR,WAAW;IADvB,qBAAS,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACtC,WAAW,CAgSvB;AAhSY,kCAAW","sourcesContent":["/**\n * The TypeDoc main module and namespace.\n *\n * The [[Application]] class holds the core logic of the cli application. All code related\n * to resolving reflections is stored in [[TypeDoc.Factories]], the actual data models can be found\n * in [[TypeDoc.Models]] and the final rendering is defined in [[TypeDoc.Output]].\n */\n\nimport * as Path from 'path';\nimport * as FS from 'fs';\nimport * as typescript from 'typescript';\n\nimport { Converter } from './converter/index';\nimport { Renderer } from './output/renderer';\nimport { Serializer } from './serialization';\nimport { ProjectReflection } from './models/index';\nimport { Logger, ConsoleLogger, CallbackLogger, PluginHost, writeFile, readFile } from './utils/index';\nimport { createMinimatch } from './utils/paths';\n\nimport {\n    AbstractComponent,\n    ChildableComponent,\n    Component,\n    DUMMY_APPLICATION_OWNER\n} from './utils/component';\nimport { Options, BindOption } from './utils';\nimport { TypeDocAndTSOptions, TypeDocOptions } from './utils/options/declaration';\n\n/**\n * The default TypeDoc main application class.\n *\n * This class holds the two main components of TypeDoc, the [[Dispatcher]] and\n * the [[Renderer]]. When running TypeDoc, first the [[Dispatcher]] is invoked which\n * generates a [[ProjectReflection]] from the passed in source files. The\n * [[ProjectReflection]] is a hierarchical model representation of the TypeScript\n * project. Afterwards the model is passed to the [[Renderer]] which uses an instance\n * of [[BaseTheme]] to generate the final documentation.\n *\n * Both the [[Dispatcher]] and the [[Renderer]] are subclasses of the [[EventDispatcher]]\n * and emit a series of events while processing the project. Subscribe to these Events\n * to control the application flow or alter the output.\n */\n@Component({ name: 'application', internal: true })\nexport class Application extends ChildableComponent<\n    Application,\n    AbstractComponent<Application>\n> {\n    /**\n     * The converter used to create the declaration reflections.\n     */\n    converter: Converter;\n\n    /**\n     * The renderer used to generate the documentation output.\n     */\n    renderer: Renderer;\n\n    /**\n     * The serializer used to generate JSON output.\n     */\n    serializer: Serializer;\n\n    /**\n     * The logger that should be used to output messages.\n     */\n    logger: Logger;\n\n    options: Options;\n\n    plugins: PluginHost;\n\n    @BindOption('logger')\n    loggerType!: string | Function;\n\n    @BindOption('ignoreCompilerErrors')\n    ignoreCompilerErrors!: boolean;\n\n    @BindOption('exclude')\n    exclude!: Array<string>;\n\n    @BindOption('inputFiles')\n    inputFiles!: string[];\n\n    @BindOption('options')\n    optionsFile!: string;\n\n    @BindOption('tsconfig')\n    project!: string;\n\n    /**\n     * The version number of TypeDoc.\n     */\n    static VERSION = '{{ VERSION }}';\n\n    /**\n     * Create a new TypeDoc application instance.\n     *\n     * @param options An object containing the options that should be used.\n     */\n    constructor() {\n        super(DUMMY_APPLICATION_OWNER);\n\n        this.logger = new ConsoleLogger();\n        this.options = new Options(this.logger);\n        this.options.addDefaultDeclarations();\n        this.serializer = new Serializer();\n        this.converter = this.addComponent<Converter>('converter', Converter);\n        this.renderer  = this.addComponent<Renderer>('renderer', Renderer);\n        this.plugins   = this.addComponent('plugins', PluginHost);\n    }\n\n    /**\n     * Initialize TypeDoc with the given options object.\n     *\n     * @param options  The desired options to set.\n     */\n    bootstrap(options: Partial<TypeDocAndTSOptions> = {}): { hasErrors: boolean, inputFiles: string[] } {\n        for (const [key, val] of Object.entries(options)) {\n            try {\n                this.options.setValue(key as keyof TypeDocOptions, val);\n            } catch {\n                // Ignore errors, plugins haven't been loaded yet and may declare an option.\n            }\n        }\n        this.options.read(new Logger());\n\n        const logger = this.loggerType;\n        if (typeof logger === 'function') {\n            this.logger = new CallbackLogger(<any> logger);\n            this.options.setLogger(this.logger);\n        } else if (logger === 'none') {\n            this.logger = new Logger();\n            this.options.setLogger(this.logger);\n        }\n\n        this.plugins.load();\n\n        this.options.reset();\n        for (const [key, val] of Object.entries(options)) {\n            try {\n                this.options.setValue(key as keyof TypeDocOptions, val);\n            } catch (error) {\n                this.logger.error(error.message);\n            }\n        }\n        this.options.read(this.logger);\n\n        return {\n            hasErrors: this.logger.hasErrors(),\n            inputFiles: this.inputFiles\n        };\n    }\n\n    /**\n     * Return the application / root component instance.\n     */\n    get application(): Application {\n        return this;\n    }\n\n    /**\n     * Return the path to the TypeScript compiler.\n     */\n    public getTypeScriptPath(): string {\n        return Path.dirname(require.resolve('typescript'));\n    }\n\n    public getTypeScriptVersion(): string {\n        const tsPath = this.getTypeScriptPath();\n        const json = JSON.parse(readFile(Path.join(tsPath, '..', 'package.json')));\n        return json.version;\n    }\n\n    /**\n     * Run the converter for the given set of files and return the generated reflections.\n     *\n     * @param src  A list of source that should be compiled and converted.\n     * @returns An instance of ProjectReflection on success, undefined otherwise.\n     */\n    public convert(src: string[]): ProjectReflection | undefined {\n        this.logger.writeln(\n            'Using TypeScript %s from %s',\n            this.getTypeScriptVersion(),\n            this.getTypeScriptPath()\n        );\n\n        const result = this.converter.convert(src);\n        if (result.errors && result.errors.length) {\n            this.logger.diagnostics(result.errors);\n            if (this.ignoreCompilerErrors) {\n                this.logger.resetErrors();\n                return result.project;\n            } else {\n                return;\n            }\n        } else {\n            return result.project;\n        }\n    }\n\n    /**\n     * @param src  A list of source files whose documentation should be generated.\n     */\n    public generateDocs(src: string[], out: string): boolean;\n\n    /**\n     * @param project  The project the documentation should be generated for.\n     */\n    public generateDocs(project: ProjectReflection, out: string): boolean;\n\n    /**\n     * Run the documentation generator for the given set of files.\n     *\n     * @param out  The path the documentation should be written to.\n     * @returns TRUE if the documentation could be generated successfully, otherwise FALSE.\n     */\n    public generateDocs(input: ProjectReflection | string[], out: string): boolean {\n        const project = input instanceof ProjectReflection ? input : this.convert(input);\n        if (!project) {\n            return false;\n        }\n\n        out = Path.resolve(out);\n        this.renderer.render(project, out);\n        if (this.logger.hasErrors()) {\n            this.logger.error('Documentation could not be generated due to the errors above.');\n        } else {\n            this.logger.success('Documentation generated at %s', out);\n        }\n\n        return true;\n    }\n\n    /**\n     * @param src  A list of source that should be compiled and converted.\n     */\n    public generateJson(src: string[], out: string): boolean;\n\n    /**\n     * @param project  The project that should be converted.\n     */\n    public generateJson(project: ProjectReflection, out: string): boolean;\n\n    /**\n     * Run the converter for the given set of files and write the reflections to a json file.\n     *\n     * @param out  The path and file name of the target file.\n     * @returns TRUE if the json file could be written successfully, otherwise FALSE.\n     */\n    public generateJson(input: ProjectReflection | string[], out: string): boolean {\n        const project = input instanceof ProjectReflection ? input : this.convert(input);\n        if (!project) {\n            return false;\n        }\n\n        out = Path.resolve(out);\n        const eventData = { outputDirectory: Path.dirname(out), outputFile: Path.basename(out) };\n        const ser = this.serializer.projectToObject(project, { begin: eventData, end: eventData });\n        writeFile(out, JSON.stringify(ser, null, '\\t'), false);\n        this.logger.success('JSON written to %s', out);\n\n        return true;\n    }\n\n    /**\n     * Expand a list of input files.\n     *\n     * Searches for directories in the input files list and replaces them with a\n     * listing of all TypeScript files within them. One may use the ```--exclude``` option\n     * to filter out files with a pattern.\n     *\n     * @param inputFiles  The list of files that should be expanded.\n     * @returns  The list of input files with expanded directories.\n     */\n    public expandInputFiles(inputFiles: string[] = []): string[] {\n        const files: string[] = [];\n\n        const exclude = this.exclude ? createMinimatch(this.exclude) : [];\n\n        function isExcluded(fileName: string): boolean {\n            return exclude.some(mm => mm.match(fileName));\n        }\n\n        const includeJson = this.options.getCompilerOptions().resolveJsonModule;\n        const supportedFileRegex = this.options.getCompilerOptions().allowJs ? /\\.[tj]sx?$/ : /\\.tsx?$/;\n        function add(file: string, entryPoint: boolean) {\n            let stats: FS.Stats;\n            try {\n                stats = FS.statSync(file);\n            } catch {\n                // No permission or a symbolic link, do not resolve.\n                return;\n            }\n            const fileIsDir = stats.isDirectory();\n            if (fileIsDir && !file.endsWith('/')) {\n                file = `${file}/`;\n            }\n\n            if ((!fileIsDir || !entryPoint) && isExcluded(file.replace(/\\\\/g, '/'))) {\n                return;\n            }\n\n            if (fileIsDir) {\n                FS.readdirSync(file).forEach(next => {\n                    add(Path.join(file, next), false);\n                });\n            } else if (supportedFileRegex.test(file)) {\n                files.push(file);\n            } else if (includeJson && file.endsWith('.json')) {\n                files.push(file);\n            }\n        }\n\n        inputFiles.forEach(file => {\n            add(Path.resolve(file), true);\n        });\n\n        return files;\n    }\n\n    /**\n     * Print the version number.\n     */\n    toString() {\n        return [\n            '',\n            `TypeDoc ${Application.VERSION}`,\n            `Using TypeScript ${this.getTypeScriptVersion()} from ${this.getTypeScriptPath()}`,\n            ''\n        ].join(typescript.sys.newLine);\n    }\n}\n"]}

package/dist/lib/converter/converter.js

@@ -82,7 +82,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         this.typeNodeConverters = [];
     }
     convert(fileNames) {
-        const normalizedFiles = fileNames.map(fs_1.normalizePath);
+        const normalizedFiles = fileNames.map(fs_1.normalizePath).filter(path => !path.endsWith('.json'));
         const program = ts.createProgram(normalizedFiles, this.application.options.getCompilerOptions());
         const checker = program.getTypeChecker();
         const context = new context_1.Context(this, normalizedFiles, checker, program);

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;AAI5B,uCAAoC;AACpC,6CAAwI;AACxI,kDAAmF;AACnF,oCAAsC;AACtC,oCAA4C;AAC5C,0CAAiD;AAqBjD,IAAa,SAAS,iBAAtB,MAAa,SAAU,SAAQ,8BAAmD;IA0I9E,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,MAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACjD,IAAI,QAAQ,CAAC,MAAM,EAAE;YACjB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;gBACnB,oDAAoD;gBACpD,6HAA6H;gBAC7H,yGAAyG;gBACzG,GAAG,QAAQ;aACd,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACjB;QAED,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;QAChC,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;QACxF,MAAM,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE;aAC/C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAEvC,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACpE,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,OAAO,MAAM,CAAC;SACjB;QAED,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACvC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,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;IAEO,iBAAiB,CAAC,OAAmB,EAAE,mBAA6C;QACxF,IAAI,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;YACvC,OAAO,EAAE,CAAC;SACb;QAED,MAAM,eAAe,GAAG,CAAC,EAAE,IAAI,EAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjG,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;IAOD,aAAa;QACT,OAAO,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACnF,CAAC;CACJ,CAAA;AAnWU,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;AA7HxC;IADC,kBAAU,CAAC,MAAM,CAAC;uCACL;AAGd;IADC,kBAAU,CAAC,iBAAiB,CAAC;kDACE;AAGhC;IADC,kBAAU,CAAC,qBAAqB,CAAC;sDACJ;AAG9B;IADC,kBAAU,CAAC,kBAAkB,CAAC;mDACJ;AAG3B;IADC,kBAAU,CAAC,oBAAoB,CAAC;qDACJ;AAG7B;IADC,kBAAU,CAAC,sBAAsB,CAAC;uDACJ;AAG/B;IADC,kBAAU,CAAC,gBAAgB,CAAC;iDACJ;AAGzB;IADC,kBAAU,CAAC,kBAAkB,CAAC;mDACJ;AA1BlB,SAAS;IADrB,qBAAS,CAAC,EAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,+BAAkB,EAAC,CAAC;GAClE,SAAS,CAuZrB;AAvZY,8BAAS","sourcesContent":["import * as ts from 'typescript';\nimport * as _ts from '../ts-internal';\nimport * as _ from 'lodash';\n\nimport { Application } from '../application';\nimport { Reflection, Type, ProjectReflection } from '../models/index';\nimport { Context } from './context';\nimport { ConverterComponent, ConverterNodeComponent, ConverterTypeComponent, TypeTypeConverter, TypeNodeConverter } from './components';\nimport { Component, ChildableComponent, ComponentClass } from '../utils/component';\nimport { BindOption } from '../utils';\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    @BindOption('name')\n    name!: string;\n\n    @BindOption('externalPattern')\n    externalPattern!: Array<string>;\n\n    @BindOption('includeDeclarations')\n    includeDeclarations!: boolean;\n\n    @BindOption('excludeExternals')\n    excludeExternals!: boolean;\n\n    @BindOption('excludeNotExported')\n    excludeNotExported!: boolean;\n\n    @BindOption('excludeNotDocumented')\n    excludeNotDocumented!: boolean;\n\n    @BindOption('excludePrivate')\n    excludePrivate!: boolean;\n\n    @BindOption('excludeProtected')\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        const dangling = project.getDanglingReferences();\n        if (dangling.length) {\n            this.owner.logger.warn([\n                'Some names refer to reflections that do not exist.',\n                'This can be caused by exporting a reflection only under a different name than it is declared when excludeNotExported is set',\n                'or by a plugin removing reflections without removing references. The names that cannot be resolved are:',\n                ...dangling\n            ].join('\\n'));\n        }\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        const exclude = createMinimatch(this.application.exclude || []);\n        const isExcluded = (file: ts.SourceFile) => exclude.some(mm => mm.match(file.fileName));\n        const includedSourceFiles = program.getSourceFiles()\n            .filter(file => !isExcluded(file));\n\n        const errors = this.getCompilerErrors(program, includedSourceFiles);\n        if (errors.length) {\n            return errors;\n        }\n\n        includedSourceFiles.forEach((sourceFile) => {\n            this.convertNode(context, sourceFile);\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    private getCompilerErrors(program: ts.Program, includedSourceFiles: readonly ts.SourceFile[]): ReadonlyArray<ts.Diagnostic> {\n        if (this.application.ignoreCompilerErrors) {\n            return [];\n        }\n\n        const isRelevantError = ({ file }: ts.Diagnostic) => !file || includedSourceFiles.includes(file);\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     * 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;AAI5B,uCAAoC;AACpC,6CAAwI;AACxI,kDAAmF;AACnF,oCAAsC;AACtC,oCAA4C;AAC5C,0CAAiD;AAqBjD,IAAa,SAAS,iBAAtB,MAAa,SAAU,SAAQ,8BAAmD;IA0I9E,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;QAGvB,MAAM,eAAe,GAAG,SAAS,CAAC,GAAG,CAAC,kBAAa,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7F,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,MAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACjD,IAAI,QAAQ,CAAC,MAAM,EAAE;YACjB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;gBACnB,oDAAoD;gBACpD,6HAA6H;gBAC7H,yGAAyG;gBACzG,GAAG,QAAQ;aACd,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACjB;QAED,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;QAChC,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;QACxF,MAAM,mBAAmB,GAAG,OAAO,CAAC,cAAc,EAAE;aAC/C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAEvC,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACpE,IAAI,MAAM,CAAC,MAAM,EAAE;YACf,OAAO,MAAM,CAAC;SACjB;QAED,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACvC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,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;IAEO,iBAAiB,CAAC,OAAmB,EAAE,mBAA6C;QACxF,IAAI,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;YACvC,OAAO,EAAE,CAAC;SACb;QAED,MAAM,eAAe,GAAG,CAAC,EAAE,IAAI,EAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEjG,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;IAOD,aAAa;QACT,OAAO,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACnF,CAAC;CACJ,CAAA;AArWU,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;AA7HxC;IADC,kBAAU,CAAC,MAAM,CAAC;uCACL;AAGd;IADC,kBAAU,CAAC,iBAAiB,CAAC;kDACE;AAGhC;IADC,kBAAU,CAAC,qBAAqB,CAAC;sDACJ;AAG9B;IADC,kBAAU,CAAC,kBAAkB,CAAC;mDACJ;AAG3B;IADC,kBAAU,CAAC,oBAAoB,CAAC;qDACJ;AAG7B;IADC,kBAAU,CAAC,sBAAsB,CAAC;uDACJ;AAG/B;IADC,kBAAU,CAAC,gBAAgB,CAAC;iDACJ;AAGzB;IADC,kBAAU,CAAC,kBAAkB,CAAC;mDACJ;AA1BlB,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 { Reflection, Type, ProjectReflection } from '../models/index';\nimport { Context } from './context';\nimport { ConverterComponent, ConverterNodeComponent, ConverterTypeComponent, TypeTypeConverter, TypeNodeConverter } from './components';\nimport { Component, ChildableComponent, ComponentClass } from '../utils/component';\nimport { BindOption } from '../utils';\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    @BindOption('name')\n    name!: string;\n\n    @BindOption('externalPattern')\n    externalPattern!: Array<string>;\n\n    @BindOption('includeDeclarations')\n    includeDeclarations!: boolean;\n\n    @BindOption('excludeExternals')\n    excludeExternals!: boolean;\n\n    @BindOption('excludeNotExported')\n    excludeNotExported!: boolean;\n\n    @BindOption('excludeNotDocumented')\n    excludeNotDocumented!: boolean;\n\n    @BindOption('excludePrivate')\n    excludePrivate!: boolean;\n\n    @BindOption('excludeProtected')\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        // JSON files should never result in extra members in the documentation, but need to be included so that TS\n        // can find them.\n        const normalizedFiles = fileNames.map(normalizePath).filter(path => !path.endsWith('.json'));\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        const dangling = project.getDanglingReferences();\n        if (dangling.length) {\n            this.owner.logger.warn([\n                'Some names refer to reflections that do not exist.',\n                'This can be caused by exporting a reflection only under a different name than it is declared when excludeNotExported is set',\n                'or by a plugin removing reflections without removing references. The names that cannot be resolved are:',\n                ...dangling\n            ].join('\\n'));\n        }\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        const exclude = createMinimatch(this.application.exclude || []);\n        const isExcluded = (file: ts.SourceFile) => exclude.some(mm => mm.match(file.fileName));\n        const includedSourceFiles = program.getSourceFiles()\n            .filter(file => !isExcluded(file));\n\n        const errors = this.getCompilerErrors(program, includedSourceFiles);\n        if (errors.length) {\n            return errors;\n        }\n\n        includedSourceFiles.forEach((sourceFile) => {\n            this.convertNode(context, sourceFile);\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    private getCompilerErrors(program: ts.Program, includedSourceFiles: readonly ts.SourceFile[]): ReadonlyArray<ts.Diagnostic> {\n        if (this.application.ignoreCompilerErrors) {\n            return [];\n        }\n\n        const isRelevantError = ({ file }: ts.Diagnostic) => !file || includedSourceFiles.includes(file);\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     * 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/declaration.js

@@ -16,6 +16,26 @@ const nonStaticMergeKinds = [
     ts.SyntaxKind.InterfaceDeclaration
 ];
 const builtInSymbolRegExp = /^__@(\w+)$/;
+function hasCommentOnParentAxis(node) {
+    let currentNode = node;
+    while (currentNode) {
+        if (Boolean(comment_js_1.getRawComment(currentNode))) {
+            return true;
+        }
+        currentNode = currentNode.parent;
+    }
+    return false;
+}
+function shouldBeIgnoredAsNotDocumented(node, kind) {
+    if (kind === index_1.ReflectionKind.Module || kind === index_1.ReflectionKind.Global || kind === index_1.ReflectionKind.EnumMember) {
+        return false;
+    }
+    if (kind === index_1.ReflectionKind.Variable && hasCommentOnParentAxis(node)) {
+        return false;
+    }
+    const hasComment = Boolean(comment_js_1.getRawComment(node));
+    return !hasComment;
+}
 function createDeclaration(context, node, kind, name) {
     var _a, _b;
     if (!(context.scope instanceof index_1.ContainerReflection)) {
@@ -48,11 +68,9 @@ function createDeclaration(context, node, kind, name) {
         }
     }
     const modifiers = ts.getCombinedModifierFlags(node);
-    let hasComment = Boolean(comment_js_1.getRawComment(node));
     let isExported;
     if (kind === index_1.ReflectionKind.Module || kind === index_1.ReflectionKind.Global) {
         isExported = true;
-        hasComment = true;
     }
     else if (container.kind === index_1.ReflectionKind.Global) {
         isExported = true;
@@ -81,7 +99,7 @@ function createDeclaration(context, node, kind, name) {
     }
     if ((!isExported && context.converter.excludeNotExported)
         ||
-            (context.converter.excludeNotDocumented && kind !== index_1.ReflectionKind.EnumMember && !hasComment)) {
+            (context.converter.excludeNotDocumented && shouldBeIgnoredAsNotDocumented(node, kind))) {
         return;
     }
     const isPrivate = !!(modifiers & ts.ModifierFlags.Private);

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

@@ -1 +1 @@
-{"version":3,"file":"declaration.js","sourceRoot":"","sources":["../../../../src/lib/converter/factories/declaration.ts"],"names":[],"mappings":";;AAAA,iCAAiC;AAEjC,8CAAgH;AAEhH,4CAAyC;AACzC,6CAA6C;AAC7C,2CAAkD;AAKlD,MAAM,cAAc,GAAG;IACnB,sBAAc,CAAC,KAAK;IACpB,sBAAc,CAAC,SAAS;IACxB,sBAAc,CAAC,SAAS;CAC3B,CAAC;AAKF,MAAM,mBAAmB,GAAG;IACxB,EAAE,CAAC,UAAU,CAAC,gBAAgB;IAC9B,EAAE,CAAC,UAAU,CAAC,eAAe;IAC7B,EAAE,CAAC,UAAU,CAAC,oBAAoB;CACrC,CAAC;AAEF,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAYzC,SAAgB,iBAAiB,CAAC,OAAgB,EAAE,IAAoB,EAAE,IAAoB,EAAE,IAAa;;IACzG,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,YAAY,2BAAmB,CAAC,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;KACrD;IACD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC;IAGhC,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;SAChC;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE;YACpB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;SAC3B;aAAM;YACH,OAAO;SACV;QAGD,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE;YACP,IAAI,GAAG,WAAW,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;SACjC;aAAM,IAAI,IAAI,GAAG,CAAC,sBAAc,CAAC,WAAW,GAAG,sBAAc,CAAC,kBAAkB,CAAC,IAAI,IAAI,KAAK,YAAY,EAAE;YAEzG,MAAM,QAAQ,GAAG,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YACzE,IAAI,MAAM,EAAE;gBACR,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAA2B,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;aACjH;iBAAM,IAAI,QAAQ,EAAE;gBACjB,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;aAC7B;SACJ;KACJ;IAED,MAAM,SAAS,GAAG,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,UAAU,GAAY,OAAO,CAAC,0BAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvD,IAAI,UAAmB,CAAC;IACxB,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,EAAE;QAClE,UAAU,GAAG,IAAI,CAAC;QAClB,UAAU,GAAG,IAAI,CAAC;KACrB;SAAM,IAAI,SAAS,CAAC,IAAI,KAAK,sBAAc,CAAC,MAAM,EAAE;QAEjD,UAAU,GAAG,IAAI,CAAC;KACrB;SAAM,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,sBAAc,CAAC,SAAS,EAAE,sBAAc,CAAC,MAAM,CAAC,CAAC,EAAE;QAC5E,MAAM,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,EAAE;YACT,UAAU,GAAG,KAAK,CAAC;SACtB;aAAM;YACH,IAAI,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7B,OAAO,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBAC3F,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC;aAClC;YACD,MAAM,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC7D,IAAI,CAAC,YAAY,EAAE;gBAGf,UAAU,GAAG,IAAI,CAAC;aACrB;iBAAM;gBACH,UAAU,GAAG,CAAC,QAAC,YAAY,CAAC,OAAO,0CAAE,GAAG,CAAC,MAAM,CAAC,WAAW,EAAC,CAAC;aAChE;SACJ;KACJ;SAAM;QACH,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;KAC3C;IAED,IACI,CAAC,CAAC,UAAU,IAAI,OAAO,CAAC,SAAS,CAAC,kBAAkB,CAAC;;YAErD,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,IAAI,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,EAC/F;QACE,OAAO;KACV;IAGD,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3D,IAAI,OAAO,CAAC,SAAS,IAAI,SAAS,EAAE;QAChC,OAAO;KACV;IAGD,IAAI,qBAAqB,GAAG,KAAK,CAAC;IAClC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAChC,QAAQ,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,SAAS,CAAC,IAAI,KAAK,sBAAc,CAAC,KAAK,EAAE;YACzC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE;gBAC/D,qBAAqB,GAAG,IAAI,CAAC;aAChC;iBAAM,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACxE,QAAQ,GAAG,IAAI,CAAC;aACnB;SACJ;KACJ;IAGD,IAAI,KAAwC,CAAC;IAC7C,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC/D,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAwB,EAAE,EAAE;QAC1C,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,yBAAyB,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;YAC7F,KAAK,GAAG,CAAC,CAAC;SACb;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,KAAK,EAAE;QAER,KAAK,GAAG,IAAI,6BAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QACzD,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC/C,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjD,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;QACzE,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,UAAU,CAAC,CAAC;QACpD,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAE/C,IAAI,KAAK,EAAE;YACP,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,kBAAkB,CAAC,KAAK,QAAE,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,mCAAI,IAAI,CAAC,MAAM,CAAC,CAAC;SACvF;KACJ;SAAM;QAEH,KAAK,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;KACzD;IAGD,IAAI,KAAK,EAAE;QACP,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,wBAAwB,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KACpE;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AA9HD,8CA8HC;AAUD,SAAS,gBAAgB,CAAC,OAAgB,EAAE,UAAiC,EAAE,IAAoB;IAC/F,MAAM,SAAS,GAAG,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEpD,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IACzF,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,EAAK,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACtF,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACxE,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExF,IACI,OAAO,CAAC,SAAS;QACjB,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,aAAa,IAAI,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACnF;QACE,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;YAC3B,UAAU,CAAC,aAAa,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3E,UAAU,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChD,SAAS,CAAC,aAAa,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;SACN;KACJ;IAED,OAAO,UAAU,CAAC;AACtB,CAAC;AAID,SAAS,yBAAyB,CAAC,KAAqB,EAAE,KAAqB;IAC3E,IACI,CAAC,KAAK,GAAG,sBAAc,CAAC,QAAQ,IAAI,KAAK,GAAG,sBAAc,CAAC,SAAS,CAAC;;YAErE,CAAC,KAAK,GAAG,sBAAc,CAAC,QAAQ,IAAI,KAAK,GAAG,sBAAc,CAAC,SAAS,CAAC,EACvE;QACE,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAWD,SAAS,iBAAiB,CAAC,OAAgB,EAAE,UAAiC,EAAE,IAAa,EAAE,IAAoB;IAC/G,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,EAAE;QAC1B,MAAM,OAAO,GAAG,CAAC,sBAAc,CAAC,SAAS,EAAE,sBAAc,CAAC,IAAI,EAAE,sBAAc,CAAC,KAAK,CAAC,CAAC;QACtF,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,UAAU,GAAG,eAAe,EAAE;YAC9B,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;SAC1B;KACJ;IAED,IACI,OAAO,CAAC,SAAS;QACjB,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;QACnD,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,aAAa,IAAI,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACnF;QACE,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;YACxB,UAAU,CAAC,UAAU,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACxE,UAAU,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChD,SAAS,CAAC,UAAU,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3E,CAAC,CAAC,CAAC;SACN;QACD,OAAO;KACV;IAED,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["import * as ts from 'typescript';\n\nimport { ContainerReflection, DeclarationReflection, ReflectionFlag, ReflectionKind } from '../../models/index';\nimport { Context } from '../context';\nimport { Converter } from '../converter';\nimport { getRawComment } from './comment.js';\nimport { createReferenceType } from './reference';\n\n/**\n * List of reflection kinds that never should be static.\n */\nconst nonStaticKinds = [\n    ReflectionKind.Class,\n    ReflectionKind.Interface,\n    ReflectionKind.Namespace\n];\n\n/**\n * List of ts kinds leading to none static merge.\n */\nconst nonStaticMergeKinds = [\n    ts.SyntaxKind.ClassDeclaration,\n    ts.SyntaxKind.ClassExpression,\n    ts.SyntaxKind.InterfaceDeclaration\n];\n\nconst builtInSymbolRegExp = /^__@(\\w+)$/;\n\n/**\n * Create a declaration reflection from the given TypeScript node.\n *\n * @param context  The context object describing the current state the converter is in. The\n *   scope of the context will be the parent of the generated reflection.\n * @param node  The TypeScript node that should be converted to a reflection.\n * @param kind  The desired kind of the reflection.\n * @param name  The desired name of the reflection.\n * @returns The resulting reflection or undefined if an error is encountered.\n */\nexport function createDeclaration(context: Context, node: ts.Declaration, kind: ReflectionKind, name?: string): DeclarationReflection | undefined {\n    if (!(context.scope instanceof ContainerReflection)) {\n        throw new Error('Expected container reflection.');\n    }\n    const container = context.scope;\n\n    // Ensure we have a name for the reflection\n    if (!name) {\n        if (node.localSymbol) {\n            name = node.localSymbol.name;\n        } else if (node.symbol) {\n            name = node.symbol.name;\n        } else {\n            return;\n        }\n\n        // rename built-in symbols\n        const match = builtInSymbolRegExp.exec(name);\n        if (match) {\n            name = `[Symbol.${match[1]}]`;\n        } else if (kind & (ReflectionKind.ClassMember | ReflectionKind.VariableOrProperty) && name === '__computed') {\n            // rename computed properties\n            const declName = ts.getNameOfDeclaration(node);\n            const symbol = declName && context.checker.getSymbolAtLocation(declName);\n            if (symbol) {\n                name = context.checker.symbolToString(symbol, /*enclosingDeclaration*/ undefined, ts.SymbolFlags.ClassMember);\n            } else if (declName) {\n                name = declName.getText();\n            }\n        }\n    }\n\n    const modifiers = ts.getCombinedModifierFlags(node);\n\n    let hasComment: boolean = Boolean(getRawComment(node));\n    // Test whether the node is exported\n    let isExported: boolean;\n    if (kind === ReflectionKind.Module || kind === ReflectionKind.Global) {\n        isExported = true;\n        hasComment = true;\n    } else if (container.kind === ReflectionKind.Global) {\n        // In file mode, everything is exported.\n        isExported = true;\n    } else if (container.kindOf([ReflectionKind.Namespace, ReflectionKind.Module])) {\n        const symbol = context.getSymbolAtLocation(node);\n        if (!symbol) {\n            isExported = false;\n        } else {\n            let parentNode = node.parent;\n            while (![ts.SyntaxKind.SourceFile, ts.SyntaxKind.ModuleDeclaration].includes(parentNode.kind)) {\n                parentNode = parentNode.parent;\n            }\n            const parentSymbol = context.getSymbolAtLocation(parentNode);\n            if (!parentSymbol) {\n                // This is a file with no imports/exports, so everything is\n                // global and therefore exported.\n                isExported = true;\n            } else {\n                isExported = !!parentSymbol.exports?.get(symbol.escapedName);\n            }\n        }\n    } else {\n        isExported = container.flags.isExported;\n    }\n\n    if (\n        (!isExported && context.converter.excludeNotExported)\n        ||\n        (context.converter.excludeNotDocumented && kind !== ReflectionKind.EnumMember && !hasComment)\n    ) {\n        return;\n    }\n\n    // Test whether the node is private, when inheriting ignore private members\n    const isPrivate = !!(modifiers & ts.ModifierFlags.Private);\n    if (context.isInherit && isPrivate) {\n        return;\n    }\n\n    // Test whether the node is static, when merging a module to a class make the node static\n    let isConstructorProperty = false;\n    let isStatic = false;\n    if (!nonStaticKinds.includes(kind)) {\n        isStatic = !!(modifiers & ts.ModifierFlags.Static);\n        if (container.kind === ReflectionKind.Class) {\n            if (node.parent && node.parent.kind === ts.SyntaxKind.Constructor) {\n                isConstructorProperty = true;\n            } else if (!node.parent || !nonStaticMergeKinds.includes(node.parent.kind)) {\n                isStatic = true;\n            }\n        }\n    }\n\n    // Check if we already have a child of the same kind, with the same name and static flag\n    let child: DeclarationReflection | undefined;\n    const children = container.children = container.children || [];\n    children.forEach((n: DeclarationReflection) => {\n        if (n.name === name && n.flags.isStatic === isStatic && canMergeReflectionsByKind(n.kind, kind)) {\n            child = n;\n        }\n    });\n\n    if (!child) {\n        // Child does not exist, create a new reflection\n        child = new DeclarationReflection(name, kind, container);\n        child.setFlag(ReflectionFlag.Static, isStatic);\n        child.setFlag(ReflectionFlag.Private, isPrivate);\n        child.setFlag(ReflectionFlag.ConstructorProperty, isConstructorProperty);\n        child.setFlag(ReflectionFlag.Exported,  isExported);\n        child = setupDeclaration(context, child, node);\n\n        if (child) {\n            children.push(child);\n            context.registerReflection(child, context.getSymbolAtLocation(node) ?? node.symbol);\n        }\n    } else {\n        // Merge the existent reflection with the given node\n        child = mergeDeclarations(context, child, node, kind);\n    }\n\n    // If we have a reflection, trigger the corresponding event\n    if (child) {\n        context.trigger(Converter.EVENT_CREATE_DECLARATION, child, node);\n    }\n\n    return child;\n}\n\n/**\n * Setup a newly created declaration reflection.\n *\n * @param context  The context object describing the current state the converter is in.\n * @param reflection  The newly created blank reflection.\n * @param node  The TypeScript node whose properties should be applies to the given reflection.\n * @returns The reflection populated with the values of the given node.\n */\nfunction setupDeclaration(context: Context, reflection: DeclarationReflection, node: ts.Declaration) {\n    const modifiers = ts.getCombinedModifierFlags(node);\n\n    reflection.setFlag(ReflectionFlag.External,  context.isExternal);\n    reflection.setFlag(ReflectionFlag.Protected, !!(modifiers & ts.ModifierFlags.Protected));\n    reflection.setFlag(ReflectionFlag.Public,    !!(modifiers & ts.ModifierFlags.Public));\n    reflection.setFlag(ReflectionFlag.Optional,  !!(node['questionToken']));\n    reflection.setFlag(ReflectionFlag.Readonly,  !!(modifiers & ts.ModifierFlags.Readonly));\n\n    if (\n        context.isInherit &&\n        (node.parent === context.inheritParent || reflection.flags.isConstructorProperty)\n    ) {\n        if (!reflection.inheritedFrom) {\n            reflection.inheritedFrom = createReferenceType(context, node.symbol, true);\n            reflection.getAllSignatures().forEach((signature) => {\n                signature.inheritedFrom = createReferenceType(context, node.symbol, true);\n            });\n        }\n    }\n\n    return reflection;\n}\n\n// we should not be merging type and value with the same name,\n// because TypeScript has different namespaces for these two categories\nfunction canMergeReflectionsByKind(kind1: ReflectionKind, kind2: ReflectionKind): boolean {\n    if (\n        (kind1 & ReflectionKind.SomeType && kind2 & ReflectionKind.SomeValue)\n        ||\n        (kind2 & ReflectionKind.SomeType && kind1 & ReflectionKind.SomeValue)\n    ) {\n        return false;\n    }\n\n    return true;\n}\n\n/**\n * Merge the properties of the given TypeScript node with the pre existent reflection.\n *\n * @param context  The context object describing the current state the converter is in.\n * @param reflection  The pre existent reflection.\n * @param node  The TypeScript node whose properties should be merged with the given reflection.\n * @param kind  The desired kind of the reflection.\n * @returns The reflection merged with the values of the given node or NULL if the merge is invalid.\n */\nfunction mergeDeclarations(context: Context, reflection: DeclarationReflection, node: ts.Node, kind: ReflectionKind) {\n    if (reflection.kind !== kind) {\n        const weights = [ReflectionKind.Namespace, ReflectionKind.Enum, ReflectionKind.Class];\n        const kindWeight = weights.indexOf(kind);\n        const childKindWeight = weights.indexOf(reflection.kind);\n        if (kindWeight > childKindWeight) {\n            reflection.kind = kind;\n        }\n    }\n\n    if (\n        context.isInherit &&\n        (context.inherited || []).includes(reflection.name) &&\n        (node.parent === context.inheritParent || reflection.flags.isConstructorProperty)\n    ) {\n        if (!reflection.overwrites) {\n            reflection.overwrites = createReferenceType(context, node.symbol, true);\n            reflection.getAllSignatures().forEach((signature) => {\n                signature.overwrites = createReferenceType(context, node.symbol, true);\n            });\n        }\n        return;\n    }\n\n    return reflection;\n}\n"]}
+{"version":3,"file":"declaration.js","sourceRoot":"","sources":["../../../../src/lib/converter/factories/declaration.ts"],"names":[],"mappings":";;AAAA,iCAAiC;AAEjC,8CAAgH;AAEhH,4CAAyC;AACzC,6CAA6C;AAC7C,2CAAkD;AAKlD,MAAM,cAAc,GAAG;IACnB,sBAAc,CAAC,KAAK;IACpB,sBAAc,CAAC,SAAS;IACxB,sBAAc,CAAC,SAAS;CAC3B,CAAC;AAKF,MAAM,mBAAmB,GAAG;IACxB,EAAE,CAAC,UAAU,CAAC,gBAAgB;IAC9B,EAAE,CAAC,UAAU,CAAC,eAAe;IAC7B,EAAE,CAAC,UAAU,CAAC,oBAAoB;CACrC,CAAC;AAEF,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC,SAAS,sBAAsB,CAAE,IAAa;IAC1C,IAAI,WAAW,GAAY,IAAI,CAAC;IAEhC,OAAO,WAAW,EAAE;QAChB,IAAI,OAAO,CAAC,0BAAa,CAAC,WAAW,CAAC,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;SAAE;QAEzD,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC;KACpC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,8BAA8B,CAAE,IAAoB,EAAE,IAAoB;IAE/E,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,IAAI,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE;QACxG,OAAO,KAAK,CAAC;KAChB;IAiBD,IAAI,IAAI,KAAK,sBAAc,CAAC,QAAQ,IAAI,sBAAsB,CAAC,IAAI,CAAC,EAAE;QAClE,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,UAAU,GAAY,OAAO,CAAC,0BAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAEzD,OAAO,CAAC,UAAU,CAAC;AACvB,CAAC;AAYD,SAAgB,iBAAiB,CAAC,OAAgB,EAAE,IAAoB,EAAE,IAAoB,EAAE,IAAa;;IACzG,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,YAAY,2BAAmB,CAAC,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;KACrD;IACD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC;IAGhC,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;SAChC;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE;YACpB,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;SAC3B;aAAM;YACH,OAAO;SACV;QAGD,MAAM,KAAK,GAAG,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK,EAAE;YACP,IAAI,GAAG,WAAW,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;SACjC;aAAM,IAAI,IAAI,GAAG,CAAC,sBAAc,CAAC,WAAW,GAAG,sBAAc,CAAC,kBAAkB,CAAC,IAAI,IAAI,KAAK,YAAY,EAAE;YAEzG,MAAM,QAAQ,GAAG,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YACzE,IAAI,MAAM,EAAE;gBACR,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAA2B,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;aACjH;iBAAM,IAAI,QAAQ,EAAE;gBACjB,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;aAC7B;SACJ;KACJ;IAED,MAAM,SAAS,GAAG,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAGpD,IAAI,UAAmB,CAAC;IACxB,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,IAAI,IAAI,KAAK,sBAAc,CAAC,MAAM,EAAE;QAClE,UAAU,GAAG,IAAI,CAAC;KACrB;SAAM,IAAI,SAAS,CAAC,IAAI,KAAK,sBAAc,CAAC,MAAM,EAAE;QAEjD,UAAU,GAAG,IAAI,CAAC;KACrB;SAAM,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,sBAAc,CAAC,SAAS,EAAE,sBAAc,CAAC,MAAM,CAAC,CAAC,EAAE;QAC5E,MAAM,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,EAAE;YACT,UAAU,GAAG,KAAK,CAAC;SACtB;aAAM;YACH,IAAI,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;YAC7B,OAAO,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBAC3F,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC;aAClC;YACD,MAAM,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAC7D,IAAI,CAAC,YAAY,EAAE;gBAGf,UAAU,GAAG,IAAI,CAAC;aACrB;iBAAM;gBACH,UAAU,GAAG,CAAC,QAAC,YAAY,CAAC,OAAO,0CAAE,GAAG,CAAC,MAAM,CAAC,WAAW,EAAC,CAAC;aAChE;SACJ;KACJ;SAAM;QACH,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;KAC3C;IAED,IACI,CAAC,CAAC,UAAU,IAAI,OAAO,CAAC,SAAS,CAAC,kBAAkB,CAAC;;YAErD,CAAC,OAAO,CAAC,SAAS,CAAC,oBAAoB,IAAI,8BAA8B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EACxF;QACE,OAAO;KACV;IAGD,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC3D,IAAI,OAAO,CAAC,SAAS,IAAI,SAAS,EAAE;QAChC,OAAO;KACV;IAGD,IAAI,qBAAqB,GAAG,KAAK,CAAC;IAClC,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAChC,QAAQ,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,SAAS,CAAC,IAAI,KAAK,sBAAc,CAAC,KAAK,EAAE;YACzC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE;gBAC/D,qBAAqB,GAAG,IAAI,CAAC;aAChC;iBAAM,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACxE,QAAQ,GAAG,IAAI,CAAC;aACnB;SACJ;KACJ;IAGD,IAAI,KAAwC,CAAC;IAC7C,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC/D,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAwB,EAAE,EAAE;QAC1C,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,yBAAyB,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;YAC7F,KAAK,GAAG,CAAC,CAAC;SACb;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,KAAK,EAAE;QAER,KAAK,GAAG,IAAI,6BAAqB,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QACzD,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC/C,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjD,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;QACzE,KAAK,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,UAAU,CAAC,CAAC;QACpD,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAE/C,IAAI,KAAK,EAAE;YACP,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,kBAAkB,CAAC,KAAK,QAAE,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,mCAAI,IAAI,CAAC,MAAM,CAAC,CAAC;SACvF;KACJ;SAAM;QAEH,KAAK,GAAG,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;KACzD;IAGD,IAAI,KAAK,EAAE;QACP,OAAO,CAAC,OAAO,CAAC,qBAAS,CAAC,wBAAwB,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;KACpE;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AA5HD,8CA4HC;AAUD,SAAS,gBAAgB,CAAC,OAAgB,EAAE,UAAiC,EAAE,IAAoB;IAC/F,MAAM,SAAS,GAAG,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAEpD,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IACzF,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,MAAM,EAAK,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACtF,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACxE,UAAU,CAAC,OAAO,CAAC,sBAAc,CAAC,QAAQ,EAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;IAExF,IACI,OAAO,CAAC,SAAS;QACjB,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,aAAa,IAAI,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACnF;QACE,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;YAC3B,UAAU,CAAC,aAAa,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3E,UAAU,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChD,SAAS,CAAC,aAAa,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC;SACN;KACJ;IAED,OAAO,UAAU,CAAC;AACtB,CAAC;AAID,SAAS,yBAAyB,CAAC,KAAqB,EAAE,KAAqB;IAC3E,IACI,CAAC,KAAK,GAAG,sBAAc,CAAC,QAAQ,IAAI,KAAK,GAAG,sBAAc,CAAC,SAAS,CAAC;;YAErE,CAAC,KAAK,GAAG,sBAAc,CAAC,QAAQ,IAAI,KAAK,GAAG,sBAAc,CAAC,SAAS,CAAC,EACvE;QACE,OAAO,KAAK,CAAC;KAChB;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAWD,SAAS,iBAAiB,CAAC,OAAgB,EAAE,UAAiC,EAAE,IAAa,EAAE,IAAoB;IAC/G,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI,EAAE;QAC1B,MAAM,OAAO,GAAG,CAAC,sBAAc,CAAC,SAAS,EAAE,sBAAc,CAAC,IAAI,EAAE,sBAAc,CAAC,KAAK,CAAC,CAAC;QACtF,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,UAAU,GAAG,eAAe,EAAE;YAC9B,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC;SAC1B;KACJ;IAED,IACI,OAAO,CAAC,SAAS;QACjB,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;QACnD,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,CAAC,aAAa,IAAI,UAAU,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACnF;QACE,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;YACxB,UAAU,CAAC,UAAU,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACxE,UAAU,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChD,SAAS,CAAC,UAAU,GAAG,+BAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC3E,CAAC,CAAC,CAAC;SACN;QACD,OAAO;KACV;IAED,OAAO,UAAU,CAAC;AACtB,CAAC","sourcesContent":["import * as ts from 'typescript';\n\nimport { ContainerReflection, DeclarationReflection, ReflectionFlag, ReflectionKind } from '../../models/index';\nimport { Context } from '../context';\nimport { Converter } from '../converter';\nimport { getRawComment } from './comment.js';\nimport { createReferenceType } from './reference';\n\n/**\n * List of reflection kinds that never should be static.\n */\nconst nonStaticKinds = [\n    ReflectionKind.Class,\n    ReflectionKind.Interface,\n    ReflectionKind.Namespace\n];\n\n/**\n * List of ts kinds leading to none static merge.\n */\nconst nonStaticMergeKinds = [\n    ts.SyntaxKind.ClassDeclaration,\n    ts.SyntaxKind.ClassExpression,\n    ts.SyntaxKind.InterfaceDeclaration\n];\n\nconst builtInSymbolRegExp = /^__@(\\w+)$/;\n\nfunction hasCommentOnParentAxis (node: ts.Node): boolean {\n    let currentNode: ts.Node = node;\n\n    while (currentNode) {\n        if (Boolean(getRawComment(currentNode))) { return true; }\n\n        currentNode = currentNode.parent;\n    }\n\n    return false;\n}\n\nfunction shouldBeIgnoredAsNotDocumented (node: ts.Declaration, kind: ReflectionKind): boolean {\n    // never ignore modules, global, and enum members\n    if (kind === ReflectionKind.Module || kind === ReflectionKind.Global || kind === ReflectionKind.EnumMember) {\n        return false;\n    }\n\n    // do not ignore properties of the object types, that has comment themselves, for example\n    //\n    // /**\n    //  * has docs\n    //  */\n    //  export SomeType = { prop1 : string }\n    //\n    // same applies to the inline types for function arguments:\n    //\n    // function someFunc(arg1 : { prop1 : string, prop2 : number }) {...}\n    //\n    // The `prop1` from above should be included in the docs, even that it has no documentation\n    // Note, that this does not seem to apply to classes and interfaces - for those, even the class/interface\n    // has docs, we still want to exclude the undocumented properties\n    // Thankfully for object literals the kind of properties seems to be set to ReflectionKind.Variable\n    if (kind === ReflectionKind.Variable && hasCommentOnParentAxis(node)) {\n        return false;\n    }\n\n    const hasComment: boolean = Boolean(getRawComment(node));\n\n    return !hasComment;\n}\n\n/**\n * Create a declaration reflection from the given TypeScript node.\n *\n * @param context  The context object describing the current state the converter is in. The\n *   scope of the context will be the parent of the generated reflection.\n * @param node  The TypeScript node that should be converted to a reflection.\n * @param kind  The desired kind of the reflection.\n * @param name  The desired name of the reflection.\n * @returns The resulting reflection or undefined if an error is encountered.\n */\nexport function createDeclaration(context: Context, node: ts.Declaration, kind: ReflectionKind, name?: string): DeclarationReflection | undefined {\n    if (!(context.scope instanceof ContainerReflection)) {\n        throw new Error('Expected container reflection.');\n    }\n    const container = context.scope;\n\n    // Ensure we have a name for the reflection\n    if (!name) {\n        if (node.localSymbol) {\n            name = node.localSymbol.name;\n        } else if (node.symbol) {\n            name = node.symbol.name;\n        } else {\n            return;\n        }\n\n        // rename built-in symbols\n        const match = builtInSymbolRegExp.exec(name);\n        if (match) {\n            name = `[Symbol.${match[1]}]`;\n        } else if (kind & (ReflectionKind.ClassMember | ReflectionKind.VariableOrProperty) && name === '__computed') {\n            // rename computed properties\n            const declName = ts.getNameOfDeclaration(node);\n            const symbol = declName && context.checker.getSymbolAtLocation(declName);\n            if (symbol) {\n                name = context.checker.symbolToString(symbol, /*enclosingDeclaration*/ undefined, ts.SymbolFlags.ClassMember);\n            } else if (declName) {\n                name = declName.getText();\n            }\n        }\n    }\n\n    const modifiers = ts.getCombinedModifierFlags(node);\n\n    // Test whether the node is exported\n    let isExported: boolean;\n    if (kind === ReflectionKind.Module || kind === ReflectionKind.Global) {\n        isExported = true;\n    } else if (container.kind === ReflectionKind.Global) {\n        // In file mode, everything is exported.\n        isExported = true;\n    } else if (container.kindOf([ReflectionKind.Namespace, ReflectionKind.Module])) {\n        const symbol = context.getSymbolAtLocation(node);\n        if (!symbol) {\n            isExported = false;\n        } else {\n            let parentNode = node.parent;\n            while (![ts.SyntaxKind.SourceFile, ts.SyntaxKind.ModuleDeclaration].includes(parentNode.kind)) {\n                parentNode = parentNode.parent;\n            }\n            const parentSymbol = context.getSymbolAtLocation(parentNode);\n            if (!parentSymbol) {\n                // This is a file with no imports/exports, so everything is\n                // global and therefore exported.\n                isExported = true;\n            } else {\n                isExported = !!parentSymbol.exports?.get(symbol.escapedName);\n            }\n        }\n    } else {\n        isExported = container.flags.isExported;\n    }\n\n    if (\n        (!isExported && context.converter.excludeNotExported)\n        ||\n        (context.converter.excludeNotDocumented && shouldBeIgnoredAsNotDocumented(node, kind))\n    ) {\n        return;\n    }\n\n    // Test whether the node is private, when inheriting ignore private members\n    const isPrivate = !!(modifiers & ts.ModifierFlags.Private);\n    if (context.isInherit && isPrivate) {\n        return;\n    }\n\n    // Test whether the node is static, when merging a module to a class make the node static\n    let isConstructorProperty = false;\n    let isStatic = false;\n    if (!nonStaticKinds.includes(kind)) {\n        isStatic = !!(modifiers & ts.ModifierFlags.Static);\n        if (container.kind === ReflectionKind.Class) {\n            if (node.parent && node.parent.kind === ts.SyntaxKind.Constructor) {\n                isConstructorProperty = true;\n            } else if (!node.parent || !nonStaticMergeKinds.includes(node.parent.kind)) {\n                isStatic = true;\n            }\n        }\n    }\n\n    // Check if we already have a child of the same kind, with the same name and static flag\n    let child: DeclarationReflection | undefined;\n    const children = container.children = container.children || [];\n    children.forEach((n: DeclarationReflection) => {\n        if (n.name === name && n.flags.isStatic === isStatic && canMergeReflectionsByKind(n.kind, kind)) {\n            child = n;\n        }\n    });\n\n    if (!child) {\n        // Child does not exist, create a new reflection\n        child = new DeclarationReflection(name, kind, container);\n        child.setFlag(ReflectionFlag.Static, isStatic);\n        child.setFlag(ReflectionFlag.Private, isPrivate);\n        child.setFlag(ReflectionFlag.ConstructorProperty, isConstructorProperty);\n        child.setFlag(ReflectionFlag.Exported,  isExported);\n        child = setupDeclaration(context, child, node);\n\n        if (child) {\n            children.push(child);\n            context.registerReflection(child, context.getSymbolAtLocation(node) ?? node.symbol);\n        }\n    } else {\n        // Merge the existent reflection with the given node\n        child = mergeDeclarations(context, child, node, kind);\n    }\n\n    // If we have a reflection, trigger the corresponding event\n    if (child) {\n        context.trigger(Converter.EVENT_CREATE_DECLARATION, child, node);\n    }\n\n    return child;\n}\n\n/**\n * Setup a newly created declaration reflection.\n *\n * @param context  The context object describing the current state the converter is in.\n * @param reflection  The newly created blank reflection.\n * @param node  The TypeScript node whose properties should be applies to the given reflection.\n * @returns The reflection populated with the values of the given node.\n */\nfunction setupDeclaration(context: Context, reflection: DeclarationReflection, node: ts.Declaration) {\n    const modifiers = ts.getCombinedModifierFlags(node);\n\n    reflection.setFlag(ReflectionFlag.External,  context.isExternal);\n    reflection.setFlag(ReflectionFlag.Protected, !!(modifiers & ts.ModifierFlags.Protected));\n    reflection.setFlag(ReflectionFlag.Public,    !!(modifiers & ts.ModifierFlags.Public));\n    reflection.setFlag(ReflectionFlag.Optional,  !!(node['questionToken']));\n    reflection.setFlag(ReflectionFlag.Readonly,  !!(modifiers & ts.ModifierFlags.Readonly));\n\n    if (\n        context.isInherit &&\n        (node.parent === context.inheritParent || reflection.flags.isConstructorProperty)\n    ) {\n        if (!reflection.inheritedFrom) {\n            reflection.inheritedFrom = createReferenceType(context, node.symbol, true);\n            reflection.getAllSignatures().forEach((signature) => {\n                signature.inheritedFrom = createReferenceType(context, node.symbol, true);\n            });\n        }\n    }\n\n    return reflection;\n}\n\n// we should not be merging type and value with the same name,\n// because TypeScript has different namespaces for these two categories\nfunction canMergeReflectionsByKind(kind1: ReflectionKind, kind2: ReflectionKind): boolean {\n    if (\n        (kind1 & ReflectionKind.SomeType && kind2 & ReflectionKind.SomeValue)\n        ||\n        (kind2 & ReflectionKind.SomeType && kind1 & ReflectionKind.SomeValue)\n    ) {\n        return false;\n    }\n\n    return true;\n}\n\n/**\n * Merge the properties of the given TypeScript node with the pre existent reflection.\n *\n * @param context  The context object describing the current state the converter is in.\n * @param reflection  The pre existent reflection.\n * @param node  The TypeScript node whose properties should be merged with the given reflection.\n * @param kind  The desired kind of the reflection.\n * @returns The reflection merged with the values of the given node or NULL if the merge is invalid.\n */\nfunction mergeDeclarations(context: Context, reflection: DeclarationReflection, node: ts.Node, kind: ReflectionKind) {\n    if (reflection.kind !== kind) {\n        const weights = [ReflectionKind.Namespace, ReflectionKind.Enum, ReflectionKind.Class];\n        const kindWeight = weights.indexOf(kind);\n        const childKindWeight = weights.indexOf(reflection.kind);\n        if (kindWeight > childKindWeight) {\n            reflection.kind = kind;\n        }\n    }\n\n    if (\n        context.isInherit &&\n        (context.inherited || []).includes(reflection.name) &&\n        (node.parent === context.inheritParent || reflection.flags.isConstructorProperty)\n    ) {\n        if (!reflection.overwrites) {\n            reflection.overwrites = createReferenceType(context, node.symbol, true);\n            reflection.getAllSignatures().forEach((signature) => {\n                signature.overwrites = createReferenceType(context, node.symbol, true);\n            });\n        }\n        return;\n    }\n\n    return reflection;\n}\n"]}

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

@@ -26,6 +26,9 @@ let DynamicModulePlugin = class DynamicModulePlugin extends components_1.Convert
     onBegin(context) {
         this.basePath.reset();
         this.reflections = [];
+        if (context.getCompilerOptions().baseUrl) {
+            this.basePath.add(context.getCompilerOptions().baseUrl + '/file');
+        }
     }
     onDeclaration(context, reflection, node) {
         if (reflection.kindOf(abstract_1.ReflectionKind.Module)) {

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

@@ -1 +1 @@
-{"version":3,"file":"DynamicModulePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/DynamicModulePlugin.ts"],"names":[],"mappings":";;;;;;;;AACA,6BAA6B;AAE7B,gEAA+E;AAC/E,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAQzC,IAAa,mBAAmB,GAAhC,MAAa,mBAAoB,SAAQ,+BAAkB;IAA3D;;QAIY,aAAQ,GAAG,IAAI,oBAAQ,EAAE,CAAC;IA4DtC,CAAC;IAlDG,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAe,IAAI,CAAC,OAAO;YAClD,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAO,IAAI,CAAC,cAAc;SAC5D,CAAC,CAAC;IACP,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IAC1B,CAAC;IASO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,UAAU,CAAC,MAAM,CAAC,yBAAc,CAAC,MAAM,CAAC,EAAE;YAC1C,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACrB,OAAO;aACV;YAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC3B;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACpC,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YAC/D,UAAU,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC3D,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AAhEY,mBAAmB;IAD/B,sBAAS,CAAC,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC;GACvB,mBAAmB,CAgE/B;AAhEY,kDAAmB","sourcesContent":["import * as ts from 'typescript';\nimport * as Path from 'path';\n\nimport { Reflection, ReflectionKind } from '../../models/reflections/abstract';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\n\n/**\n * A handler that truncates the names of dynamic modules to not include the\n * project's base path.\n */\n@Component({name: 'dynamic-module'})\nexport class DynamicModulePlugin extends ConverterComponent {\n    /**\n     * Helper class for determining the base path.\n     */\n    private basePath = new BasePath();\n\n    /**\n     * List of reflections whose name must be trimmed.\n     */\n    private reflections!: Reflection[];\n\n    /**\n     * Create a new DynamicModuleHandler 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_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.basePath.reset();\n        this.reflections = [];\n    }\n\n    /**\n     * Triggered when the converter has created a declaration 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 onDeclaration(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (reflection.kindOf(ReflectionKind.Module)) {\n            let name = reflection.name;\n            if (!name.includes('/')) {\n                return;\n            }\n\n            name = name.replace(/\"/g, '');\n            this.reflections.push(reflection);\n            this.basePath.add(name);\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        this.reflections.forEach((reflection) => {\n            let name = reflection.name.replace(/\"/g, '');\n            name = name.substr(0, name.length - Path.extname(name).length);\n            reflection.name = '\"' + this.basePath.trim(name) + '\"';\n        });\n    }\n}\n"]}
+{"version":3,"file":"DynamicModulePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/DynamicModulePlugin.ts"],"names":[],"mappings":";;;;;;;;AACA,6BAA6B;AAE7B,gEAA+E;AAC/E,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAQzC,IAAa,mBAAmB,GAAhC,MAAa,mBAAoB,SAAQ,+BAAkB;IAA3D;;QAIY,aAAQ,GAAG,IAAI,oBAAQ,EAAE,CAAC;IA+DtC,CAAC;IArDG,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAe,IAAI,CAAC,OAAO;YAClD,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAO,IAAI,CAAC,cAAc;SAC5D,CAAC,CAAC;IACP,CAAC;IAOO,OAAO,CAAC,OAAgB;QAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE;YACtC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAiB,GAAG,OAAO,CAAC,CAAC;SAC/E;IACL,CAAC;IASO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,UAAU,CAAC,MAAM,CAAC,yBAAc,CAAC,MAAM,CAAC,EAAE;YAC1C,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACrB,OAAO;aACV;YAED,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SAC3B;IACL,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACpC,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YAC/D,UAAU,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAC3D,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AAnEY,mBAAmB;IAD/B,sBAAS,CAAC,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC;GACvB,mBAAmB,CAmE/B;AAnEY,kDAAmB","sourcesContent":["import * as ts from 'typescript';\nimport * as Path from 'path';\n\nimport { Reflection, ReflectionKind } from '../../models/reflections/abstract';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\n\n/**\n * A handler that truncates the names of dynamic modules to not include the\n * project's base path.\n */\n@Component({name: 'dynamic-module'})\nexport class DynamicModulePlugin extends ConverterComponent {\n    /**\n     * Helper class for determining the base path.\n     */\n    private basePath = new BasePath();\n\n    /**\n     * List of reflections whose name must be trimmed.\n     */\n    private reflections!: Reflection[];\n\n    /**\n     * Create a new DynamicModuleHandler 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_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.basePath.reset();\n        this.reflections = [];\n        if (context.getCompilerOptions().baseUrl) {\n            this.basePath.add(context.getCompilerOptions().baseUrl as string + '/file');\n        }\n    }\n\n    /**\n     * Triggered when the converter has created a declaration 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 onDeclaration(context: Context, reflection: Reflection, node?: ts.Node) {\n        if (reflection.kindOf(ReflectionKind.Module)) {\n            let name = reflection.name;\n            if (!name.includes('/')) {\n                return;\n            }\n\n            name = name.replace(/\"/g, '');\n            this.reflections.push(reflection);\n            this.basePath.add(name);\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        this.reflections.forEach((reflection) => {\n            let name = reflection.name.replace(/\"/g, '');\n            name = name.substr(0, name.length - Path.extname(name).length);\n            reflection.name = '\"' + this.basePath.trim(name) + '\"';\n        });\n    }\n}\n"]}

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

@@ -66,11 +66,11 @@ class Repository {
     static tryCreateRepository(path, gitRevision, gitRemote) {
         ShellJS.pushd(path);
         const out = ShellJS.exec('git rev-parse --show-toplevel', { silent: true });
+        const remotesOutput = ShellJS.exec(`git remote get-url ${gitRemote}`, { silent: true });
         ShellJS.popd();
-        if (!out || out.code !== 0) {
+        if (!out || out.code !== 0 || !remotesOutput || remotesOutput.code !== 0) {
             return;
         }
-        const remotesOutput = ShellJS.exec(`git remote get-url ${gitRemote}`, { silent: true });
         let remotes = (remotesOutput.code === 0) ? remotesOutput.stdout.split('\n') : [];
         return new Repository(base_path_1.BasePath.normalize(out.stdout.replace('\n', '')), gitRevision, remotes);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"GitHubPlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/GitHubPlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,mCAAmC;AACnC,6BAA6B;AAG7B,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAEzC,uCAAyC;AAKzC,MAAa,UAAU;IAyCnB,YAAY,IAAY,EAAE,WAAmB,EAAE,SAAmB;QA3BlE,UAAK,GAAa,EAAE,CAAC;QAoBrB,mBAAc,GAAG,YAAY,CAAC;QAQ1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,WAAW,IAAI,QAAQ,CAAC;QACtC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,+CAA+C,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAE/E,IAAI,GAAG,EAAE;gBACL,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC7B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;oBAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;iBACpF;gBACD,MAAM;aACT;SACJ;QAED,IAAI,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACvF,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;YAChB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACpC,IAAI,IAAI,KAAK,EAAE,EAAE;oBACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,oBAAQ,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC;iBAC1D;YACL,CAAC,CAAC,CAAC;SACN;QAED,IAAI,CAAC,WAAW,EAAE;YACd,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;YACjG,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;gBAChB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC9C;SACJ;QAED,OAAO,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC;IAQD,QAAQ,CAAC,QAAgB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAQD,YAAY,CAAC,QAAgB;QACzB,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACrE,OAAO;SACV;QAED,OAAO;YACH,WAAW,IAAI,CAAC,cAAc,EAAE;YAChC,IAAI,CAAC,UAAU;YACf,IAAI,CAAC,aAAa;YAClB,MAAM;YACN,IAAI,CAAC,MAAM;YACX,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACxC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IAWD,MAAM,CAAC,mBAAmB,CAAC,IAAY,EAAE,WAAmB,EAAE,SAAiB;QAC3E,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,MAAM,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QAC1G,OAAO,CAAC,IAAI,EAAE,CAAC;QAEf,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;YACxB,OAAO;SACV;QAED,MAAM,aAAa,GAAmC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtH,IAAI,OAAO,GAAa,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE3F,OAAO,IAAI,UAAU,CAAC,oBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACJ;AArID,gCAqIC;AAOD,IAAa,YAAY,GAAzB,MAAa,YAAa,SAAQ,+BAAkB;IAApD;;QAIY,iBAAY,GAAiC,EAAE,CAAC;QAKhD,iBAAY,GAAa,EAAE,CAAC;IAoFxC,CAAC;IAvEG,UAAU;QACN,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QAC7B,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,qBAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SAC7E;IACL,CAAC;IAQO,aAAa,CAAC,QAAgB;QAElC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACtD,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;gBAClC,OAAO;aACV;SACJ;QAGD,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE;YAChC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;gBACzC,SAAS;aACZ;YACD,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;gBACxD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAClC;SACJ;QAGD,MAAM,UAAU,GAAG,UAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7F,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,GAAG,UAAU,CAAC;YAC9D,OAAO,UAAU,CAAC;SACrB;QAGD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,KAAK,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SAC1D;IACL,CAAC;IAOO,YAAY,CAAC,OAAgB;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACjC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC/D,IAAI,UAAU,EAAE;gBACZ,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;QAEH,KAAK,IAAI,GAAG,IAAI,OAAO,CAAC,WAAW,EAAE;YACjC,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YAC5C,IAAI,UAAU,CAAC,OAAO,EAAE;gBACpB,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAuB,EAAE,EAAE;oBACnD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;wBAChC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;qBACrD;gBACL,CAAC,CAAC,CAAC;aACN;SACJ;IACL,CAAC;CACJ,CAAA;AAjFG;IADC,kBAAU,CAAC,aAAa,CAAC;iDACI;AAG9B;IADC,kBAAU,CAAC,WAAW,CAAC;+CACI;AAfnB,YAAY;IADxB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,YAAY,CA6FxB;AA7FY,oCAAY","sourcesContent":["import * as ShellJS from 'shelljs';\nimport * as Path from 'path';\n\nimport { SourceReference } from '../../models/sources/file';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { BindOption } from '../../utils';\n\n/**\n * Stores data of a repository.\n */\nexport class Repository {\n    /**\n     * The root path of this repository.\n     */\n    path: string;\n\n    /**\n     * The name of the branch this repository is on right now.\n     */\n    branch: string;\n\n    /**\n     * A list of all files tracked by the repository.\n     */\n    files: string[] = [];\n\n    /**\n     * The user/organization name of this repository on GitHub.\n     */\n    gitHubUser?: string;\n\n    /**\n     * The project name of this repository on GitHub.\n     */\n    gitHubProject?: string;\n\n    /**\n     * The hostname for this github project.\n     *\n     * Defaults to: `github.com` (for normal, public GitHub instance projects)\n     *\n     * Or the hostname for an enterprise version of GitHub, e.g. `github.acme.com`\n     * (if found as a match in the list of git remotes).\n     */\n    gitHubHostname = 'github.com';\n\n    /**\n     * Create a new Repository instance.\n     *\n     * @param path  The root path of the repository.\n     */\n    constructor(path: string, gitRevision: string, repoLinks: string[]) {\n        this.path = path;\n        this.branch = gitRevision || 'master';\n        ShellJS.pushd(path);\n\n        for (let i = 0, c = repoLinks.length; i < c; i++) {\n            const url = /(github(?:\\.[a-z]+)*\\.com)[:\\/]([^\\/]+)\\/(.*)/.exec(repoLinks[i]);\n\n            if (url) {\n                this.gitHubHostname = url[1];\n                this.gitHubUser = url[2];\n                this.gitHubProject = url[3];\n                if (this.gitHubProject.substr(-4) === '.git') {\n                    this.gitHubProject = this.gitHubProject.substr(0, this.gitHubProject.length - 4);\n                }\n                break;\n            }\n        }\n\n        let out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git ls-files', {silent: true});\n        if (out.code === 0) {\n            out.stdout.split('\\n').forEach((file) => {\n                if (file !== '') {\n                    this.files.push(BasePath.normalize(path + '/' + file));\n                }\n            });\n        }\n\n        if (!gitRevision) {\n            out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --short HEAD', {silent: true});\n            if (out.code === 0) {\n                this.branch = out.stdout.replace('\\n', '');\n            }\n        }\n\n        ShellJS.popd();\n    }\n\n    /**\n     * Check whether the given file is tracked by this repository.\n     *\n     * @param fileName  The name of the file to test for.\n     * @returns TRUE when the file is part of the repository, otherwise FALSE.\n     */\n    contains(fileName: string): boolean {\n        return this.files.includes(fileName);\n    }\n\n    /**\n     * Get the URL of the given file on GitHub.\n     *\n     * @param fileName  The file whose GitHub URL should be determined.\n     * @returns An url pointing to the web preview of the given file or NULL.\n     */\n    getGitHubURL(fileName: string): string | undefined {\n        if (!this.gitHubUser || !this.gitHubProject || !this.contains(fileName)) {\n            return;\n        }\n\n        return [\n            `https://${this.gitHubHostname}`,\n            this.gitHubUser,\n            this.gitHubProject,\n            'blob',\n            this.branch,\n            fileName.substr(this.path.length + 1)\n        ].join('/');\n    }\n\n    /**\n     * Try to create a new repository instance.\n     *\n     * Checks whether the given path is the root of a valid repository and if so\n     * creates a new instance of [[Repository]].\n     *\n     * @param path  The potential repository root.\n     * @returns A new instance of [[Repository]] or undefined.\n     */\n    static tryCreateRepository(path: string, gitRevision: string, gitRemote: string): Repository | undefined {\n        ShellJS.pushd(path);\n        const out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --show-toplevel', {silent: true});\n        ShellJS.popd();\n\n        if (!out || out.code !== 0) {\n            return;\n        }\n\n        const remotesOutput = <ShellJS.ExecOutputReturnValue> ShellJS.exec(`git remote get-url ${gitRemote}`, {silent: true});\n        let remotes: string[] = (remotesOutput.code === 0) ? remotesOutput.stdout.split('\\n') : [];\n\n        return new Repository(BasePath.normalize(out.stdout.replace('\\n', '')), gitRevision, remotes);\n    }\n}\n\n/**\n * A handler that watches for repositories with GitHub origin and links\n * their source files to the related GitHub pages.\n */\n@Component({name: 'git-hub'})\nexport class GitHubPlugin extends ConverterComponent {\n    /**\n     * List of known repositories.\n     */\n    private repositories: {[path: string]: Repository} = {};\n\n    /**\n     * List of paths known to be not under git control.\n     */\n    private ignoredPaths: string[] = [];\n\n    @BindOption('gitRevision')\n    readonly gitRevision!: string;\n\n    @BindOption('gitRemote')\n    readonly gitRemote!: string;\n\n    /**\n     * Create a new GitHubHandler instance.\n     *\n     * @param converter  The converter this plugin should be attached to.\n     */\n    initialize() {\n        ShellJS.config.silent = true;\n        if (ShellJS.which('git')) {\n            this.listenTo(this.owner, Converter.EVENT_RESOLVE_END, this.onEndResolve);\n        }\n    }\n\n    /**\n     * Check whether the given file is placed inside a repository.\n     *\n     * @param fileName  The name of the file a repository should be looked for.\n     * @returns The found repository info or undefined.\n     */\n    private getRepository(fileName: string): Repository | undefined {\n        // Check for known non-repositories\n        const dirName = Path.dirname(fileName);\n        for (let i = 0, c = this.ignoredPaths.length; i < c; i++) {\n            if (this.ignoredPaths[i] === dirName) {\n                return;\n            }\n        }\n\n        // Check for known repositories\n        for (let path in this.repositories) {\n            if (!this.repositories.hasOwnProperty(path)) {\n                continue;\n            }\n            if (fileName.substr(0, path.length).toLowerCase() === path) {\n                return this.repositories[path];\n            }\n        }\n\n        // Try to create a new repository\n        const repository = Repository.tryCreateRepository(dirName, this.gitRevision, this.gitRemote);\n        if (repository) {\n            this.repositories[repository.path.toLowerCase()] = repository;\n            return repository;\n        }\n\n        // No repository found, add path to ignored paths\n        const segments = dirName.split('/');\n        for (let i = segments.length; i > 0; i--) {\n            this.ignoredPaths.push(segments.slice(0, i).join('/'));\n        }\n    }\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onEndResolve(context: Context) {\n        const project = context.project;\n        project.files.forEach((sourceFile) => {\n            const repository = this.getRepository(sourceFile.fullFileName);\n            if (repository) {\n                sourceFile.url = repository.getGitHubURL(sourceFile.fullFileName);\n            }\n        });\n\n        for (let key in project.reflections) {\n            const reflection = project.reflections[key];\n            if (reflection.sources) {\n                reflection.sources.forEach((source: SourceReference) => {\n                    if (source.file && source.file.url) {\n                        source.url = source.file.url + '#L' + source.line;\n                    }\n                });\n            }\n        }\n    }\n}\n"]}
+{"version":3,"file":"GitHubPlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/GitHubPlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,mCAAmC;AACnC,6BAA6B;AAG7B,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAEzC,uCAAyC;AAKzC,MAAa,UAAU;IAyCnB,YAAY,IAAY,EAAE,WAAmB,EAAE,SAAmB;QA3BlE,UAAK,GAAa,EAAE,CAAC;QAoBrB,mBAAc,GAAG,YAAY,CAAC;QAQ1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,WAAW,IAAI,QAAQ,CAAC;QACtC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,+CAA+C,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAE/E,IAAI,GAAG,EAAE;gBACL,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC7B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACzB,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;oBAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;iBACpF;gBACD,MAAM;aACT;SACJ;QAED,IAAI,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACvF,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;YAChB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACpC,IAAI,IAAI,KAAK,EAAE,EAAE;oBACb,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,oBAAQ,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC;iBAC1D;YACL,CAAC,CAAC,CAAC;SACN;QAED,IAAI,CAAC,WAAW,EAAE;YACd,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;YACjG,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;gBAChB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC9C;SACJ;QAED,OAAO,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC;IAQD,QAAQ,CAAC,QAAgB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAQD,YAAY,CAAC,QAAgB;QACzB,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACrE,OAAO;SACV;QAED,OAAO;YACH,WAAW,IAAI,CAAC,cAAc,EAAE;YAChC,IAAI,CAAC,UAAU;YACf,IAAI,CAAC,aAAa;YAClB,MAAM;YACN,IAAI,CAAC,MAAM;YACX,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACxC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IAWD,MAAM,CAAC,mBAAmB,CAAC,IAAY,EAAE,WAAmB,EAAE,SAAiB;QAC3E,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,MAAM,GAAG,GAAmC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QAC1G,MAAM,aAAa,GAAmC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;QACtH,OAAO,CAAC,IAAI,EAAE,CAAC;QAEf,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,EAAE;YACtE,OAAO;SACV;QAED,IAAI,OAAO,GAAa,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAE3F,OAAO,IAAI,UAAU,CAAC,oBAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAClG,CAAC;CACJ;AArID,gCAqIC;AAOD,IAAa,YAAY,GAAzB,MAAa,YAAa,SAAQ,+BAAkB;IAApD;;QAIY,iBAAY,GAAiC,EAAE,CAAC;QAKhD,iBAAY,GAAa,EAAE,CAAC;IAoFxC,CAAC;IAvEG,UAAU;QACN,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QAC7B,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,qBAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SAC7E;IACL,CAAC;IAQO,aAAa,CAAC,QAAgB;QAElC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACtD,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;gBAClC,OAAO;aACV;SACJ;QAGD,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE;YAChC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;gBACzC,SAAS;aACZ;YACD,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;gBACxD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAClC;SACJ;QAGD,MAAM,UAAU,GAAG,UAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7F,IAAI,UAAU,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,GAAG,UAAU,CAAC;YAC9D,OAAO,UAAU,CAAC;SACrB;QAGD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,KAAK,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SAC1D;IACL,CAAC;IAOO,YAAY,CAAC,OAAgB;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACjC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC/D,IAAI,UAAU,EAAE;gBACZ,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;aACrE;QACL,CAAC,CAAC,CAAC;QAEH,KAAK,IAAI,GAAG,IAAI,OAAO,CAAC,WAAW,EAAE;YACjC,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YAC5C,IAAI,UAAU,CAAC,OAAO,EAAE;gBACpB,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAuB,EAAE,EAAE;oBACnD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;wBAChC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;qBACrD;gBACL,CAAC,CAAC,CAAC;aACN;SACJ;IACL,CAAC;CACJ,CAAA;AAjFG;IADC,kBAAU,CAAC,aAAa,CAAC;iDACI;AAG9B;IADC,kBAAU,CAAC,WAAW,CAAC;+CACI;AAfnB,YAAY;IADxB,sBAAS,CAAC,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;GAChB,YAAY,CA6FxB;AA7FY,oCAAY","sourcesContent":["import * as ShellJS from 'shelljs';\nimport * as Path from 'path';\n\nimport { SourceReference } from '../../models/sources/file';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { BindOption } from '../../utils';\n\n/**\n * Stores data of a repository.\n */\nexport class Repository {\n    /**\n     * The root path of this repository.\n     */\n    path: string;\n\n    /**\n     * The name of the branch this repository is on right now.\n     */\n    branch: string;\n\n    /**\n     * A list of all files tracked by the repository.\n     */\n    files: string[] = [];\n\n    /**\n     * The user/organization name of this repository on GitHub.\n     */\n    gitHubUser?: string;\n\n    /**\n     * The project name of this repository on GitHub.\n     */\n    gitHubProject?: string;\n\n    /**\n     * The hostname for this github project.\n     *\n     * Defaults to: `github.com` (for normal, public GitHub instance projects)\n     *\n     * Or the hostname for an enterprise version of GitHub, e.g. `github.acme.com`\n     * (if found as a match in the list of git remotes).\n     */\n    gitHubHostname = 'github.com';\n\n    /**\n     * Create a new Repository instance.\n     *\n     * @param path  The root path of the repository.\n     */\n    constructor(path: string, gitRevision: string, repoLinks: string[]) {\n        this.path = path;\n        this.branch = gitRevision || 'master';\n        ShellJS.pushd(path);\n\n        for (let i = 0, c = repoLinks.length; i < c; i++) {\n            const url = /(github(?:\\.[a-z]+)*\\.com)[:\\/]([^\\/]+)\\/(.*)/.exec(repoLinks[i]);\n\n            if (url) {\n                this.gitHubHostname = url[1];\n                this.gitHubUser = url[2];\n                this.gitHubProject = url[3];\n                if (this.gitHubProject.substr(-4) === '.git') {\n                    this.gitHubProject = this.gitHubProject.substr(0, this.gitHubProject.length - 4);\n                }\n                break;\n            }\n        }\n\n        let out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git ls-files', {silent: true});\n        if (out.code === 0) {\n            out.stdout.split('\\n').forEach((file) => {\n                if (file !== '') {\n                    this.files.push(BasePath.normalize(path + '/' + file));\n                }\n            });\n        }\n\n        if (!gitRevision) {\n            out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --short HEAD', {silent: true});\n            if (out.code === 0) {\n                this.branch = out.stdout.replace('\\n', '');\n            }\n        }\n\n        ShellJS.popd();\n    }\n\n    /**\n     * Check whether the given file is tracked by this repository.\n     *\n     * @param fileName  The name of the file to test for.\n     * @returns TRUE when the file is part of the repository, otherwise FALSE.\n     */\n    contains(fileName: string): boolean {\n        return this.files.includes(fileName);\n    }\n\n    /**\n     * Get the URL of the given file on GitHub.\n     *\n     * @param fileName  The file whose GitHub URL should be determined.\n     * @returns An url pointing to the web preview of the given file or NULL.\n     */\n    getGitHubURL(fileName: string): string | undefined {\n        if (!this.gitHubUser || !this.gitHubProject || !this.contains(fileName)) {\n            return;\n        }\n\n        return [\n            `https://${this.gitHubHostname}`,\n            this.gitHubUser,\n            this.gitHubProject,\n            'blob',\n            this.branch,\n            fileName.substr(this.path.length + 1)\n        ].join('/');\n    }\n\n    /**\n     * Try to create a new repository instance.\n     *\n     * Checks whether the given path is the root of a valid repository and if so\n     * creates a new instance of [[Repository]].\n     *\n     * @param path  The potential repository root.\n     * @returns A new instance of [[Repository]] or undefined.\n     */\n    static tryCreateRepository(path: string, gitRevision: string, gitRemote: string): Repository | undefined {\n        ShellJS.pushd(path);\n        const out = <ShellJS.ExecOutputReturnValue> ShellJS.exec('git rev-parse --show-toplevel', {silent: true});\n        const remotesOutput = <ShellJS.ExecOutputReturnValue> ShellJS.exec(`git remote get-url ${gitRemote}`, {silent: true});\n        ShellJS.popd();\n\n        if (!out || out.code !== 0 || !remotesOutput || remotesOutput.code !== 0) {\n            return;\n        }\n\n        let remotes: string[] = (remotesOutput.code === 0) ? remotesOutput.stdout.split('\\n') : [];\n\n        return new Repository(BasePath.normalize(out.stdout.replace('\\n', '')), gitRevision, remotes);\n    }\n}\n\n/**\n * A handler that watches for repositories with GitHub origin and links\n * their source files to the related GitHub pages.\n */\n@Component({name: 'git-hub'})\nexport class GitHubPlugin extends ConverterComponent {\n    /**\n     * List of known repositories.\n     */\n    private repositories: {[path: string]: Repository} = {};\n\n    /**\n     * List of paths known to be not under git control.\n     */\n    private ignoredPaths: string[] = [];\n\n    @BindOption('gitRevision')\n    readonly gitRevision!: string;\n\n    @BindOption('gitRemote')\n    readonly gitRemote!: string;\n\n    /**\n     * Create a new GitHubHandler instance.\n     *\n     * @param converter  The converter this plugin should be attached to.\n     */\n    initialize() {\n        ShellJS.config.silent = true;\n        if (ShellJS.which('git')) {\n            this.listenTo(this.owner, Converter.EVENT_RESOLVE_END, this.onEndResolve);\n        }\n    }\n\n    /**\n     * Check whether the given file is placed inside a repository.\n     *\n     * @param fileName  The name of the file a repository should be looked for.\n     * @returns The found repository info or undefined.\n     */\n    private getRepository(fileName: string): Repository | undefined {\n        // Check for known non-repositories\n        const dirName = Path.dirname(fileName);\n        for (let i = 0, c = this.ignoredPaths.length; i < c; i++) {\n            if (this.ignoredPaths[i] === dirName) {\n                return;\n            }\n        }\n\n        // Check for known repositories\n        for (let path in this.repositories) {\n            if (!this.repositories.hasOwnProperty(path)) {\n                continue;\n            }\n            if (fileName.substr(0, path.length).toLowerCase() === path) {\n                return this.repositories[path];\n            }\n        }\n\n        // Try to create a new repository\n        const repository = Repository.tryCreateRepository(dirName, this.gitRevision, this.gitRemote);\n        if (repository) {\n            this.repositories[repository.path.toLowerCase()] = repository;\n            return repository;\n        }\n\n        // No repository found, add path to ignored paths\n        const segments = dirName.split('/');\n        for (let i = segments.length; i > 0; i--) {\n            this.ignoredPaths.push(segments.slice(0, i).join('/'));\n        }\n    }\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onEndResolve(context: Context) {\n        const project = context.project;\n        project.files.forEach((sourceFile) => {\n            const repository = this.getRepository(sourceFile.fullFileName);\n            if (repository) {\n                sourceFile.url = repository.getGitHubURL(sourceFile.fullFileName);\n            }\n        });\n\n        for (let key in project.reflections) {\n            const reflection = project.reflections[key];\n            if (reflection.sources) {\n                reflection.sources.forEach((source: SourceReference) => {\n                    if (source.file && source.file.url) {\n                        source.url = source.file.url + '#L' + source.line;\n                    }\n                });\n            }\n        }\n    }\n}\n"]}

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

@@ -49,6 +49,9 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         }
         const fileName = node.fileName;
         this.basePath.add(fileName);
+        if (context.getCompilerOptions().baseUrl) {
+            this.basePath.add(context.getCompilerOptions().baseUrl + '/file');
+        }
         this.getSourceFile(fileName, context.project);
     }
     onDeclaration(context, reflection, node) {

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

@@ -1 +1 @@
-{"version":3,"file":"SourcePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/SourcePlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,6BAA6B;AAC7B,iCAAiC;AAGjC,0DAAsG;AACtG,sDAAyE;AACzE,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAEzC,uCAAyC;AAMzC,IAAa,YAAY,GAAzB,MAAa,YAAa,SAAQ,+BAAkB;IAApD;;QAOY,aAAQ,GAAG,IAAI,oBAAQ,EAAE,CAAC;QAK1B,iBAAY,GAAiC,EAAE,CAAC;IA0J5D,CAAC;IArJG,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAe,IAAI,CAAC,OAAO;YAClD,CAAC,qBAAS,CAAC,gBAAgB,CAAC,EAAU,IAAI,CAAC,eAAe;YAC1D,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,sBAAsB,CAAC,EAAI,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAO,IAAI,CAAC,cAAc;YACzD,CAAC,qBAAS,CAAC,aAAa,CAAC,EAAa,IAAI,CAAC,SAAS;YACpD,CAAC,qBAAS,CAAC,iBAAiB,CAAC,EAAS,IAAI,CAAC,YAAY;SAC1D,CAAC,CAAC;IACP,CAAC;IAEO,aAAa,CAAC,QAAgB,EAAE,OAA0B;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,kBAAU,CAAC,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YACnC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5B;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAOO,OAAO;QACX,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IAC3B,CAAC;IAWO,eAAe,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAoB;QAClF,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAWO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE;YAC9B,OAAO;SACV;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAe,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvE,IAAI,QAA6B,CAAC;QAClC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE;YAClC,QAAQ,GAAG,EAAE,CAAC,6BAA6B,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;SAC7E;aAAM;YACH,QAAQ,GAAG,EAAE,CAAC,6BAA6B,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;SACrE;QAED,IAAI,UAAU,YAAY,6BAAqB,EAAE;YAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACrB,UAAU,CAAC,OAAO,GAAG,EAAE,CAAC;SAC3B;QAED,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC;YACvB,SAAS,EAAE,QAAQ,CAAC,SAAS;SAChC,CAAC,CAAC;IACP,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAQO,SAAS,CAAC,OAAgB,EAAE,UAAsB;QACtD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACrB,OAAO;SACV;QACD,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAClC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACP,CAAC;IAOO,YAAY,CAAC,OAAgB;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,MAAM,WAAW,GAAiB,EAAE,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACpC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;oBAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE;wBACzE,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,uBAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;qBAChF;oBACD,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;YAED,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AApKG;IADC,kBAAU,CAAC,gBAAgB,CAAC;oDACK;AAFzB,YAAY;IADxB,sBAAS,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC;GACf,YAAY,CAsKxB;AAtKY,oCAAY","sourcesContent":["import * as Path from 'path';\nimport * as ts from 'typescript';\nimport * as _ts from '../../ts-internal';\n\nimport { Reflection, ProjectReflection, DeclarationReflection } from '../../models/reflections/index';\nimport { SourceDirectory, SourceFile } from '../../models/sources/index';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { BindOption } from '../../utils';\n\n/**\n * A handler that attaches source file information to reflections.\n */\n@Component({name: 'source'})\nexport class SourcePlugin extends ConverterComponent {\n    @BindOption('disableSources')\n    readonly disableSources!: boolean;\n\n    /**\n     * Helper for resolving the base path of all source files.\n     */\n    private basePath = new BasePath();\n\n    /**\n     * A map of all generated [[SourceFile]] instances.\n     */\n    private fileMappings: {[name: string]: SourceFile} = {};\n\n    /**\n     * Create a new SourceHandler 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_CREATE_DECLARATION]: this.onDeclaration,\n            [Converter.EVENT_CREATE_SIGNATURE]:   this.onDeclaration,\n            [Converter.EVENT_RESOLVE_BEGIN]:      this.onBeginResolve,\n            [Converter.EVENT_RESOLVE]:            this.onResolve,\n            [Converter.EVENT_RESOLVE_END]:        this.onEndResolve\n        });\n    }\n\n    private getSourceFile(fileName: string, project: ProjectReflection): SourceFile {\n        if (!this.fileMappings[fileName]) {\n            const file = new SourceFile(fileName);\n            this.fileMappings[fileName] = file;\n            project.files.push(file);\n        }\n\n        return this.fileMappings[fileName];\n    }\n\n    /**\n     * Triggered once per project before the dispatcher invokes the compiler.\n     *\n     * @param event  An event object containing the related project and compiler instance.\n     */\n    private onBegin() {\n        this.basePath.reset();\n        this.fileMappings = {};\n    }\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     *\n     * Create a new [[SourceFile]] instance for all TypeScript files.\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        if (!node) {\n            return;\n        }\n        const fileName = node.fileName;\n        this.basePath.add(fileName);\n        this.getSourceFile(fileName, context.project);\n    }\n\n    /**\n     * Triggered when the converter has created a declaration reflection.\n     *\n     * Attach the current source file to the [[DeclarationReflection.sources]] array.\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 || this.disableSources) {\n            return;\n        }\n        const sourceFile = node.getSourceFile();\n        const fileName = sourceFile.fileName;\n        this.basePath.add(fileName);\n        const file: SourceFile = this.getSourceFile(fileName, context.project);\n\n        let position: ts.LineAndCharacter;\n        if (node['name'] && node['name'].end) {\n            position = ts.getLineAndCharacterOfPosition(sourceFile, node['name'].end);\n        } else {\n            position = ts.getLineAndCharacterOfPosition(sourceFile, node.pos);\n        }\n\n        if (reflection instanceof DeclarationReflection) {\n            file.reflections.push(reflection);\n        }\n\n        if (!reflection.sources) {\n            reflection.sources = [];\n        }\n\n        reflection.sources.push({\n            file: file,\n            fileName: fileName,\n            line: position.line + 1,\n            character: position.character\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        context.project.files.forEach((file) => {\n            const fileName = file.fileName = this.basePath.trim(file.fileName);\n            this.fileMappings[fileName] = file;\n        });\n    }\n\n    /**\n     * Triggered when the converter resolves a reflection.\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: Reflection) {\n        if (!reflection.sources) {\n            return;\n        }\n        reflection.sources.forEach((source) => {\n            source.fileName = this.basePath.trim(source.fileName);\n        });\n    }\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onEndResolve(context: Context) {\n        const project = context.project;\n        const home = project.directory;\n        project.files.forEach((file) => {\n            const reflections: Reflection[] = [];\n            file.reflections.forEach((reflection) => {\n                reflections.push(reflection);\n            });\n\n            let directory = home;\n            const path = Path.dirname(file.fileName);\n            if (path !== '.') {\n                path.split('/').forEach((pathPiece) => {\n                    if (!Object.prototype.hasOwnProperty.call(directory.directories, pathPiece)) {\n                        directory.directories[pathPiece] = new SourceDirectory(pathPiece, directory);\n                    }\n                    directory = directory.directories[pathPiece];\n                });\n            }\n\n            directory.files.push(file);\n            // reflections.sort(GroupHandler.sortCallback);\n            file.parent = directory;\n            file.reflections = reflections;\n        });\n    }\n}\n"]}
+{"version":3,"file":"SourcePlugin.js","sourceRoot":"","sources":["../../../../src/lib/converter/plugins/SourcePlugin.ts"],"names":[],"mappings":";;;;;;;;AAAA,6BAA6B;AAC7B,iCAAiC;AAGjC,0DAAsG;AACtG,sDAAyE;AACzE,8CAA8D;AAC9D,kDAA8C;AAC9C,4CAAyC;AAEzC,uCAAyC;AAMzC,IAAa,YAAY,GAAzB,MAAa,YAAa,SAAQ,+BAAkB;IAApD;;QAOY,aAAQ,GAAG,IAAI,oBAAQ,EAAE,CAAC;QAK1B,iBAAY,GAAiC,EAAE,CAAC;IA6J5D,CAAC;IAxJG,UAAU;QACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE;YACtB,CAAC,qBAAS,CAAC,WAAW,CAAC,EAAe,IAAI,CAAC,OAAO;YAClD,CAAC,qBAAS,CAAC,gBAAgB,CAAC,EAAU,IAAI,CAAC,eAAe;YAC1D,CAAC,qBAAS,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,sBAAsB,CAAC,EAAI,IAAI,CAAC,aAAa;YACxD,CAAC,qBAAS,CAAC,mBAAmB,CAAC,EAAO,IAAI,CAAC,cAAc;YACzD,CAAC,qBAAS,CAAC,aAAa,CAAC,EAAa,IAAI,CAAC,SAAS;YACpD,CAAC,qBAAS,CAAC,iBAAiB,CAAC,EAAS,IAAI,CAAC,YAAY;SAC1D,CAAC,CAAC;IACP,CAAC;IAEO,aAAa,CAAC,QAAgB,EAAE,OAA0B;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,kBAAU,CAAC,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YACnC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5B;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAOO,OAAO;QACX,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IAC3B,CAAC;IAWO,eAAe,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAoB;QAClF,IAAI,CAAC,IAAI,EAAE;YACP,OAAO;SACV;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE;YACtC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAiB,GAAG,OAAO,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAWO,aAAa,CAAC,OAAgB,EAAE,UAAsB,EAAE,IAAc;QAC1E,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE;YAC9B,OAAO;SACV;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAe,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvE,IAAI,QAA6B,CAAC;QAClC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE;YAClC,QAAQ,GAAG,EAAE,CAAC,6BAA6B,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;SAC7E;aAAM;YACH,QAAQ,GAAG,EAAE,CAAC,6BAA6B,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;SACrE;QAED,IAAI,UAAU,YAAY,6BAAqB,EAAE;YAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACrB,UAAU,CAAC,OAAO,GAAG,EAAE,CAAC;SAC3B;QAED,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ,CAAC,IAAI,GAAG,CAAC;YACvB,SAAS,EAAE,QAAQ,CAAC,SAAS;SAChC,CAAC,CAAC;IACP,CAAC;IAOO,cAAc,CAAC,OAAgB;QACnC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAQO,SAAS,CAAC,OAAgB,EAAE,UAAsB;QACtD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACrB,OAAO;SACV;QACD,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAClC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACP,CAAC;IAOO,YAAY,CAAC,OAAgB;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;QAC/B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC3B,MAAM,WAAW,GAAiB,EAAE,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACpC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,IAAI,SAAS,GAAG,IAAI,CAAC;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;oBAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE;wBACzE,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,uBAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;qBAChF;oBACD,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;YAED,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AAvKG;IADC,kBAAU,CAAC,gBAAgB,CAAC;oDACK;AAFzB,YAAY;IADxB,sBAAS,CAAC,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC;GACf,YAAY,CAyKxB;AAzKY,oCAAY","sourcesContent":["import * as Path from 'path';\nimport * as ts from 'typescript';\nimport * as _ts from '../../ts-internal';\n\nimport { Reflection, ProjectReflection, DeclarationReflection } from '../../models/reflections/index';\nimport { SourceDirectory, SourceFile } from '../../models/sources/index';\nimport { Component, ConverterComponent } from '../components';\nimport { BasePath } from '../utils/base-path';\nimport { Converter } from '../converter';\nimport { Context } from '../context';\nimport { BindOption } from '../../utils';\n\n/**\n * A handler that attaches source file information to reflections.\n */\n@Component({name: 'source'})\nexport class SourcePlugin extends ConverterComponent {\n    @BindOption('disableSources')\n    readonly disableSources!: boolean;\n\n    /**\n     * Helper for resolving the base path of all source files.\n     */\n    private basePath = new BasePath();\n\n    /**\n     * A map of all generated [[SourceFile]] instances.\n     */\n    private fileMappings: {[name: string]: SourceFile} = {};\n\n    /**\n     * Create a new SourceHandler 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_CREATE_DECLARATION]: this.onDeclaration,\n            [Converter.EVENT_CREATE_SIGNATURE]:   this.onDeclaration,\n            [Converter.EVENT_RESOLVE_BEGIN]:      this.onBeginResolve,\n            [Converter.EVENT_RESOLVE]:            this.onResolve,\n            [Converter.EVENT_RESOLVE_END]:        this.onEndResolve\n        });\n    }\n\n    private getSourceFile(fileName: string, project: ProjectReflection): SourceFile {\n        if (!this.fileMappings[fileName]) {\n            const file = new SourceFile(fileName);\n            this.fileMappings[fileName] = file;\n            project.files.push(file);\n        }\n\n        return this.fileMappings[fileName];\n    }\n\n    /**\n     * Triggered once per project before the dispatcher invokes the compiler.\n     *\n     * @param event  An event object containing the related project and compiler instance.\n     */\n    private onBegin() {\n        this.basePath.reset();\n        this.fileMappings = {};\n    }\n\n    /**\n     * Triggered when the converter begins converting a source file.\n     *\n     * Create a new [[SourceFile]] instance for all TypeScript files.\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        if (!node) {\n            return;\n        }\n        const fileName = node.fileName;\n        this.basePath.add(fileName);\n        if (context.getCompilerOptions().baseUrl) {\n            this.basePath.add(context.getCompilerOptions().baseUrl as string + '/file');\n        }\n        this.getSourceFile(fileName, context.project);\n    }\n\n    /**\n     * Triggered when the converter has created a declaration reflection.\n     *\n     * Attach the current source file to the [[DeclarationReflection.sources]] array.\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 || this.disableSources) {\n            return;\n        }\n        const sourceFile = node.getSourceFile();\n        const fileName = sourceFile.fileName;\n        this.basePath.add(fileName);\n        const file: SourceFile = this.getSourceFile(fileName, context.project);\n\n        let position: ts.LineAndCharacter;\n        if (node['name'] && node['name'].end) {\n            position = ts.getLineAndCharacterOfPosition(sourceFile, node['name'].end);\n        } else {\n            position = ts.getLineAndCharacterOfPosition(sourceFile, node.pos);\n        }\n\n        if (reflection instanceof DeclarationReflection) {\n            file.reflections.push(reflection);\n        }\n\n        if (!reflection.sources) {\n            reflection.sources = [];\n        }\n\n        reflection.sources.push({\n            file: file,\n            fileName: fileName,\n            line: position.line + 1,\n            character: position.character\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        context.project.files.forEach((file) => {\n            const fileName = file.fileName = this.basePath.trim(file.fileName);\n            this.fileMappings[fileName] = file;\n        });\n    }\n\n    /**\n     * Triggered when the converter resolves a reflection.\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: Reflection) {\n        if (!reflection.sources) {\n            return;\n        }\n        reflection.sources.forEach((source) => {\n            source.fileName = this.basePath.trim(source.fileName);\n        });\n    }\n\n    /**\n     * Triggered when the converter has finished resolving a project.\n     *\n     * @param context  The context object describing the current state the converter is in.\n     */\n    private onEndResolve(context: Context) {\n        const project = context.project;\n        const home = project.directory;\n        project.files.forEach((file) => {\n            const reflections: Reflection[] = [];\n            file.reflections.forEach((reflection) => {\n                reflections.push(reflection);\n            });\n\n            let directory = home;\n            const path = Path.dirname(file.fileName);\n            if (path !== '.') {\n                path.split('/').forEach((pathPiece) => {\n                    if (!Object.prototype.hasOwnProperty.call(directory.directories, pathPiece)) {\n                        directory.directories[pathPiece] = new SourceDirectory(pathPiece, directory);\n                    }\n                    directory = directory.directories[pathPiece];\n                });\n            }\n\n            directory.files.push(file);\n            // reflections.sort(GroupHandler.sortCallback);\n            file.parent = directory;\n            file.reflections = reflections;\n        });\n    }\n}\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.17.7",
+  "version": "0.17.8",
   "homepage": "https://typedoc.org",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -29,7 +29,7 @@
     "minimatch": "^3.0.0",
     "progress": "^2.0.3",
     "shelljs": "^0.8.4",
-    "typedoc-default-themes": "^0.10.1"
+    "typedoc-default-themes": "^0.10.2"
   },
   "peerDependencies": {
     "typescript": ">=3.8.3"

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

@@ -1,12 +0,0 @@
-import * as ts from 'typescript';
-import { ConverterTypeComponent, TypeTypeConverter } from '../components';
-import { Context } from '../context';
-import { Type } from '../../models';
-export declare class ObjectType extends Type {
-    readonly type = "object";
-    clone(): ObjectType;
-}
-export declare class ConditionalConverter extends ConverterTypeComponent implements TypeTypeConverter<ts.ObjectType> {
-    supportsType(context: Context, type: ts.Type): boolean;
-    convertType(context: Context, type: ts.ObjectType): ObjectType | undefined;
-}

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

@@ -1,36 +0,0 @@
-"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 components_1 = require("../components");
-const models_1 = require("../../models");
-class ObjectType extends models_1.Type {
-    constructor() {
-        super(...arguments);
-        this.type = 'object';
-    }
-    clone() {
-        return new ObjectType;
-    }
-}
-exports.ObjectType = ObjectType;
-let ConditionalConverter = class ConditionalConverter extends components_1.ConverterTypeComponent {
-    supportsType(context, type) {
-        return !!(type.flags & ts.TypeFlags.Object)
-            && !!(type.objectFlags & ts.ObjectFlags.Anonymous)
-            && !type.symbol;
-    }
-    convertType(context, type) {
-        return new ObjectType;
-    }
-};
-ConditionalConverter = __decorate([
-    components_1.Component({ name: 'type:anonymous' })
-], ConditionalConverter);
-exports.ConditionalConverter = ConditionalConverter;
-//# sourceMappingURL=anonymous.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"anonymous.js","sourceRoot":"","sources":["../../../../src/lib/converter/types/anonymous.ts"],"names":[],"mappings":";;;;;;;;AAAA,iCAAiC;AAEjC,8CAAqF;AAErF,yCAAoC;AAEpC,MAAa,UAAW,SAAQ,aAAI;IAApC;;QACa,SAAI,GAAG,QAAQ,CAAA;IAK5B,CAAC;IAHG,KAAK;QACD,OAAO,IAAI,UAAU,CAAA;IACzB,CAAC;CACJ;AAND,gCAMC;AAGD,IAAa,oBAAoB,GAAjC,MAAa,oBAAqB,SAAQ,mCAAsB;IAC5D,YAAY,CAAC,OAAgB,EAAE,IAAa;QACxC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;eACpC,CAAC,CAAC,CAAE,IAAsB,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC;eAClE,CAAC,IAAI,CAAC,MAAM,CAAA;IACvB,CAAC;IAED,WAAW,CAAC,OAAgB,EAAE,IAAmB;QAC7C,OAAO,IAAI,UAAU,CAAA;IACzB,CAAC;CACJ,CAAA;AAVY,oBAAoB;IADhC,sBAAS,CAAC,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC;GACvB,oBAAoB,CAUhC;AAVY,oDAAoB","sourcesContent":["import * as ts from 'typescript';\n\nimport { Component, ConverterTypeComponent, TypeTypeConverter } from '../components';\nimport { Context } from '../context';\nimport { Type } from '../../models';\n\nexport class ObjectType extends Type {\n    readonly type = 'object'\n\n    clone() {\n        return new ObjectType\n    }\n}\n\n@Component({name: 'type:anonymous'})\nexport class ConditionalConverter extends ConverterTypeComponent implements TypeTypeConverter<ts.ObjectType> {\n    supportsType(context: Context, type: ts.Type): boolean {\n        return !!(type.flags & ts.TypeFlags.Object)\n            && !!((type as ts.ObjectType).objectFlags & ts.ObjectFlags.Anonymous)\n            && !type.symbol // No anonymous classes... not sure how to handle them yet.\n    }\n\n    convertType(context: Context, type: ts.ObjectType): ObjectType | undefined {\n        return new ObjectType\n    }\n}\n"]}

package/dist/lib/converter2/converter.d.ts

@@ -1,16 +0,0 @@
-import * as ts from 'typescript';
-export declare class BaseReflection {
-    id: number;
-    parent?: BaseReflection;
-}
-export declare class EnumReflection extends BaseReflection {
-    readonly name: string;
-    readonly members: EnumMemberReflection[];
-    constructor(name: string, members: EnumMemberReflection[]);
-}
-export declare class EnumMemberReflection extends BaseReflection {
-    readonly name: string;
-    readonly value: string | number;
-    constructor(name: string, value: string | number);
-}
-export declare function convertEnum(symbol: ts.Symbol): EnumReflection | undefined;

package/dist/lib/converter2/converter.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ts = require("typescript");
-let foo = 1;
-class BaseReflection {
-    constructor() {
-        this.id = foo++;
-    }
-}
-exports.BaseReflection = BaseReflection;
-class EnumReflection extends BaseReflection {
-    constructor(name, members) {
-        super();
-        this.name = name;
-        this.members = members;
-    }
-}
-exports.EnumReflection = EnumReflection;
-class EnumMemberReflection extends BaseReflection {
-    constructor(name, value) {
-        super();
-        this.name = name;
-        this.value = value;
-    }
-}
-exports.EnumMemberReflection = EnumMemberReflection;
-function convertEnum(symbol) {
-    var _a, _b;
-    const declarations = (_b = (_a = symbol.getDeclarations()) === null || _a === void 0 ? void 0 : _a.filter(ts.isEnumDeclaration)) !== null && _b !== void 0 ? _b : [];
-    if (!declarations.length) {
-        return;
-    }
-}
-exports.convertEnum = convertEnum;
-//# sourceMappingURL=converter.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"converter.js","sourceRoot":"","sources":["../../../src/lib/converter2/converter.ts"],"names":[],"mappings":";;AAAA,iCAAiC;AAEjC,IAAI,GAAG,GAAG,CAAC,CAAA;AAEX,MAAa,cAAc;IAA3B;QACI,OAAE,GAAG,GAAG,EAAE,CAAA;IAEd,CAAC;CAAA;AAHD,wCAGC;AAED,MAAa,cAAe,SAAQ,cAAc;IAC9C,YACa,IAAY,EACZ,OAA+B;QAExC,KAAK,EAAE,CAAC;QAHC,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAwB;IAG5C,CAAC;CACJ;AAPD,wCAOC;AAED,MAAa,oBAAqB,SAAQ,cAAc;IACpD,YACa,IAAY,EACZ,KAAsB;QAE/B,KAAK,EAAE,CAAC;QAHC,SAAI,GAAJ,IAAI,CAAQ;QACZ,UAAK,GAAL,KAAK,CAAiB;IAGnC,CAAC;CACJ;AAPD,oDAOC;AAED,SAAgB,WAAW,CAAC,MAAiB;;IACzC,MAAM,YAAY,eAAG,MAAM,CAAC,eAAe,EAAE,0CAAE,MAAM,CAAC,EAAE,CAAC,iBAAiB,oCAAK,EAAE,CAAC;IAElF,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QACtB,OAAO;KACV;AACL,CAAC;AAND,kCAMC","sourcesContent":["import * as ts from 'typescript';\n\nlet foo = 1\n\nexport class BaseReflection {\n    id = foo++\n    parent?: BaseReflection\n}\n\nexport class EnumReflection extends BaseReflection {\n    constructor(\n        readonly name: string,\n        readonly members: EnumMemberReflection[]\n    ) {\n        super();\n    }\n}\n\nexport class EnumMemberReflection extends BaseReflection {\n    constructor(\n        readonly name: string,\n        readonly value: string | number\n    ) {\n        super();\n    }\n}\n\nexport function convertEnum(symbol: ts.Symbol): EnumReflection | undefined {\n    const declarations = symbol.getDeclarations()?.filter(ts.isEnumDeclaration) ?? [];\n\n    if (!declarations.length) {\n        return;\n    }\n}\n"]}

package/dist/lib/converter2/index.js

@@ -1 +0,0 @@
-//# sourceMappingURL=index.js.map

package/dist/lib/converter2/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/converter2/index.ts"],"names":[],"mappings":"","sourcesContent":[""]}

package/dist/lib/converter2/symbols/enum.js

@@ -1 +0,0 @@
-//# sourceMappingURL=enum.js.map

package/dist/lib/converter2/symbols/enum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/lib/converter2/symbols/enum.ts"],"names":[],"mappings":"","sourcesContent":[""]}

package/dist/lib/models/types/object.d.ts

@@ -1,12 +0,0 @@
-import { Type } from './abstract';
-export interface ObjectProperty {
-    name: string;
-    type: Type;
-}
-export declare class ObjectType extends Type {
-    readonly type = "object";
-    properties: ObjectProperty[];
-    constructor(properties: ObjectProperty[]);
-    clone(): ObjectType;
-    equals(type: unknown): boolean;
-}

package/dist/lib/models/types/object.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const abstract_1 = require("./abstract");
-var ObjectPropertyFlags;
-(function (ObjectPropertyFlags) {
-    ObjectPropertyFlags[ObjectPropertyFlags["Readonly"] = 1] = "Readonly";
-    ObjectPropertyFlags[ObjectPropertyFlags["Optional"] = 2] = "Optional";
-})(ObjectPropertyFlags = exports.ObjectPropertyFlags || (exports.ObjectPropertyFlags = {}));
-class ObjectType extends abstract_1.Type {
-    constructor(properties) {
-        super();
-        this.type = 'object';
-        this.properties = properties;
-    }
-    clone() {
-        return new ObjectType(this.properties);
-    }
-    equals(type) {
-        if (!(type instanceof ObjectType)) {
-            return false;
-        }
-        return true;
-    }
-}
-exports.ObjectType = ObjectType;
-//# sourceMappingURL=object.js.map

package/dist/lib/models/types/object.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../../src/lib/models/types/object.ts"],"names":[],"mappings":";;AAAA,yCAAiC;AAEjC,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,qEAAiB,CAAA;IACjB,qEAAiB,CAAA;AACrB,CAAC,EAHW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAG9B;AAeD,MAAa,UAAW,SAAQ,eAAI;IAShC,YACI,UAA4B;QAE5B,KAAK,EAAE,CAAC;QAXH,SAAI,GAAG,QAAQ,CAAC;QAYrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,KAAK;QACD,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC1C,CAAC;IAED,MAAM,CAAC,IAAa;QAChB,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA1BD,gCA0BC","sourcesContent":["import { Type } from './abstract'\n\nexport enum ObjectPropertyFlags {\n    Readonly = 1 << 0,\n    Optional = 1 << 1\n}\n\nexport interface ObjectProperty {\n    name: string\n    type: Type\n    flags: ObjectPropertyFlags\n}\n\nexport interface Signature {\n    parameters: Parameter[]\n    typeParameters: TypeParameter[]\n    returnType: Type\n\n}\n\nexport class ObjectType extends Type {\n    readonly type = 'object';\n\n    properties: ObjectProperty[];\n    signatures: Signature[];\n    constructSignatures: Signature[];\n    stringIndexSignature?: Type;\n    numberIndexSignature?: Type;\n\n    constructor(\n        properties: ObjectProperty[],\n    ) {\n        super();\n        this.properties = properties;\n    }\n\n    clone() {\n        return new ObjectType(this.properties)\n    }\n\n    equals(type: unknown) {\n        if (!(type instanceof ObjectType)) {\n            return false;\n        }\n        return true;\n    }\n}\n"]}