Merge pull request MicrosoftDocs#2114 from Fogolan/tools

Add CLI interface

Author: kenwith

tools/office-cmdlet-updater/config/default.json

@@ -1,4 +1,7 @@
 {
+	"name": "Office cmdlet updater",
+	"description": "Update documentation for modules in this repository",
+	"version": "0.0.3",
 	"platyPS": {
 		"credentials": {
 			"login": "",

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

@@ -0,0 +1,61 @@
+class CliController {
+	constructor(
+		cliService,
+		cmdletService,
+		markdownController,
+		powerShellService
+	) {
+		this.cliService = cliService;
+		this.cmdletService = cmdletService;
+		this.markdownController = markdownController;
+		this.powerShellService = powerShellService;
+	}
+	start(argv) {
+		try {
+			this.startCli(argv);
+		} catch (e) {
+			this.powerShellService.dispose();
+			console.error(e.message);
+		}
+	}
+
+	startCli(argv) {
+		this.cliService.addOption({
+			option: '-m --module <module>',
+			description: 'update documentation for module',
+			defaultValue: 'all',
+			action: (cli) => {
+				const { module } = cli;
+
+				if (module === 'all') {
+					return;
+				}
+
+				this.cmdletService.ensureModuleExist(module);
+			}
+		});
+
+		this.cliService.addOption({
+			option: '-c --cmdlet <cmdet>',
+			description: 'update documentation for cmdlet in module',
+			action: (cli) => {
+				const { module, cmdlet } = cli;
+
+				if (module === 'all' && cmdlet) {
+					throw new Error('You must specify a module for cmdlet.');
+				}
+			}
+		});
+
+		this.cliService.start(argv, async (cli) => {
+			const { module, cmdlet } = cli;
+
+			await this.markdownController.updateMarkdown({
+				moduleName: module,
+				cmdlet
+			});
+		});
+	}
+}
+
+module.exports = CliController;

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, cmdlet));
 
-			if (err) {
-				this.powerShellService.dispose();
-				throw new Error(err);
+				if (err) {
+					this.powerShellService.dispose();
+					console.error(err.message);
+				}
 			}
-		});
+		);
+	}
+
+	_filterModules(doc, moduleName) {
+		if (moduleName === 'all') {
+			return true;
+		}
+
+		return doc.name === moduleName;
 	}
 }
 

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

@@ -9,6 +9,9 @@ const MarkdownController = require('../controllers/markdown.controller');
 const db = require('../db')();
 const CmdletDependenciesService = require('../services/cmdlet.dependencies.service');
 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({
@@ -22,6 +25,7 @@ module.exports = () => {
 	});
 
 	container.register({
+		cliService: awilix.asClass(CliService).singleton(),
 		mailNotificationService: awilix
 			.asClass(MailNotificationService)
 			.singleton(),
@@ -32,11 +36,13 @@ 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({
-		markdownController: awilix.asClass(MarkdownController).singleton()
+		markdownController: awilix.asClass(MarkdownController).singleton(),
+		cliController: awilix.asClass(CliController).singleton()
 	});
 
 	return container;

tools/office-cmdlet-updater/index.js

@@ -1,11 +1,5 @@
 const container = require('./helpers/di.container')();
 
-(async function() {
-	try {
-		const markdownController = container.resolve('markdownController');
+const cliController = container.resolve('cliController');
 
-		await markdownController.updateMarkdown();
-	} catch (e) {
-		console.log(e);
-	}
-})();
+cliController.start(process.argv);

tools/office-cmdlet-updater/package.json

@@ -27,6 +27,7 @@
     "await-of": "^1.1.2",
     "awilix": "^3.0.9",
     "better-queue": "^3.8.10",
+    "commander": "^2.19.0",
     "config": "^2.0.1",
     "fs-extra": "^7.0.0",
     "lowdb": "^1.0.0",

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

@@ -0,0 +1,31 @@
+const cli = require('commander');
+
+class CliService {
+	constructor(config) {
+		this.config = config;
+		this.cli = cli;
+
+		const { description, version } = config;
+
+		this.cli.version(version, '-v, --version').description(description);
+	}
+
+	addOption({
+		option,
+		description = '',
+		defaultValue = '',
+		action = () => {}
+	}) {
+		this.cli
+			.option(option, description, defaultValue)
+			.action(() => action(this.cli));
+	}
+
+	start(argv, cb = () => {}) {
+		this.cli.parse(argv);
+
+		cb(this.cli);
+	}
+}
+
+module.exports = CliService;

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;

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

@@ -31,12 +31,20 @@ class MarkdownService {
 		this.installedDependencies = [];
 	}
 
-	async updateMd(doc) {
-		return this.addMdFilesInQueue(doc);
+	async updateMd(doc, cmdlet) {
+		return this.addMdFilesInQueue(doc, cmdlet);
 	}
 
-	async addMdFilesInQueue(doc) {
-		const mdFiles = await this.fsService.getModuleFiles(doc);
+	async addMdFilesInQueue(doc, cmdlet) {
+		const mdFiles = (await this.fsService.getModuleFiles(doc)).filter(
+			(file) => this._filterCmdlets(file, cmdlet)
+		);
+
+		if (!mdFiles.length) {
+			throw new Error(
+				`Can't find cmdlet "${cmdlet}" in module "${doc.name}"`
+			);
+		}
 
 		mdFiles.forEach((file) => {
 			this.queue
@@ -46,6 +54,16 @@ class MarkdownService {
 		});
 	}
 
+	_filterCmdlets(mdPath, cmdletName) {
+		if (!cmdletName) {
+			return true;
+		}
+
+		const mdExt = '.md';
+
+		return mdPath.endsWith(`${cmdletName}${mdExt}`);
+	}
+
 	async processQueue({ file, doc }, cb) {
 		let result, err;