feat: add doc generator

Author: yeonjuan

.genrc.json

@@ -0,0 +1,8 @@
+{
+  "sections": [
+    "10-Days-Of-Javascript",
+    "Interview-Preparation-Kit",
+    "Algorithms",
+    "Data-Structures"
+  ]
+}

.templates/header.md

@@ -0,0 +1,2 @@
+# Hackerrank-js
+Hackerrank Problem Solving with Javascript.

.templates/problems.md

@@ -0,0 +1,13 @@
+{{#each sections}}
+
+## {{makeTitle title}}
+{{#each categories}}
+### {{title}}
+| Difficulty | Problem | Solution |
+| --- | --- | --- |
+{{#each problems}}
+| {{difficulty}} | [{{title}}]({{link}}) | [Solution]({{path}})|
+{{/each}}
+{{/each}}
+{{/each}}
+

.templates/toc.md

@@ -0,0 +1,4 @@
+## Table of contents
+{{#each sections}}
+* [{{makeTitle title}}](#{{makeAnchor title}})
+{{/each}}

.tool/readme.md

@@ -0,0 +1 @@
+# 

.tool/src/comparators.js

@@ -0,0 +1,27 @@
+const compareCategories = (categoryA, categoryB) => categoryA.title.localeCompare(categoryB.title)
+
+const DIFFICULTIES = {
+  Easy: 0,
+  Medium: 1,
+  Hard: 2,
+};
+const compareDifficulties = (difficultyA, difficultyB) => (
+  DIFFICULTIES[difficultyA] - DIFFICULTIES[difficultyB]
+);
+
+const compareTitles = (titleA, titleB) => (
+  titleA.localeCompare(titleB)
+);
+
+const compareProblems = (problemA, problemB) => {
+  const difficultyDiff = compareDifficulties(problemA.difficulty, problemB.difficulty);
+  if (difficultyDiff !== 0) {
+    return difficultyDiff;
+  }
+  return compareTitles(problemA.title, problemB.title);
+};
+
+module.exports = {
+  compareCategories,
+  compareProblems,
+};

.tool/src/index.js

@@ -0,0 +1,43 @@
+const parse = require('./parse');
+const {
+  Config,
+  HEADER_TEMPLATE_PATH,
+  TOC_TEMPLATE_PATH,
+  PROBLEMS_TEMPLATE_PATH
+} = require('./utils');
+const {
+  compareCategories,
+  compareProblems,
+} = require('./comparators');
+const template = require('./template');
+const fs = require('fs');
+const path = require('path');
+const sections = Config.getSections();
+const parsed = parse(sections);
+
+parsed.sections.forEach(section => {
+  section.categories.sort(compareCategories);
+  section.categories.forEach(category => {
+    category.problems.sort(compareProblems);
+  });
+});
+
+const templates = template([
+  {path: HEADER_TEMPLATE_PATH, obj: null},
+  {path: TOC_TEMPLATE_PATH, obj: parsed},
+  {path: PROBLEMS_TEMPLATE_PATH, obj: parsed}
+]);
+
+const readme = templates.reduce((md,cur) => {
+  return md + cur;
+}, '');
+const readmePath = path.resolve('./README.md');
+const createREADME = (newReadme) => {
+  if (fs.existsSync(readmePath)) {
+    fs.unlinkSync(readmePath)
+  }
+  fs.writeFileSync(readmePath, newReadme);
+};
+createREADME(readme);
+
+

.tool/src/parse.js

@@ -0,0 +1,76 @@
+const path = require('path');
+const parseComment = require('comment-parser');
+const {
+  readdirSync,
+  readFileSync
+} = require('fs');
+const {
+  isTag,
+  getContentFromSource,
+  getTitleFromPath,
+  getGithubPath,
+  isDir
+} = require('./utils');
+
+const parseSolution = (solutionFile) => {
+  const solutionSource = readFileSync(solutionFile, 'utf8');
+  const parsedResult = Object.create(null);
+  const parsed = parseComment(solutionSource);
+  if (parsed.length <= 0) {
+    return null;
+  }
+  const tags = parsed[0].tags;
+  tags.forEach(({tag, source}) => {
+    if (isTag(tag)) {
+      parsedResult[tag] = getContentFromSource(tag, source);
+    }
+  });
+  parsedResult.path = getGithubPath(solutionFile);
+  return parsedResult;
+};
+
+const parseCategory = (categoryDir) => {
+  const parsedResult =  {
+    title: getTitleFromPath(categoryDir),
+    problems: [],
+  };
+  const solutionFiles = readdirSync(categoryDir);
+
+  solutionFiles.forEach(solutionFile => {
+    const result = parseSolution(path.join(categoryDir, solutionFile));
+    if (result) {
+      parsedResult.problems.push(result);
+    }
+  });
+  return parsedResult;
+};
+
+const parseSection = (sectionDir) => {
+  const parsedResult = {
+    title: getTitleFromPath(sectionDir),
+    categories: [],
+  };
+  const categoryDirs = readdirSync(sectionDir);
+  categoryDirs.forEach((categoryDir) => {
+    if (isDir(path.join(sectionDir, categoryDir))) {
+      const result = parseCategory(path.join(sectionDir, categoryDir));
+      parsedResult.categories.push(result);
+    }
+  });
+  return parsedResult;
+};
+
+const parse = (sectionDirs) => {
+  const parsedResult = {
+    sections: [],
+  };
+  sectionDirs.forEach((sectionDir) => {
+    if (isDir(sectionDir)) {
+      const result = parseSection(path.resolve(sectionDir));
+      parsedResult.sections.push(result);
+    }
+  });
+  return parsedResult;
+};
+
+module.exports = parse;

.tool/src/template.js

@@ -0,0 +1,18 @@
+const {existsSync, readFileSync} = require('fs');
+const handlebars = require('handlebars');
+const replaceAll = (str, search, replacement) => str.split(search).join(replacement);
+handlebars.registerHelper('makeTitle', (title) => replaceAll(title, '-', ' '));
+handlebars.registerHelper('makeAnchor', (title) => replaceAll(title, ' ', '-'));
+
+const getTemplate = ({path, obj}) => {
+  if (!existsSync(path)) {
+    throw new Error(`File Not Found: ${path}`);
+  }
+  const templateSource = readFileSync(path, 'utf8');
+  return handlebars.compile(templateSource)(obj);
+};
+
+module.exports = (templatePairs) => (
+  templatePairs
+    .map((pair) => getTemplate(pair))
+);

.tool/src/utils.js

@@ -0,0 +1,37 @@
+const path = require('path');
+const fs = require('fs');
+
+const TAG_TYPES = ['difficulty', 'link', 'title'];
+
+const isTag = (tag) => TAG_TYPES.includes(tag);
+const getContentFromSource = (tag, source) => source.replace(`@${tag}`, '').trim();
+const getTitleFromPath = (filePath) => filePath.slice(filePath.lastIndexOf('/') + 1).trim();
+const getGithubPath = (filePath) => filePath.replace(path.resolve('./'), '.').trim();
+const isDir = (dir) => !(/\./g.test(dir)) && fs.lstatSync(dir).isDirectory();
+
+const CONFIG_PATH = path.resolve('./.genrc.json');
+const HEADER_TEMPLATE_PATH = path.resolve('./.templates/header.md');
+const PROBLEMS_TEMPLATE_PATH = path.resolve('./.templates/problems.md');
+const TOC_TEMPLATE_PATH = path.resolve('./.templates/toc.md');
+
+
+const Config = (() => {
+  const configFile = fs.readFileSync(CONFIG_PATH);
+  const config = JSON.parse(configFile);
+  return {
+    getSections: () => config.sections
+  };
+})();
+
+
+module.exports = {
+  isTag,
+  getContentFromSource,
+  getTitleFromPath,
+  Config,
+  getGithubPath,
+  HEADER_TEMPLATE_PATH,
+  PROBLEMS_TEMPLATE_PATH,
+  TOC_TEMPLATE_PATH,
+  isDir
+};

10DaysOfJavascript/Day0/data-types.js 10-Days-Of-Javascript/Day0/data-types.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/js10-data-types/problem
+/**
+ * @title Data Types
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-data-types/problem
+ */
 
 const performOperation = (secondInteger, secondDecimal, secondString) => {
   const firstInteger = 4;

10-Days-Of-Javascript/Day0/hello-world.js

@@ -0,0 +1,11 @@
+/**
+ * @title Hello, World!
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-hello-world/problem
+ */
+
+const greeting = parameterVariable => {
+  console.log('Hello, World!');
+  console.log(parameterVariable);
+};
+

10DaysOfJavascript/Day1/arithmetic-oprators.js 10-Days-Of-Javascript/Day1/arithmetic-oprators.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/js10-arithmetic-operators/problem
+/**
+ * @title Arithmetic Operators
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-arithmetic-operators/problem
+ */
 
 const getArea = (length, width) => {
   const area = length * width;

10-Days-Of-Javascript/Day1/functions.js

@@ -0,0 +1,14 @@
+/**
+ * @title Functions
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-function/problem
+ */
+
+const factorial = n => {
+  let ret = 1;
+  for (let i = 1; i <= n; i++) {
+    ret *= i;
+  }
+
+  return ret;
+};

10DaysOfJavascript/Day1/let-and-const.js 10-Days-Of-Javascript/Day1/let-and-const.js

@@ -1,4 +1,9 @@
-// https://www.hackerrank.com/challenges/js10-let-and-const/problem
+/**
+ * @title Let and Const
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-let-and-const/problem
+ */
+
 /* global readLine b:writable */
 /* eslint-disable no-const-assign */
 

10DaysOfJavascript/Day2/conditional-statements-if-else.js 10-Days-Of-Javascript/Day2/conditional-statements-if-else.js

@@ -1,4 +1,8 @@
-//  https://www.hackerrank.com/challenges/js10-if-else/problem
+/**
+ * @title Conditional Statements: If-Else
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-if-else/problem
+ */
 
 const getGrade = score => {
   let grade;

10DaysOfJavascript/Day2/conditional-statements-switch.js 10-Days-Of-Javascript/Day2/conditional-statements-switch.js

@@ -1,4 +1,8 @@
-//  https://www.hackerrank.com/challenges/js10-switch/problem
+/**
+ * @title Conditional Statements: Switch
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-switch/problem
+ */
 
 const isGroupA = firstLetter => /^a|e|i|o|u/.test(firstLetter);
 

10DaysOfJavascript/Day2/loops.js 10-Days-Of-Javascript/Day2/loops.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/js10-loops/problem
+/**
+ * @title Loops
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-loops/problem
+ */
 
 const isVowel = letter => /^a|e|i|o|u/.test(letter);
 const isConsonant = letter => !isVowel(letter);

10DaysOfJavascript/Day3/arrays.js 10-Days-Of-Javascript/Day3/arrays.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/js10-arrays/problem
+/**
+ * @title Arrays
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-arrays/problem
+ */
 
 const compareNumber = (a, b) => b - a;
 

10DaysOfJavascript/Day3/throw.js 10-Days-Of-Javascript/Day3/throw.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/js10-throw/problem
+/**
+ * @title Throw
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-throw/problem
+ */
 
 const isPositive = num => {
   if (num > 0) {

10DaysOfJavascript/Day3/try-catch-and-finally.js 10-Days-Of-Javascript/Day3/try-catch-and-finally.js

@@ -1,4 +1,8 @@
-//  https://www.hackerrank.com/challenges/js10-try-catch-and-finally/problem
+/**
+ * @title Try, Catch, and Finally
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-try-catch-and-finally/problem
+ */
 
 const reverseString = s => {
   try {

10DaysOfJavascript/Day4/create-a-rectangle-object.js 10-Days-Of-Javascript/Day4/create-a-rectangle-object.js

@@ -1,4 +1,8 @@
-//  https://www.hackerrank.com/challenges/js10-objects/problem
+/**
+ * @title Create a Rectangle Object
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/js10-objects/problem
+ */
 
 function Rectangle(length, width) {
   this.length = length;

10DaysOfJavascript/Day0/hello-world.js

@@ -1,4 +1,8 @@
-// https://www.hackerrank.com/challenges/big-sorting/problem
+/**
+ * @title Big Sorting
+ * @difficulty Easy
+ * @link https://www.hackerrank.com/challenges/big-sorting/problem
+ */
 
 const bigNumCompareFunc = (numStrA, numStrB) => {
   const {length: strLengthA} = numStrA;