[ADF-2127] Started introducing new doc tools (#2809)

lib/config/DocProcessor/docProcessor.js

@@ -0,0 +1,175 @@
+var fs = require("fs");
+var path = require("path");
+var program = require("commander");
+
+var remark = require("remark");
+var parse = require("remark-parse");
+var stringify = require("remark-stringify");
+
+/*
+var managetoc = require("./managetoc");
+var sa = require("./seealso");
+var index = require("./index");
+*/
+
+// "Aggregate" data collected over the whole file set.
+var aggData = {};
+
+var toolsFolderName = "tools";
+var configFileName = "doctool.config.json";
+
+
+function initPhase(aggData) {
+    /*
+    toolModules.seealso.initPhase(aggData);
+    toolModules.index.initPhase(aggData);
+    */
+
+    toolList.forEach(toolName => {
+        toolModules[toolName].initPhase(aggData);
+    });
+}
+
+
+function readPhase(srcFolder, filenames, aggData) {
+    for (var i = 0; i < filenames.length; i++) {
+        var pathname = path.resolve(srcFolder, filenames[i]);
+        
+        var src = fs.readFileSync(pathname);
+        var tree = remark().parse(src)
+
+        toolList.forEach(toolName => {
+            toolModules[toolName].readPhase(tree, pathname, aggData);
+        });
+
+        /*
+        toolModules.seealso.readPhase(tree, pathname, aggData);
+        toolModules.index.readPhase(tree, pathname, aggData);
+        */
+    }
+
+    //console.log(JSON.stringify(aggData.mdFileData));
+}
+
+
+function aggPhase(aggData) {
+    toolList.forEach(toolName => {
+        toolModules[toolName].aggPhase(aggData);
+    });
+
+    /*
+    toolModules.seealso.aggPhase(aggData);
+    toolModules.index.aggPhase(aggData);
+    */
+}
+
+
+function updatePhase(srcFolder, destFolder, filenames, aggData) {
+    for (var i = 0; i < filenames.length; i++) {
+        var pathname = path.resolve(srcFolder, filenames[i]);
+        
+        var src = fs.readFileSync(pathname);
+        var tree = remark().parse(src)
+
+        var modified = false;
+
+        toolList.forEach(toolName => {
+            modified |= toolModules[toolName].updatePhase(tree, pathname, aggData);
+        });
+        
+        if (modified)
+            fs.writeFileSync(path.resolve(destFolder, filenames[i]), remark().stringify(tree));
+
+        //console.log(JSON.stringify(tree));
+    }
+}
+
+
+function loadToolModules() {
+    var mods = {};
+    var toolsFolderPath = path.resolve(__dirname, toolsFolderName);
+    var modFiles = fs.readdirSync(toolsFolderPath);
+
+    for (var i = 0; i < modFiles.length; i++) {
+        var modPath = path.resolve(toolsFolderPath, modFiles[i])
+
+        if (path.extname(modPath) === ".js") {
+            var toolName = path.basename(modPath, ".js");
+            mods[toolName] = require(modPath);
+        }
+    }
+
+    return mods;
+}
+
+
+function loadToolConfig(configFilePath) {
+    var config = JSON.parse(fs.readFileSync(configFilePath));
+
+    return config.enabledTools;
+}
+
+
+program
+.usage("[options] <source> [dest]")
+.parse(process.argv);
+
+if (program.args.length === 0) {
+    console.log("Error: source argument required");
+    return 0;
+}
+
+
+var sourcePath = path.resolve(program.args[0]);
+var sourceInfo = fs.statSync(sourcePath);
+
+var destPath;
+var destInfo;
+
+if (program.args.length >= 2) {
+    destPath = path.resolve(program.args[1]);
+    destInfo = fs.statSync(sourcePath);
+} else {
+    destPath = sourcePath;
+    destInfo = sourceInfo;
+}
+
+if (sourceInfo.isDirectory() && !destInfo.isDirectory()) {
+    console.log("Error: The <dest> argument must be a directory");
+    return 0;
+}
+
+var toolModules = loadToolModules();
+var toolList = loadToolConfig(path.resolve(__dirname, configFileName));
+
+
+var files;
+
+if (sourceInfo.isDirectory()) {
+    files = fs.readdirSync(sourcePath);
+} else if (sourceInfo.isFile()) {
+    files = [ path.basename(sourcePath) ];
+    sourcePath = path.dirname(sourcePath);
+}
+
+files = files.filter(filename => 
+    (path.extname(filename) === ".md") &&
+    (filename !== "README.md")
+);
+
+//files.forEach(element => console.log(element));
+
+console.log("Initialising...");
+initPhase(aggData);
+
+console.log("Analysing Markdown files...");
+readPhase(sourcePath, files, aggData);
+
+console.log("Computing aggregate data...");
+aggPhase(aggData);
+
+console.log("Updating Markdown files...");
+updatePhase(sourcePath, destPath, files, aggData);
+
+
+