markdown checker

tools/markdown-checker/.eslintignore

@@ -0,0 +1 @@
+*_tests_*

tools/markdown-checker/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+    "env": {
+        "node": true,
+        "es6": true
+    },
+    "extends": [
+        "airbnb-base"
+    ],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "rules": {
+      "no-underscore-dangle": 0,
+      "import/no-extraneous-dependencies": 0,
+      "no-unused-vars": 0
+    }
+}

tools/markdown-checker/.gitignore

@@ -0,0 +1,21 @@
+# 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
+**/.idea/**
+
+# packages
+node_modules/
+*/node_modules/*

tools/markdown-checker/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

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/enums.js

@@ -0,0 +1,12 @@
+module.exports = {
+  stage3: './../../../../README.md',
+  stage1: './../../../../stage-1-proposals.md',
+  DEFINITION: 'definition',
+  TABLE: 'table',
+  TEXT: 'text',
+  ROW: 'tableRow',
+  CELL: 'tableCell',
+  HTML: 'html',
+  LINK: 'linkReference',
+  INLINE_CODE: 'inlineCode'
+};

tools/markdown-checker/index.js

@@ -0,0 +1,33 @@
+const readMarkdown = require('./lib/parser/readMarkdown');
+const parseToAST = require('./lib/parser/parseToAst');
+const globalData = require('./lib/data');
+const generateJSONFile = require('./lib/writeFile');
+const {
+  collectLinkDefinitions,
+} = require('./lib/analyzer/collectLinkDefinitions');
+const { generateTable } = require('./lib/analyzer/analyzeTable');
+const enums = require('./enums.js');
+
+const processStage3 = (stage) => {
+  /**
+   * TODO: handle multiple table in readme.md
+   * TODO: handle "Test" columns in stage3
+   * TODO: handle different column lengths
+   */
+  //
+
+  const activeStage = enums[stage];
+  // parse stage
+  const markdownStage = readMarkdown(activeStage);
+  const parsedFile = parseToAST(markdownStage);
+
+  globalData.linkDefinitions = collectLinkDefinitions(parsedFile);
+  const table = generateTable(parsedFile);
+  // creates JSON file
+  const fileName = `${stage}Table.json`;
+  generateJSONFile(fileName, JSON.stringify(table))
+    .then(_ => console.log(`The ${fileName} has been created!`))
+    .catch(err => console.log(`err: ${err}`));
+};
+
+processStage3('stage1');

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

@@ -0,0 +1,43 @@
+const readMarkdown = require('./../../parser/readMarkdown');
+const parseToAST = require('./../../parser/parseToAst');
+const {
+  collectLinkDefinitions,
+  addLinkIntoDefintions
+} = require('../collectLinkDefinitions');
+const definitionNode = require('../../../mocks/definitionNode');
+
+describe('testing collectLinkDefiniton function', () => {
+  let parsedMarkdown;
+  let allLinkDefinitions;
+
+  beforeAll(() => {
+    const markdownFile = readMarkdown('../../mocks/stage3Mock.md');
+    parsedMarkdown = parseToAST(markdownFile);
+    allLinkDefinitions = collectLinkDefinitions(parsedMarkdown);
+  });
+
+  test('function is defined', () => {
+    expect(collectLinkDefinitions).toBeDefined();
+    expect(typeof collectLinkDefinitions).toBe('function');
+  });
+
+  test('definition added into hash', () => {
+    const definitions = addLinkIntoDefintions({}, definitionNode);
+    const { label, url } = definitions;
+    expect(typeof definitions).toBe('object');
+    expect(typeof label && typeof url).toBe('string');
+    expect(label).toBe('regexp-legacy');
+    expect(url).toBe('https://github.com/tc39/proposal-regexp-legacy-features');
+  });
+
+  test('link definitions are collected', () => {
+    expect(allLinkDefinitions).toBeDefined();
+    expect(typeof allLinkDefinitions).toBe('object');
+    expect(allLinkDefinitions['buffer-transfer']).toBe(
+      'https://github.com/domenic/proposal-arraybuffer-transfer/'
+    );
+    expect(allLinkDefinitions['private-methods']).toBe(
+      'https://github.com/tc39/proposal-private-methods'
+    );
+  });
+});

