Add index to utils

Author: sebastian-lenz

lib/application.js

@@ -25,37 +25,35 @@ var Path = require("path");
 var FS = require("fs");
 var typescript = require("typescript");
 var minimatch_1 = require("minimatch");
-var loggers_1 = require("./utils/loggers");
-var fs_1 = require("./utils/fs");
-var index_1 = require("./models/index");
-var index_2 = require("./converter/index");
+var index_1 = require("./converter/index");
 var renderer_1 = require("./output/renderer");
+var index_2 = require("./models/index");
+var index_3 = require("./utils/index");
 var component_1 = require("./utils/component");
-var index_3 = require("./utils/options/index");
+var index_4 = require("./utils/options/index");
 var declaration_1 = require("./utils/options/declaration");
-var plugins_1 = require("./utils/plugins");
 var Application = (function (_super) {
     __extends(Application, _super);
     function Application(options) {
         _super.call(this, null);
-        this.logger = new loggers_1.ConsoleLogger();
-        this.converter = this.addComponent('converter', index_2.Converter);
+        this.logger = new index_3.ConsoleLogger();
+        this.converter = this.addComponent('converter', index_1.Converter);
         this.renderer = this.addComponent('renderer', renderer_1.Renderer);
-        this.plugins = this.addComponent('plugins', plugins_1.Plugins);
-        this.options = this.addComponent('options', index_3.Options);
+        this.plugins = this.addComponent('plugins', index_3.PluginHost);
+        this.options = this.addComponent('options', index_4.Options);
         this.bootstrap(options);
     }
     Application.prototype.bootstrap = function (options) {
-        this.options.read(options, index_3.OptionsReadMode.Prefetch);
+        this.options.read(options, index_4.OptionsReadMode.Prefetch);
         var logger = this.loggerType;
         if (typeof logger == 'function') {
-            this.logger = new loggers_1.CallbackLogger(logger);
+            this.logger = new index_3.CallbackLogger(logger);
         }
         else if (logger == 'none') {
-            this.logger = new loggers_1.Logger();
+            this.logger = new index_3.Logger();
         }
         this.plugins.load();
-        return this.options.read(options, index_3.OptionsReadMode.Fetch);
+        return this.options.read(options, index_4.OptionsReadMode.Fetch);
     };
     Object.defineProperty(Application.prototype, "application", {
         get: function () {
@@ -97,7 +95,7 @@ var Application = (function (_super) {
         }
     };
     Application.prototype.generateDocs = function (input, out) {
-        var project = input instanceof index_1.ProjectReflection ? input : this.convert(input);
+        var project = input instanceof index_2.ProjectReflection ? input : this.convert(input);
         if (!project)
             return false;
         out = Path.resolve(out);
@@ -111,11 +109,11 @@ var Application = (function (_super) {
         return true;
     };
     Application.prototype.generateJson = function (input, out) {
-        var project = input instanceof index_1.ProjectReflection ? input : this.convert(input);
+        var project = input instanceof index_2.ProjectReflection ? input : this.convert(input);
         if (!project)
             return false;
         out = Path.resolve(out);
-        fs_1.writeFile(out, JSON.stringify(project.toObject(), null, '\t'), false);
+        index_3.writeFile(out, JSON.stringify(project.toObject(), null, '\t'), false);
         this.logger.success('JSON written to %s', out);
         return true;
     };

lib/utils/index.js

@@ -0,0 +1,20 @@
+var component_1 = require("./component");
+exports.Component = component_1.Component;
+exports.Option = component_1.Option;
+exports.AbstractComponent = component_1.AbstractComponent;
+exports.ChildableComponent = component_1.ChildableComponent;
+var events_1 = require("./events");
+exports.Event = events_1.Event;
+exports.EventDispatcher = events_1.EventDispatcher;
+var fs_1 = require("./fs");
+exports.normalizePath = fs_1.normalizePath;
+exports.directoryExists = fs_1.directoryExists;
+exports.ensureDirectoriesExist = fs_1.ensureDirectoriesExist;
+exports.writeFile = fs_1.writeFile;
+var loggers_1 = require("./loggers");
+exports.Logger = loggers_1.Logger;
+exports.LogLevel = loggers_1.LogLevel;
+exports.ConsoleLogger = loggers_1.ConsoleLogger;
+exports.CallbackLogger = loggers_1.CallbackLogger;
+var plugins_1 = require("./plugins");
+exports.PluginHost = plugins_1.PluginHost;

lib/utils/loggers.js

@@ -13,11 +13,6 @@ var Util = require("util");
     LogLevel[LogLevel["Success"] = 4] = "Success";
 })(exports.LogLevel || (exports.LogLevel = {}));
 var LogLevel = exports.LogLevel;
-(function (LoggerType) {
-    LoggerType[LoggerType["None"] = 0] = "None";
-    LoggerType[LoggerType["Console"] = 1] = "Console";
-})(exports.LoggerType || (exports.LoggerType = {}));
-var LoggerType = exports.LoggerType;
 var Logger = (function () {
     function Logger() {
         this.errorCount = 0;

lib/utils/plugins.js

@@ -19,12 +19,12 @@ var Path = require("path");
 var Util = require("util");
 var component_1 = require("./component");
 var declaration_1 = require("./options/declaration");
-var Plugins = (function (_super) {
-    __extends(Plugins, _super);
-    function Plugins() {
+var PluginHost = (function (_super) {
+    __extends(PluginHost, _super);
+    function PluginHost() {
         _super.apply(this, arguments);
     }
-    Plugins.prototype.load = function () {
+    PluginHost.prototype.load = function () {
         var logger = this.application.logger;
         var plugins = this.plugins || this.discoverNpmPlugins();
         var i, c = plugins.length;
@@ -56,7 +56,7 @@ var Plugins = (function (_super) {
             }
         }
     };
-    Plugins.prototype.discoverNpmPlugins = function () {
+    PluginHost.prototype.discoverNpmPlugins = function () {
         var result = [];
         var logger = this.application.logger;
         discover();
@@ -116,11 +116,11 @@ var Plugins = (function (_super) {
             isArray: true
         }), 
         __metadata('design:type', Array)
-    ], Plugins.prototype, "plugins");
-    Plugins = __decorate([
-        component_1.Component({ name: 'plugins', internal: true }), 
+    ], PluginHost.prototype, "plugins");
+    PluginHost = __decorate([
+        component_1.Component({ name: 'plugin-host', internal: true }), 
         __metadata('design:paramtypes', [])
-    ], Plugins);
-    return Plugins;
+    ], PluginHost);
+    return PluginHost;
 })(component_1.AbstractComponent);
-exports.Plugins = Plugins;
+exports.PluginHost = PluginHost;

src/lib/application.ts

@@ -12,16 +12,14 @@ import * as Util from "util";
 import * as typescript from "typescript";
 import {Minimatch, IMinimatch} from "minimatch";
 
-import {EventDispatcher} from "./utils/events";
-import {Logger, LoggerType, ConsoleLogger, CallbackLogger} from "./utils/loggers";
-import {writeFile} from "./utils/fs";
-import {ProjectReflection} from "./models/index";
 import {Converter} from "./converter/index";
 import {Renderer} from "./output/renderer";
+import {ProjectReflection} from "./models/index";
+import {Logger, ConsoleLogger, CallbackLogger, PluginHost, writeFile} from "./utils/index";
+
 import {AbstractComponent, ChildableComponent, Component, Option} from "./utils/component";
 import {Options, OptionsReadMode, IOptionsReadResult} from "./utils/options/index"
 import {ParameterType} from "./utils/options/declaration";
-import {Plugins} from "./utils/plugins";
 
 
 /**
@@ -58,7 +56,7 @@ export class Application extends ChildableComponent<Application, AbstractCompone
      */
     logger:Logger;
 
-    plugins:Plugins;
+    plugins:PluginHost;
 
     @Option({
         name: 'logger',
@@ -100,7 +98,7 @@ export class Application extends ChildableComponent<Application, AbstractCompone
         this.logger    = new ConsoleLogger();
         this.converter = this.addComponent('converter', Converter);
         this.renderer  = this.addComponent('renderer', Renderer);
-        this.plugins   = this.addComponent('plugins', Plugins);
+        this.plugins   = this.addComponent('plugins', PluginHost);
         this.options   = this.addComponent('options', Options);
 
         this.bootstrap(options);

src/lib/utils/index.ts

@@ -0,0 +1,5 @@
+export {Component, Option, AbstractComponent, ChildableComponent} from "./component";
+export {Event, EventDispatcher} from "./events";
+export {normalizePath, directoryExists, ensureDirectoriesExist, writeFile} from "./fs";
+export {Logger, LogLevel, ConsoleLogger, CallbackLogger} from "./loggers";
+export {PluginHost} from "./plugins";

src/lib/utils/loggers.ts

@@ -14,12 +14,6 @@ export enum LogLevel {
 }
 
 
-export enum LoggerType {
-    None,
-    Console
-}
-
-
 /**
  * A logger that will not produce any output.
  *

src/lib/utils/plugins.ts

@@ -7,8 +7,8 @@ import {AbstractComponent, Component, Option} from "./component";
 import {ParameterType} from "./options/declaration";
 
 
-@Component({name:'plugins', internal:true})
-export class Plugins extends AbstractComponent<Application>
+@Component({name:'plugin-host', internal:true})
+export class PluginHost extends AbstractComponent<Application>
 {
     @Option({
         name: 'plugin',

tsconfig.json

@@ -112,8 +112,6 @@
         "./src/lib/models/types/type-parameter.ts",
         "./src/lib/models/types/union.ts",
         "./src/lib/models/types/unknown.ts",
-        "./src/lib/output/_renderer.ts",
-        "./src/lib/output/_theme.ts",
         "./src/lib/output/components.ts",
         "./src/lib/output/events.ts",
         "./src/lib/output/models/NavigationItem.ts",
@@ -128,11 +126,14 @@
         "./src/lib/output/plugins/PrettyPrintPlugin.ts",
         "./src/lib/output/plugins/TocPlugin.ts",
         "./src/lib/output/plugins/index.ts",
+        "./src/lib/output/renderer.ts",
+        "./src/lib/output/theme.ts",
         "./src/lib/output/themes/DefaultTheme.ts",
         "./src/lib/output/themes/MinimalTheme.ts",
         "./src/lib/utils/component.ts",
         "./src/lib/utils/events.ts",
         "./src/lib/utils/fs.ts",
+        "./src/lib/utils/index.ts",
         "./src/lib/utils/loggers.ts",
         "./src/lib/utils/options/declaration.ts",
         "./src/lib/utils/options/help.ts",