[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/reviewChecker.js
+++ b/tools/doc/reviewChecker.js
@@ -0,0 +1,103 @@
+"use strict";
+exports.__esModule = true;
+var path = require("path");
+var fs = require("fs");
+var process = require("process");
+var graphql_request_1 = require("graphql-request");
+var remark = require("remark");
+var frontMatter = require("remark-frontmatter");
+var yaml = require("js-yaml");
+var moment = require("moment");
+var Rx_1 = require("rxjs/Rx");
+var libsearch = require("./libsearch");
+var stoplist_1 = require("./stoplist");
+var adf20StartDate = "2017-11-20";
+var commitWeight = 0.1;
+var scoreTimeBase = 60;
+var rootFolder = ".";
+var stoplistFilePath = path.resolve("..", "tools", "doc", "commitStoplist.json");
+var angFilePattern = /(component)|(directive)|(model)|(pipe)|(service)|(widget)/;
+var srcData = {};
+var stoplist = new stoplist_1.Stoplist(stoplistFilePath);
+var docsFolderPath = path.resolve("..", "docs");
+var libFolders = ["core", "content-services", "process-services", "insights"];
+libsearch(srcData, path.resolve(rootFolder));
+/*
+let keys = Object.keys(srcData);
+
+for (let i = 0; i < keys.length; i++) {
+  console.log(keys[i]);
+}
+*/
+var authToken = process.env.graphAuthToken;
+var client = new graphql_request_1.GraphQLClient('https://api.github.com/graphql', {
+    headers: {
+        Authorization: 'Bearer ' + authToken
+    }
+});
+var query = "query commitHistory($path: String) {\n  repository(name: \"alfresco-ng2-components\", owner: \"alfresco\") {\n    ref(qualifiedName: \"development\") {\n      target {\n        ... on Commit {\n          history(first: 15, path: $path) {\n            nodes {\n              pushedDate\n              message\n            }\n          }\n        }\n      }\n    }\n  }\n}";
+var docFiles = getDocFilePaths(docsFolderPath);
+var docNames = Rx_1.Observable.from(docFiles);
+console.log("'Name','Review date','Commits since review','Score'");
+docNames.subscribe(function (x) {
+    var key = path.basename(x, ".md");
+    if (!srcData[key])
+        return;
+    var vars = {
+        "path": "lib/" + srcData[key].path
+    };
+    client.request(query, vars).then(function (data) {
+        var nodes = data["repository"].ref.target.history.nodes;
+        var lastReviewDate = getDocReviewDate(x); //(key + ".md");
+        var numUsefulCommits = extractCommitInfo(nodes, lastReviewDate, stoplist);
+        var dateString = lastReviewDate.format("YYYY-MM-DD");
+        var score = priorityScore(lastReviewDate, numUsefulCommits).toPrecision(3);
+        console.log("'" + key + "','" + dateString + "','" + numUsefulCommits + "','" + score + "'");
+    });
+});
+function priorityScore(reviewDate, numCommits) {
+    var daysSinceReview = moment().diff(reviewDate, 'days');
+    var commitScore = 2 + numCommits * commitWeight;
+    return Math.pow(commitScore, daysSinceReview / scoreTimeBase);
+}
+function getDocReviewDate(docFileName) {
+    var mdFilePath = path.resolve(docsFolderPath, docFileName);
+    var mdText = fs.readFileSync(mdFilePath);
+    var tree = remark().use(frontMatter, ["yaml"]).parse(mdText);
+    var lastReviewDate = moment(adf20StartDate);
+    if (tree.children[0].type == "yaml") {
+        var metadata = yaml.load(tree.children[0].value);
+        if (metadata["Last reviewed"])
+            lastReviewDate = moment(metadata["Last reviewed"]);
+    }
+    return lastReviewDate;
+}
+function extractCommitInfo(commitNodes, cutOffDate, stoplist) {
+    var numUsefulCommits = 0;
+    commitNodes.forEach(function (element) {
+        if (!stoplist.isRejected(element.message)) {
+            var abbr = element.message.substr(0, 15);
+            var commitDate = moment(element.pushedDate);
+            if (commitDate.isAfter(cutOffDate)) {
+                numUsefulCommits++;
+            }
+        }
+    });
+    return numUsefulCommits;
+}
+function getDocFilePaths(folderPath) {
+    var result = [];
+    libFolders.forEach(function (element) {
+        var libPath = path.resolve(folderPath, element);
+        var files = fs.readdirSync(libPath);
+        files = files.filter(function (filename) {
+            return (path.extname(filename) === ".md") &&
+                (filename !== "README.md") &&
+                (filename.match(angFilePattern));
+        });
+        files.forEach(function (element) {
+            result.push(path.join(libPath, element));
+        });
+    });
+    return result;
+}