hdoc-tools 0.19.7 → 0.20.0

package/hdoc-init.js

@@ -1,147 +1,181 @@
-(function () {
-    'use strict';
-
-    // Required modules
-    const prompt = require('prompt');
-    const fs = require('fs-extra');
-    const path = require('path');
-
-    // Configure prompt module preferences
-    prompt.message = false;
-    const promptProps = [{
-        name: 'id',
-        description: 'Document ID',
-        validator: /^[a-z][a-z0-9-]+[a-z0-9]$/,
-        warning: 'Document ID must only contain lower case letters, decimal digits and dashes.',
-        required: true
-    },
-    {
-        name: 'title',
-        description: 'Title',
-        required: true
-    },
-    {
-        name: 'description',
-        description: 'Description',
-        required: true
-    },
-    {
-        name: 'version',
-        description: 'Initial Version',
-        validator: /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$/,
-        warning: 'Version must formatted using semantic versioning - major.minor.patch, eg: 0.1.2',
-        required: true
-    },
-    {
-        name: 'author',
-        description: 'Package Author',
-        required: true
-    }
-    ];
-
-    const createBook = function (server_path, source_path, docProps) {
-        console.log('\r\nCreating book with the following properties:\r\n');
-        console.log('           Doc ID:', docProps.id);
-        console.log('            Title:', docProps.title);
-        console.log('      Description:', docProps.description);
-        console.log('           Author:', docProps.author);
-        console.log('  Initial Version:', docProps.version, '\r\n');
-
-        // Now copy files over
-        const templatePath = path.join(server_path, 'templates', 'init');
-        console.log('Copying template from:', templatePath);
-
-        if (fs.existsSync(templatePath)) {
-            // If template path exists, do sync copy into book path
-            try {
-                fs.copySync(templatePath, source_path);
-            } catch (e) {
-                console.error('Error copying template:\r\n', e);
-                process.exit(1);
-            }
-
-            // Rename _hdocbook folder to docId, sync as we need to wait 
-            // until this in complete for the next tasks to be successful
-            const bookContentRoot = path.join(source_path, docProps.id);
-            try {
-                fs.renameSync(path.join(source_path, '_hdocbook'), bookContentRoot);
-            } catch (e) {
-                console.error('Error renaming template folder:\r\n', e);
-                process.exit(1);
-            }
-
-            // Update hdocbook-project.json
-            const hdocBookProjectFilePath = path.join(source_path, 'hdocbook-project.json');
-            const hdocBookProjectFile = require(hdocBookProjectFilePath);
-            hdocBookProjectFile.docId = docProps.id;
-            fs.writeFile(hdocBookProjectFilePath, JSON.stringify(hdocBookProjectFile, null, 2), function writeJSON(err) {
-                if (err) return console.error('Error updating:', hdocBookProjectFilePath, '\r\n', err);
-                console.log('Updated:', hdocBookProjectFilePath);
-            });
-
-            // Update root/hdocbook.json
-            const hdocBookFilePath = path.join(bookContentRoot, 'hdocbook.json');
-            const hdocbookFile = require(hdocBookFilePath);
-            hdocbookFile.docId = docProps.id;
-            hdocbookFile.title = docProps.title;
-            hdocbookFile.description = docProps.description;
-            hdocbookFile.version = docProps.version;
-            hdocbookFile.publicSource = `https://github.com/Hornbill-Docs/${docProps.id}`;
-            hdocbookFile.navigation.items[0].items = [{
-                "text": "Welcome",
-                "link": docProps.id + '/index'
-            }];
-            fs.writeFile(hdocBookFilePath, JSON.stringify(hdocbookFile, null, 2), function writeJSON(err) {
-                if (err) return console.error('Error updating:', hdocBookFilePath, '\r\n', err);
-                console.log('Updated:', hdocBookFilePath);
-            });
-
-            // Update package.json
-            const packageFilePath = path.join(source_path, 'package.json');
-            const packageFile = require(packageFilePath);
-            packageFile.name = docProps.id;
-            packageFile.version = docProps.version;
-            hdocbookFile.description = docProps.description;
-            hdocbookFile.version = docProps.version;
-            hdocbookFile.author = docProps.author;
-            fs.writeFile(packageFilePath, JSON.stringify(packageFile, null, 2), function writeJSON(err) {
-                if (err) return console.error('Error updating:', packageFilePath, '\r\n', err);
-                console.log('Updated:', packageFilePath);
-            });
-
-            // Rename gitignore to .gitignore
-            const gitignorePath = path.join(source_path, 'gitignore');
-            const newGitignorePath = path.join(source_path, '.gitignore');
-            fs.renameSync(gitignorePath, newGitignorePath);
-
-        } else {
-            console.error('Template path does not exist:', templatePath);
-            process.exit(1);
-        }
-    };
-
-    exports.run = function (server_path, source_path, md) {
-        // GERRY: The init function should create a new starting point HDocBook folder structure
-        // ready to run the preview server and start editing. 
-        //
-        // The init function should prompt for the ID of the doc book, title and initial version, then
-        // create the required files and folders.  Its possible to just create a template and copy
-        // those files into place, with a few variable replacements.  
-
-        console.log('Hornbill HDocBook Init', '\r\n');
-
-        const curr_dirs = source_path.split(path.sep);
-        let doc_id = curr_dirs[curr_dirs.length - 1];
-
-        prompt.start();
-        promptProps[0].default = doc_id;
-        prompt.get(promptProps, function (err, result) {
-            if (err) {
-                console.error(err);
-                return err;
-            }
-            createBook(server_path, source_path, result);
-        });
-
-    };
-})();
+(() => {
+	// Required modules
+	const prompt = require("prompt");
+	const fs = require("fs-extra");
+	const path = require("node:path");
+
+	// Configure prompt module preferences
+	prompt.message = false;
+	const promptProps = [
+		{
+			name: "id",
+			description: "Document ID",
+			validator: /^[a-z][a-z0-9-]+[a-z0-9]$/,
+			warning:
+				"Document ID must only contain lower case letters, decimal digits and dashes.",
+			required: true,
+		},
+		{
+			name: "title",
+			description: "Title",
+			required: true,
+		},
+		{
+			name: "description",
+			description: "Description",
+			required: true,
+		},
+		{
+			name: "version",
+			description: "Initial Version",
+			validator: /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$/,
+			warning:
+				"Version must formatted using semantic versioning - major.minor.patch, eg: 0.1.2",
+			required: true,
+		},
+		{
+			name: "author",
+			description: "Package Author",
+			required: true,
+		},
+	];
+
+	const createBook = (server_path, source_path, docProps) => {
+		console.log("\r\nCreating book with the following properties:\r\n");
+		console.log("           Doc ID:", docProps.id);
+		console.log("            Title:", docProps.title);
+		console.log("      Description:", docProps.description);
+		console.log("           Author:", docProps.author);
+		console.log("  Initial Version:", docProps.version, "\r\n");
+
+		// Now copy files over
+		const templatePath = path.join(server_path, "templates", "init");
+		console.log("Copying template from:", templatePath);
+
+		if (fs.existsSync(templatePath)) {
+			// If template path exists, do sync copy into book path
+			try {
+				fs.copySync(templatePath, source_path);
+			} catch (e) {
+				console.error("Error copying template:\r\n", e);
+				process.exit(1);
+			}
+
+			// Rename _hdocbook folder to docId, sync as we need to wait
+			// until this in complete for the next tasks to be successful
+			const bookContentRoot = path.join(source_path, docProps.id);
+			try {
+				fs.renameSync(path.join(source_path, "_hdocbook"), bookContentRoot);
+			} catch (e) {
+				console.error("Error renaming template folder:\r\n", e);
+				process.exit(1);
+			}
+
+			// Update hdocbook-project.json
+			const hdocBookProjectFilePath = path.join(
+				source_path,
+				"hdocbook-project.json",
+			);
+			const hdocBookProjectFile = require(hdocBookProjectFilePath);
+			hdocBookProjectFile.docId = docProps.id;
+			fs.writeFile(
+				hdocBookProjectFilePath,
+				JSON.stringify(hdocBookProjectFile, null, 2),
+				function writeJSON(err) {
+					if (err)
+						return console.error(
+							"Error updating:",
+							hdocBookProjectFilePath,
+							"\r\n",
+							err,
+						);
+					console.log("Updated:", hdocBookProjectFilePath);
+				},
+			);
+
+			// Update root/hdocbook.json
+			const hdocBookFilePath = path.join(bookContentRoot, "hdocbook.json");
+			const hdocbookFile = require(hdocBookFilePath);
+			hdocbookFile.docId = docProps.id;
+			hdocbookFile.title = docProps.title;
+			hdocbookFile.description = docProps.description;
+			hdocbookFile.version = docProps.version;
+			hdocbookFile.publicSource = `https://github.com/Hornbill-Docs/${docProps.id}`;
+			hdocbookFile.navigation.items[0].items = [
+				{
+					text: "Welcome",
+					link: `${docProps.id}/index`,
+				},
+			];
+			fs.writeFile(
+				hdocBookFilePath,
+				JSON.stringify(hdocbookFile, null, 2),
+				function writeJSON(err) {
+					if (err)
+						return console.error(
+							"Error updating:",
+							hdocBookFilePath,
+							"\r\n",
+							err,
+						);
+					console.log("Updated:", hdocBookFilePath);
+				},
+			);
+
+			// Update package.json
+			const packageFilePath = path.join(source_path, "package.json");
+			const packageFile = require(packageFilePath);
+			packageFile.name = docProps.id;
+			packageFile.version = docProps.version;
+			hdocbookFile.description = docProps.description;
+			hdocbookFile.version = docProps.version;
+			hdocbookFile.author = docProps.author;
+			fs.writeFile(
+				packageFilePath,
+				JSON.stringify(packageFile, null, 2),
+				function writeJSON(err) {
+					if (err)
+						return console.error(
+							"Error updating:",
+							packageFilePath,
+							"\r\n",
+							err,
+						);
+					console.log("Updated:", packageFilePath);
+				},
+			);
+
+			// Rename gitignore to .gitignore
+			const gitignorePath = path.join(source_path, "gitignore");
+			const newGitignorePath = path.join(source_path, ".gitignore");
+			fs.renameSync(gitignorePath, newGitignorePath);
+		} else {
+			console.error("Template path does not exist:", templatePath);
+			process.exit(1);
+		}
+	};
+
+	exports.run = (server_path, source_path, md) => {
+		// GERRY: The init function should create a new starting point HDocBook folder structure
+		// ready to run the preview server and start editing.
+		//
+		// The init function should prompt for the ID of the doc book, title and initial version, then
+		// create the required files and folders.  Its possible to just create a template and copy
+		// those files into place, with a few variable replacements.
+
+		console.log("Hornbill HDocBook Init", "\r\n");
+
+		const curr_dirs = source_path.split(path.sep);
+		const doc_id = curr_dirs[curr_dirs.length - 1];
+
+		prompt.start();
+		promptProps[0].default = doc_id;
+		prompt.get(promptProps, (err, result) => {
+			if (err) {
+				console.error(err);
+				return err;
+			}
+			createBook(server_path, source_path, result);
+		});
+	};
+})();