[ADF-2969] Moved doc tools to new tools folder (#3314)

* [ADF-2969] Moved doc tools to new tools folder * [ADF-2969] Added files missing from schematic * [ADF-2969] Added missing files to schematic
2025-07-24 17:32:15 +00:00 · 2018-05-11 14:01:19 +01:00
parent 9d0ccff189
commit 60644d9917
43 changed files with 843 additions and 23 deletions
--- a/tools/doc/docProcessor.js
+++ b/tools/doc/docProcessor.js
@@ -0,0 +1,186 @@
+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 frontMatter = require("remark-frontmatter");
+
+
+// "Aggregate" data collected over the whole file set.
+var aggData = {};
+
+var toolsFolderName = "tools";
+var configFileName = "doctool.config.json";
+var defaultFolder = path.resolve("docs");
+
+
+function initPhase(aggData) {
+    toolList.forEach(toolName => {
+        toolModules[toolName].initPhase(aggData);
+    });
+}
+
+
+function readPhase(filenames, aggData) {
+    for (var i = 0; i < filenames.length; i++) {
+        var pathname = filenames[i];//path.resolve(srcFolder, filenames[i]);
+        
+        var src = fs.readFileSync(pathname);
+        var tree = remark().use(frontMatter, ["yaml"]).parse(src);
+
+        toolList.forEach(toolName => {
+            toolModules[toolName].readPhase(tree, pathname, aggData);
+        });
+    }
+
+    //console.log(JSON.stringify(aggData.mdFileData));
+}
+
+
+function aggPhase(aggData) {
+    toolList.forEach(toolName => {
+        toolModules[toolName].aggPhase(aggData);
+    });
+}
+
+
+function updatePhase(filenames, aggData) {
+    var errorMessages;
+
+    for (var i = 0; i < filenames.length; i++) {
+        errorMessages = [];
+        var pathname = filenames[i]; // path.resolve(srcFolder, filenames[i]);
+        
+        var src = fs.readFileSync(pathname);
+        var tree = remark().use(frontMatter, ["yaml"]).parse(src)
+
+        var modified = false;
+
+        toolList.forEach(toolName => {
+            modified |= toolModules[toolName].updatePhase(tree, pathname, aggData, errorMessages);
+        });
+        
+        if (errorMessages.length > 0) {
+            showErrors(pathname, errorMessages);
+        }
+
+        if (modified)
+            fs.writeFileSync(filenames[i], remark().use(frontMatter, {type: 'yaml', fence: '---'}).data("settings", {paddedTable: false, gfm: false}).stringify(tree));
+        
+        //console.log(JSON.stringify(tree));
+    }
+}
+
+
+function showErrors(filename, errorMessages) {
+    console.log(filename);
+
+    errorMessages.forEach(message => {
+        console.log("    " + message);
+    });
+
+    console.log("");
+}
+
+
+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 loadConfig() {
+    var configFilePath = path.resolve(__dirname, configFileName)
+    return JSON.parse(fs.readFileSync(configFilePath));
+}
+
+
+function getAllDocFilePaths(docFolder, files) {
+    var items = fs.readdirSync(docFolder);
+
+    for (var i = 0; i < items.length; i++) {
+        var itemPath = path.resolve(docFolder, items[i]);
+        var itemInfo = fs.statSync(itemPath);
+
+        if (itemInfo.isFile()){
+            files.push(itemPath);
+        } else if (itemInfo.isDirectory()) {
+            getAllDocFilePaths(itemPath, files);
+        }
+    }
+}
+
+
+program
+.usage("[options] <source>")
+.option("-p, --profile [profileName]", "Select named config profile", "default")
+.parse(process.argv);
+
+var sourcePath;
+
+if (program.args.length === 0) {
+    sourcePath = defaultFolder;
+} else {
+    sourcePath = path.resolve(program.args[0]);
+}
+
+var sourceInfo = fs.statSync(sourcePath);
+
+var toolModules = loadToolModules();
+
+var config = loadConfig();
+
+var toolList;
+
+if (config.profiles[program.profile]){
+    toolList = config.profiles[program.profile];
+    var toolListText = toolList.join(", ");
+    console.log(`Using '${program.profile}' profile: ${toolListText}`);
+} else {
+    console.log(`Aborting: unknown profile '${program.profile}`);
+    return 0;
+}
+
+var files = [];
+
+if (sourceInfo.isDirectory()) {
+    getAllDocFilePaths(sourcePath, files);
+} else if (sourceInfo.isFile()) {
+    files = [ 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(files, aggData);
+
+console.log("Computing aggregate data...");
+aggPhase(aggData);
+
+console.log("Updating Markdown files...");
+updatePhase(files, aggData);
+
+
+