tools/markdown-checker/lib/analyzer/__tests__/detectTableChildren.test.js

@@ -0,0 +1,41 @@
+const detectTables = require('../detectTables');
+const detectHeaders = require('../handleTables');
+const parsedMarkdownTree = require('../../../mocks/parsedMarkdownTree');
+
+const markdownTables = detectTables(parsedMarkdownTree);
+const [child] = markdownTables;
+
+describe('testing detectTables function', () => {
+  test('is defined', () => {
+    expect(detectTables).toBeDefined();
+  });
+  test('length is matched', () => {
+    expect(markdownTables.length).toEqual(2);
+  });
+  test('has correct size of thead', () => {
+      expect(child.align.length).toBe(5);
+  })
+  test('is returned table', () => {
+    expect(child.type).toBe('table');
+  });
+  test('has row and cell children', () => {
+    const [rowChild] = child.children;
+    expect(rowChild.type).toBe('tableRow');
+
+    const [cellChild] = rowChild.children;
+    expect(cellChild.type).toBe('tableCell');
+  });
+});
+
+describe('testing detectHeaders function', () => {
+  let rowChild;
+  beforeAll(() => {
+    [rowChild] = child.children;
+  });
+  test('is defined', ()=>{
+    expect(detectHeaders).toBeDefined();
+  })
+  test('is defined', ()=>{
+    rowChild;
+  })
+})

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

@@ -0,0 +1,36 @@
+
+const detectTables = require('./detectTables');
+const handleTables = require('./handleTables');
+const { checkNodeHasChildren } = require('../utils');
+
+/**
+ *
+ * @param {Object} node
+ * @returns {Array}
+ */
+const extractAllTablesFromTree = (node) => {
+  if (checkNodeHasChildren(node)) {
+    return detectTables(node);
+  }
+  return [];
+};
+/**
+ *
+ * @param {Object} node - current node of the parsed AST
+ * @param {Object} linkDefinitions - represents all of the link shortcuts
+ */
+
+const generateTable = (node) => {
+  const tables = extractAllTablesFromTree(node);
+  let JSONTables = [];
+  if (tables && tables.length > 0) {
+    tables.forEach((table) => {
+      if (Object.values(table).length > 0) {
+        JSONTables = handleTables(table);
+      }
+    });
+  }
+  return JSONTables;
+};
+
+module.exports = { generateTable, extractAllTablesFromTree };

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

@@ -0,0 +1,32 @@
+const { DEFINITION } = require('./../../enums.js');
+
+/**
+ *
+ * @param {Object} definitions
+ * @param {Object} node
+ * @returns {Object}
+ */
+function addLinkIntoDefinitions(definitions, node) {
+  const { label, url } = node;
+  // eslint-disable-next-line no-param-reassign
+  definitions[label] = url;
+  return {
+    label,
+    url,
+  };
+}
+
+/**
+ * @param {Object} AST
+ * @returns {Object} - collected link definitions
+ */
+function collectLinkDefinitions(AST) {
+  const definitions = {};
+  AST.children.forEach((node) => {
+    // eslint-disable-next-line no-unused-expressions
+    node.type === DEFINITION && addLinkIntoDefinitions(definitions, node);
+  });
+  return definitions;
+}
+
+module.exports = { collectLinkDefinitions };

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

@@ -0,0 +1,10 @@
+const { TABLE } = require('./../../enums.js');
+/**
+ * @param {Object} node - Parsed markdown file an AST Object
+ * @returns {Array} - contains detected table nodes of the AST
+ */
+function detectTables(node) {
+  return node.children.filter(({ type }) => type === TABLE);
+}
+
+module.exports = detectTables;