markdown checker

tools/markdown-checker/.gitignore

@@ -0,0 +1,20 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# environment variables
+.env
+.env.test
+*/node_modules/*
+yarn.lock
+
+#chunks 
+.DS_Store
+.cache
+
+# packages
+node_modules/
+*/node_modules/*

tools/markdown-checker/README.md

@@ -0,0 +1,29 @@
+### MarkdownChecker
+a script that generates a JSON file from the markdown which contains status of proposals.   
+
+#### modules
+this script consist of three main stage like other compilers have
+- parser
+- analyzer
+- transformer
+- generator
+
+##### Parser
+- **_readMarkdown_** : `string`
+  - source file will be parsed as an AST
+- **_parseToAST_** : `object`
+  - an AST representation of the markdown
+
+##### Analyzer
+- **_collectLinkDefinitions_** : `object`
+  - detects all link definitions declared from bottom of the markdown file and returns these definitions
+- **_detectTables_** : `object`
+  - extracts all of the tables from the markdown and returns it as a tree
+- **_detectHeaders_** : `object`
+  - extracts all of the row from the table nodes and returns it as a tree
+
+##### Transformer
+- **_traverser_** 
+  - takes current node as an input if it has an children nodes then applies the logic with given callback functions and returns something declared in the callback function
+
+##### Generator

tools/markdown-checker/config.json

@@ -0,0 +1,3 @@
+{
+    "stage3":"./../../../../README.md"
+}

tools/markdown-checker/index.js

@@ -0,0 +1,14 @@
+const readMarkdown = require("./lib/parser/readMarkdown");
+const parseToAST = require("./lib/parser/parseToAst");
+const collectLinkDefinitions = require("./lib/analyzer/collectLinkDefinitions");
+const tableAnalyzer = require("./lib/analyzer/analyzeTable");
+const config = require("./config.json");
+
+function processStage3({ stage3 } = config) {
+  const markdownStage3 = readMarkdown(stage3);
+  const parsedFile = parseToAST(markdownStage3);
+  const collectedLinkDefinitions = collectLinkDefinitions(parsedFile);
+  const tableStage1 = tableAnalyzer(parsedFile, collectedLinkDefinitions);
+}
+
+processStage3();

tools/markdown-checker/lib/analyzer/analyzeTable.js

@@ -0,0 +1,20 @@
+/**
+ * @todo inspect below and decide
+ * @template [https://jsoneditoronline.org/?id=f1ce5803d66149d5bc86d0d53ffb40c0]
+ *
+ */
+
+const detectTables = require("./detectTables");
+const detectHeader = require("./detectHeaders");
+
+/**
+ *
+ * @param {Object} node - current node of the parsed AST
+ * @param {Object} linkDefinitions - represents all of the link shortcuts
+ */
+
+module.exports = function generateTable(node, linkDefinitions) {
+  const table = node.children && detectTables(node);
+  const rows =
+    table && table.children && detectHeader(table);
+};

tools/markdown-checker/lib/analyzer/collectLinkDefinitions.js

@@ -0,0 +1,15 @@
+/**
+ * @param {Object} AST
+ * @returns {Object} - collected link definitions
+ */
+module.exports = function(AST) {
+    let definitions = {};
+    AST.children.forEach(node => {
+      if (node.type === "definition") {
+        let label = node.label;
+        definitions[label] = node.url;
+      }
+    });
+    return definitions;
+  };
+

tools/markdown-checker/lib/analyzer/detectHeaders.js

@@ -0,0 +1,10 @@
+const traverseChildren = require("./../transformer/traverser").traverseChildren;
+/**
+ * @param {Object} tableRow
+ * @returns {Object} - collected header template 
+ */
+module.exports = function detectHeaders(tableRow) {
+  let cellSize = tableRow.align.length;
+  let [headerNode] =  tableRow.children;
+  //create header template here
+};

tools/markdown-checker/lib/analyzer/detectTables.js

@@ -0,0 +1,14 @@
+/**
+ * @param {Object} node - Parsed markdown file an AST Object
+ * @returns {Array} - contains detected table nodes of the AST   
+ */
+module.exports = function detectTables(node) {
+  let tables = [];
+  for (let i = 0; i < node.children.length; i++) {
+    const currentNode = node.children[i];
+    if (currentNode["type"] && currentNode["type"] === "table") {
+      tables.push(currentNode)
+    }
+  }
+  return tables;
+};

tools/markdown-checker/lib/parser/__tests__/readMarkdown.test.js

@@ -0,0 +1,14 @@
+const readMarkdown = require("./../readMarkdown");
+const mock = require("../../mocks/mock");
+const config = require("./../../../config.json");
+
+const sourceCode = readMarkdown(config.stage3);
+describe("testing parser", () => {
+  test("is defined", () => {
+    expect(sourceCode).toBeDefined();
+  });
+
+  test("result is matched to given mock AST", () => {
+    expect(sourceCode).toEqual(mock);
+  });
+});

tools/markdown-checker/lib/parser/parseToAst.js

@@ -0,0 +1,12 @@
+const unified = require("unified");
+const markdown = require("remark-parse");
+
+/**
+ * @param {string} file - file path
+ * @returns {Object} - returns parsed markdown file as an AST 
+ */
+module.exports = function(file) {
+  return unified()
+    .use(markdown)
+    .parse(file);
+};

tools/markdown-checker/lib/parser/readMarkdown.js

@@ -0,0 +1,11 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * @param {string} markdownPath - path of the markdown file
+ * @returns {string} - source code of the markdown as a string
+ */
+module.exports = function(markdownPath) {
+  const resolvedPath = path.resolve(__dirname, markdownPath);
+  return fs.readFileSync(resolvedPath, "utf-8");
+};

tools/markdown-checker/lib/transformer/traverser.js

@@ -0,0 +1,15 @@
+/**
+ * @param {Object} Node 
+ * @param {function} callBackLogic 
+ */
+
+ module.exports = function traverseChildren(node, callBackLogic) {
+  node.forEach(n => {
+    callBackLogic();
+    if (n.children) {
+      traverseChildren(n);
+    }
+  });
+
+  callBackLogic && callBackLogic(node);
+};