More decoupling in CliGenerateFacade

inversify.config.ts

@@ -15,6 +15,8 @@ import IDocumentationExtractor from "./src/generator/interfaces/IDocumentationEx
 import IJSDocParser from "./src/parser/interfaces/IJSDocParser";
 import JSDocParser from "./src/parser/JSDocParser";
 
+import DocumentationGenerator from "./src/generator/DocumentationGenerator";
+import IDocumentationGenerator from "./src/generator/interfaces/IDocumentationGenerator";
 import ConsoleReporter from "./src/reporter/ConsoleReporter";
 import IReporter from "./src/reporter/interfaces/IReporter";
 import IRuleValidator from "./src/validation/interfaces/IRuleValidator";
@@ -31,6 +33,7 @@ container.bind<IRuleValidator>(TYPES.IRuleValidator).to(RuleValidator);
 
 // Generator
 container.bind<IDocumentationExtractor>(TYPES.IDocumentationExtractor).to(DocumentationExtractor);
+container.bind<IDocumentationGenerator>(TYPES.IDocumentationGenerator).to(DocumentationGenerator);
 
 // Parser
 container.bind<IJSDocParser>(TYPES.IJSDocParser).to(JSDocParser);

src/cli/Cli.ts

@@ -2,7 +2,7 @@ import container from "../../inversify.config";
 import { TYPES } from "../../types";
 
 import * as program from "commander";
-import { inject } from "inversify";
+import { inject, injectable } from "inversify";
 import * as os from "os";
 import IConfigManager from "../config/interfaces/IConfigManager";
 import IReporter from "../reporter/interfaces/IReporter";
@@ -14,6 +14,7 @@ const packageJSON = require("../package.json");
 /**
  * This class is responsible for showing the CLI interface. It has a single method parse(argv).
  */
+@injectable()
 export default class Cli {
 
 	/**

src/cli/CliGenerateFacade.ts

@@ -2,14 +2,13 @@ import open = require("open");
 import * as path from "path";
 
 import { inject, injectable } from "inversify";
-import container from "../../inversify.config";
 import { TYPES } from "../../types";
 
 import IConfigManager from "../config/interfaces/IConfigManager";
 import IProjectConfig from "../config/interfaces/IProjectConfig";
 import ProjectConfig from "../config/ProjectConfig";
-import DocumentationGenerator from "../generator/DocumentationGenerator";
-import ProjectLoader from "../gm_project/ProjectLoader";
+import IDocumentationGenerator from "../generator/interfaces/IDocumentationGenerator";
+import IGMProjectLoader from "../gm_project/interfaces/IGMProjectLoader";
 import IReporter from "../reporter/interfaces/IReporter";
 import ICliGenerateFacade from "./interfaces/ICliGenerateFacade.d";
 
@@ -50,6 +49,24 @@ export default class CliGenerateFacade implements ICliGenerateFacade {
 	@inject(TYPES.IReporter)
 	private _reporter: IReporter;
 
+	/**
+	 * The GMProjectLoader
+	 */
+	@inject(TYPES.IGMProjectLoader)
+	private _loader: IGMProjectLoader;
+
+	/**
+	 * The config manager
+	 */
+	@inject(TYPES.IConfigManager)
+	private _configManager: IConfigManager;
+
+	/**
+	 * The documentation generator
+	 */
+	@inject(TYPES.IDocumentationGenerator)
+	private _documentationGenerator: IDocumentationGenerator;
+
 	/**
 	 * Generates the documentation for a given project
 	 * @param projectPath The path to the project
@@ -59,13 +76,11 @@ export default class CliGenerateFacade implements ICliGenerateFacade {
 
 		this._reporter.info("Loading Project...");
 
-		const loader = new ProjectLoader();
-		const project = await loader.load(projectPath);
+		const project = await this._loader.load(projectPath);
 
 		this._reporter.info("Loading project configuration...");
 
-		const configManager = container.get<IConfigManager>(TYPES.IConfigManager);
-		let config = await configManager.loadConfig(projectPath);
+		let config = await this._configManager.loadConfig(projectPath);
 
 		if (!config) {
 			this._reporter.info("Configuration not found. Using default configuration.");
@@ -74,8 +89,7 @@ export default class CliGenerateFacade implements ICliGenerateFacade {
 		config = this._overrideConfig(config);
 
 		this._reporter.info("Generating documentation... ");
-		const docsGenerator = new DocumentationGenerator();
-		const outFolder = await docsGenerator.generate(project, config);
+		const outFolder = await this._documentationGenerator.generate(project, config);
 
 		this._reporter.info("Ready!");
 

src/config/interfaces/IConfigManager.d.ts

@@ -1,6 +1,6 @@
 import IProjectConfig from "./IProjectConfig";
 
-export default class IConfigManager {
+export default interface IConfigManager {
 	exportConfig(outputPath: string): Promise<string>;
 	loadConfig(jsonOrProjectPath: string): Promise<IProjectConfig | undefined>;
 }

src/generator/DocumentationGenerator.ts

@@ -1,4 +1,4 @@
-import { inject } from "inversify";
+import { inject, injectable } from "inversify";
 import { TYPES } from "../../types";
 
 import * as path from "path";
@@ -14,6 +14,7 @@ import IDocProjectGenerator from "./interfaces/IDocProjectGenerator";
 /**
  * Generates the documentation.
  */
+@injectable()
 export default class DocumentationGenerator {
 
 	/**

src/generator/interfaces/IDocumentationGenerator.d.ts

@@ -0,0 +1,6 @@
+import IProjectConfig from "../../config/interfaces/IProjectConfig";
+import IGMProject from "../../gm_project/interfaces/IGMProject";
+
+export default interface IDocumentationGenerator {
+	generate(project: IGMProject, config?: IProjectConfig): Promise<string>;
+}

src/gm_project/ProjectLoader.ts

@@ -1,6 +1,7 @@
 import * as globby from "globby";
 import * as path from "path";
 
+import { injectable } from "inversify";
 import IGMProject from "../gm_project/interfaces/IGMProject";
 import GMS1ProjectLoader from "./gms1/GMS1ProjectLoader";
 import GMS2ProjectLoader from "./gms2/GMS2ProjectLoader";
@@ -9,6 +10,7 @@ import IGMProjectLoader from "./interfaces/IGMProjectLoader";
 /**
  * This Factory class loads a GMS1 or GMS2 project and returns a GMProject object
  */
+@injectable()
 export default class ProjectLoader implements IGMProjectLoader {
 
 	/**

types.ts

@@ -10,6 +10,7 @@ const TYPES = {
 	// generator
 	IDocumentationExtractor: Symbol.for("IDocumentationExtractor"),
 	IDocProjectGenerator: Symbol.for("IDocProjectGenerator"),
+	IDocumentationGenerator: Symbol.for("IDocumentationGenerator"),
 
 	// parser
 	IJSDocParser: Symbol.for("IJSDocParser"),
@@ -20,6 +21,9 @@ const TYPES = {
 	// Validation
 	IScriptValidator: Symbol.for("IScriptValidator"),
 	IRuleValidator: Symbol.for("IRuleValidator"),
+
+	// Loader
+	IGMProjectLoader: Symbol.for("IGMProjectLoader"),
 };
 
 export {TYPES};