Generate documentation for only one module

Author: Fogolan

tools/office-cmdlet-updater/controllers/cli.controller.js

@@ -1,23 +1,35 @@
 class CliController {
-	constructor(cliService) {
+	constructor(cliService, cmdletService, markdownController) {
 		this.cliServoce = cliService;
+		this.cmdletService = cmdletService;
+		this.markdownController = markdownController;
 	}
 
 	startCli(argv) {
 		this.cliServoce.addOption({
 			option: '-m --module <module>',
 			description: 'update documentation for module',
-			defaultValue: 'all'
+			defaultValue: 'all',
+			action: (cli) => {
+				const { module } = cli;
+
+				if (module === 'all') {
+					return;
+				}
+
+				this.cmdletService.ensureModuleExist(module);
+			}
 		});
 
 		this.cliServoce.addOption({
 			option: '-c --cmdlet <cmdet>',
 			description: 'update documentation for cmdlet in module'
 		});
 
-		this.cliServoce.start(argv, (cli) => {
+		this.cliServoce.start(argv, async (cli) => {
 			const { module, cmdlet } = cli;
 
+			this.markdownController.updateMarkdown({ moduleName: module });
 			console.log(module);
 			console.log(cmdlet);
 		});

tools/office-cmdlet-updater/controllers/markdown.controller.js

@@ -9,22 +9,32 @@ class MarkdownController {
 		this.config = config;
 	}
 
-	async updateMarkdown() {
+	async updateMarkdown({ moduleName, cmdlet }) {
 		let err;
 		const { docs } = this.config.get('platyPS');
 
-		docs.forEach(async (doc) => {
-			if (!(await fs.pathExists(doc.path))) {
-				throw new Error(powerShellErrors.DOC_PATH_DOESNT_EXIST);
-			}
+		docs.filter((doc) => this._filterModules(doc, moduleName)).forEach(
+			async (doc) => {
+				if (!(await fs.pathExists(doc.path))) {
+					throw new Error(powerShellErrors.DOC_PATH_DOESNT_EXIST);
+				}
 
-			[, err] = await of(this.markdownService.updateMd(doc));
+				[, err] = await of(this.markdownService.updateMd(doc));
 
-			if (err) {
-				this.powerShellService.dispose();
-				throw new Error(err);
+				if (err) {
+					this.powerShellService.dispose();
+					throw new Error(err);
+				}
 			}
-		});
+		);
+	}
+
+	_filterModules(doc, moduleName) {
+		if (moduleName === 'all') {
+			return true;
+		}
+
+		return doc.name === moduleName;
 	}
 }
 

tools/office-cmdlet-updater/helpers/di.container.js

@@ -11,6 +11,7 @@ const CmdletDependenciesService = require('../services/cmdlet.dependencies.servi
 const FsService = require('../services/fs.service');
 const CliService = require('../services/cli.service');
 const CliController = require('../controllers/cli.controller');
+const CmdletService = require('../services/cmdlet.service');
 
 module.exports = () => {
 	const container = awilix.createContainer({
@@ -35,7 +36,8 @@ module.exports = () => {
 			.asClass(CmdletDependenciesService)
 			.singleton(),
 		fsService: awilix.asClass(FsService).singleton(),
-		markdownService: awilix.asClass(MarkdownService).singleton()
+		markdownService: awilix.asClass(MarkdownService).singleton(),
+		cmdletService: awilix.asClass(CmdletService).singleton()
 	});
 
 	container.register({

tools/office-cmdlet-updater/services/cli.service.js

@@ -16,7 +16,9 @@ class CliService {
 		defaultValue = '',
 		action = () => {}
 	}) {
-		this.cli.option(option, description, defaultValue).action(action);
+		this.cli
+			.option(option, description, defaultValue)
+			.action(() => action(this.cli));
 	}
 
 	start(argv, cb = () => {}) {

tools/office-cmdlet-updater/services/cmdlet.service.js

@@ -0,0 +1,17 @@
+class CmdletService {
+	constructor(config) {
+		this.config = config;
+	}
+
+	ensureModuleExist(moduleName) {
+		const modules = this.config.get('platyPS.docs');
+
+		const isExist = modules.find(({ name }) => name === moduleName);
+
+		if (!isExist) {
+			throw new Error(`Module with name "${moduleName}" didn't exist`);
+		}
+	}
+}
+
+module.exports = CmdletService;