feat: reform file and full dose code enhancement

Author: caiyongmin

.gitignore

@@ -25,6 +25,7 @@ src/template-string
 
 # Markdown
 *.md
+!src/dsa/**/*.md
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov

README.md

@@ -1,84 +1,102 @@
 # awesome-coding-javascript
 
-📌 coding about JavaScript basic principles and data structures and algorithms, verify logic with unit test.
+📌 持续构建个人的源码库，更多信息请看[这篇文章]()。
 
 [![codecov](https://codecov.io/gh/caiyongmin/codes/branch/master/graph/badge.svg)](https://codecov.io/gh/caiyongmin/codes) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](README.md)
 
-**这里得有一个目录**
+---
 
-## JavaScript
+## 一、JavaScript 原生和常用方法的代码实现
 
-- [x] [bind](./src/javascript/bind)
-- [x] [call](./src/javascript/call)
-- [x] [apply](./src/javascript/apply)
-- [x] [new](./src/javascript/new)
-- [x] [deepclone](./src/javascript/deepclone)
-- [x] [throttle](./src/javascript/throttle)
-- [x] [debounce](./src/javascript/debounce)
-- [x] [URL SearchParams](./src/javascript/searchParams)
-- [x] [Promise](./src/javascript/promise)
-- [x] [async/await](./src/javascript/async)
-- [x] [event-emitter](./src/javascript/event-emitter)
-- [x] [currify](./src/javascript/currify/currify.js)
-- [x] [template string](./src/javascript/template-string)
+- [x] [call](./src/javascript/call) / [apply](./src/javascript/apply) / [bind](./src/javascript/bind) 实现
+- [x] [new](./src/javascript/new) 实现
+- [x] [deepclone](./src/javascript/deepclone) 深拷贝实现
+- [x] [throttle](./src/javascript/throttle) / [debounce](./src/javascript/debounce) 防抖/节流实现
+- [x] [URL 参数解析](./src/javascript/searchParams) 实现
+- [x] [Promise](./src/javascript/promise) 实现
+- [x] [async/await](./src/javascript/async) 实现
+- [x] [订阅/发布](./src/javascript/event-emitter) 实现
+- [x] [柯里化](./src/javascript/currify/currify.js) 实现
+- [x] [模板字符串](./src/javascript/template-string) 实现
 
-## Library & Plugin
+## 二、常用的库和插件的代码实现
 
-- [x] [Babel](./src/bundler/babel)
+- [x] [Webpack](./src/bundler/webpack) 的模拟实现
+- [x] [Webpack-Plugin](./src/bundler/webpack-plugin) 的实现
+- [x] [Babel](./src/bundler/babel) 的模拟实现
   - input  => [tokenizer](./src/bundler/babel/lib/tokenizer.js)  => tokens
   - tokens => [parser](./src/bundler/babel/lib/parser.js)  => AST
   - AST    => [transformer](./src/bundler/babel/lib/transformer.js)  => newAST
   - newAST => [codeGenerator](./src/bundler/babel/lib/codeGenerator.js)  => output
-- [x] [Webpack](./src/bundler/webpack)
-- [x] [Webpack-Plugin](./src/bundler/webpack-plugin)
-- [x] [Babel-Plugin](./src/bundler/babel-plugin)
-- [x] [Redux](./src/bundler/redux)
-- [x] [Router](./src/bundler/router)
+- [x] [Babel-Plugin](./src/bundler/babel-plugin) 的实现
+- [x] [Redux](./src/bundler/redux) 的模拟实现
+- [x] [Router](./src/bundler/router) 的模拟实现
   - [hashRouter](./src/bundler/router/hashRouter.js)
   - [historyRouter](./src/bundler/router/historyRouter.js)
+- [x] [React](https://github.com/caiyongmin/creact) 的模拟实现（在另外一个仓库，使用 TypeScript 实现）
+- [x] [Egg.js](https://github.com/caiyongmin/tiny-egg) 的模拟实现（在另外一个仓库，暂无单元测试）
 
-## DSA
-
-- [String](./src/dsa/string)
-  - [x] [longest common substring](./src/dsa/string/longestCommonSub.js)
-  - [x] [KMP](./src/dsa/string/kmp.js)
-- [Number](./src/dsa/number)
-  - [x] [thousands format](./src/dsa/number/thousands.js)
-- [Array](./src/dsa/array)
-  - [x] [remove duplicate](./src/dsa/array/unique.js)
-  - [x] [two sum](./src/dsa/array/twoSum.js)
-  - [x] [three sum](./src/dsa/array/threeSum.js)
-- [Traversal]()
-  - [x] [DFS](./src/dsa/dfs/dfs.js)
-  - [x] [BFS](./src/dsa/bfs/bfs.js)
-- [Sort](./src/dsa/sort)
-  - [x] [bubble sort](./src/dsa/sort/bubbleSort.js)
-  - [x] [selection sort](./src/dsa/sort/selectionSort.js)
-  - [x] [insert sort](./src/dsa/sort/insertSort.js)
-  - [x] [merge sort](./src/dsa/sort/mergeSort.js)
-  - [x] [quick sort](./src/dsa/sort/quickSort.js)
-- [Tree](./src/dsa/tree)
-  - [x] [binary tree](./src/dsa/tree/binaryTree.js)
-  - [x] [binary search tree](./src/dsa/tree/binarySearchTree.js)
-  - [x] [tree symmetry](./src/dsa/tree/treeSymmetry.js)
-  - [x] [tree traversal](./src/dsa/tree/treeTraversal.js)
-  - [x] [rebuild tree](./src/dsa/tree/rebuildTree.js)
-  - [x] [invert tree](./src/dsa/tree/invertTree.js)
-- [Linked List](./src/dsa/linked-list)
-  - [x] [linked list](./src/dsa/link-list/linkedList.js)
-  - [x] [merge linked list](./src/dsa/link-list/mergeList.js)
-  - [x] [reverse linked list](./src/dsa/link-list/reverseList.js)
-- [Recursion & Loop](./src/dsa/recursion)
-  - [x] [jump floor](./src/dsa/recursion/jumpFloor.js)
-- [Double Pointer](./src/dsa/doublePointer)
-  - [x] [find Kth to tail](./src/dsa/doublePointer/findKthToTail.js)
-  - [x] [reOrder array](./src/dsa/doublePointer/reOrderArray.js)
-- [Backdate Programming](./src/dsa/backdateProgramming)
-  - [x] [find all node path in tree](./src/dsa/backdateProgramming/findAllNodePath.js)
-  - [x] [get all combination equal to target](./src/dsa/backdateProgramming/getAllCombinEqualTarget.js)
-- [Dynamic Programming](./src/dsa/dynamicProgramming)
-  - [x] [min edit distance](./src/dsa/dynamicProgramming/minEditDistance.js)
-  - [x] [min path sum](./src/dsa/dynamicProgramming/minPathSum.js)
-- [Greedy Programming](./src/dsa/greedyProgramming)
-  - [x] [best time to buy and sell stock](./src/dsa/greedyProgramming/bestTimeBuyAndSellStock.js)
-  - [x] [distribution cookie](./src/dsa/greedyProgramming/distributionCookie.js)
+## 三、JavaScript 实现的数据结构和常用算法
+
+### 数据结构
+
+- [Linked List](./src/dsa/linked-list) 链表
+  - [x] [linked list](./src/dsa/linked-list/linkedList.js) 双链表实现
+  - [x] [merge linked list](./src/dsa/linked-list/mergeList.js) 合并两个链表
+  - [x] [reverse linked list](./src/dsa/linked-list/reverseList.js) 反转链表
+- [Array](./src/dsa/array) 数组
+  - [x] [remove duplicate](./src/dsa/array/unique.js) 数组去重
+  - [x] [two sum](./src/dsa/array/twoSum.js) 两个数之和
+  - [x] [three sum](./src/dsa/array/threeSum.js) 三个数之和
+- [x] [Heap](./src/dsa/heap) 堆
+  - [x] [get min K nums](./src/dsa/heap/getMinKNums.js) 获取一段数组里面最小的 k 个数
+- [x] [Stack](./src/dsa/stack) 栈
+- [x] [Queue](./src/dsa/queue) 队列
+- [ ] [Set](./src/dsa/set) 集合
+- [ ] [Hash Table](./src/dsa/hash) 散列表
+- [Tree](./src/dsa/tree) 树
+  - [x] [binary tree](./src/dsa/tree/binaryTree.js) 二叉树
+  - [x] [tree traversal](./src/dsa/tree/treeTraversal.js) 二叉树的先序/中序/后序非递归遍历
+  - [x] [rebuild tree](./src/dsa/tree/rebuildTree.js) 重建二叉树
+  - [x] [invert tree](./src/dsa/tree/invertTree.js) 翻转二叉树
+  - [x] [tree symmetry](./src/dsa/tree/treeSymmetry.js) 是否是镜像二叉树
+
+### 算法
+
+- [Sort](./src/dsa/sort) 排序
+  - [x] [bubble sort](./src/dsa/sort/bubbleSort.js)  冒泡排序
+  - [x] [selection sort](./src/dsa/sort/selectionSort.js) 选择排序
+  - [x] [insert sort](./src/dsa/sort/insertSort.js) 插入排序
+  - [x] [merge sort](./src/dsa/sort/mergeSort.js) 归并排序
+  - [x] [quick sort](./src/dsa/sort/quickSort.js) 快速排序
+- [Divide and conquer]() 分治
+  - [x] [binary search tree](./src/dsa/tree/binarySearchTree.js) 二叉搜索树
+- [Recursion](./src/dsa/recursion) 递归
+  - [x] [jump floor](./src/dsa/recursion/jumpFloor.js) 跳台阶
+  - [x] [find all node path in tree](./src/dsa/recursion/findAllNodePath.js) 找出二叉树中结点值的和为输入整数的所有路径
+- [Traversal]() 遍历
+  - [x] [DFS](./src/dsa/dfs/dfs.js) 深度优先遍历
+  - [x] [BFS](./src/dsa/bfs/bfs.js) 广度优先遍历
+- [Double Pointer](./src/dsa/doublePointer) 双指针
+  - [x] [find Kth to tail](./src/dsa/doublePointer/findKthToTail.js) 求链表中倒数第 k 个结点
+  - [x] [reOrder array](./src/dsa/doublePointer/reOrderArray.js) 数组重排序，奇数在前半部分，偶数在后半部分
+- [Dynamic Programming](./src/dsa/dynamicProgramming) 动态规划
+  - [x] [min edit distance](./src/dsa/dynamicProgramming/minEditDistance.js) 最小编辑距离
+  - [x] [min path sum](./src/dsa/dynamicProgramming/minPathSum.js) 最少路径问题
+- [Backdate Programming](./src/dsa/backTracking) 回溯算法
+  - [ ] [solve N queens](./src/dsa/backTracking/solveNQueens.js) N 皇后问题
+- [Greedy Programming](./src/dsa/greedyProgramming) 贪心算法
+  - [ ] [best time to buy and sell stock](./src/dsa/greedyProgramming/bestTimeBuyAndSellStock.js) 买股票
+  - [ ] [distribution cookie](./src/dsa/greedyProgramming/distributionCookie.js) 分发饼干
+
+### 其他
+
+- [String](./src/dsa/string) 字符串
+  - [x] [longest common substring](./src/dsa/string/longestCommonSub.js) 最长公共子串
+  - [x] [KMP](./src/dsa/string/kmp.js) KMP 算法求子串的索引位置
+- [Number](./src/dsa/number) 数字
+  - [x] [thousands format](./src/dsa/number/thousands.js) 千分位
+
+---
+
+Welcome to commit [issue](https://github.com/caiyongmin/awesome-coding-javascript/issues) & [pull request](https://github.com/caiyongmin/awesome-coding-javascript/pulls) !

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "codes",
+  "name": "awesome-coding-javascript",
   "version": "1.0.0",
-  "description": "😈 talk is cheap, show me the code",
+  "description": "talk is cheap, show me the code",
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",

src/dsa/array/threeSum.js

@@ -1,3 +1,7 @@
+/**
+ * 三数之和
+ */
+
 function threeEqualZero(nums, third, results) {
   if (nums.length < 2) {
     return;

src/dsa/array/twoSum.js

@@ -1,3 +1,7 @@
+/**
+ * 二数之和
+ */
+
 export function twoSum1(arr, target) {
   if (typeof target !== 'number') {
     throw new Error('target must be a number');

src/dsa/array/unique.js

@@ -1,3 +1,7 @@
+/**
+ * 数组去重
+ */
+
 // use object record item and filter
 export const unique1 = arr => {
   if (!Array.isArray(arr) || !arr.length) {

src/dsa/backTracking/backTracking.md

@@ -0,0 +1,16 @@
+回溯算法
+
+从解决问题每一步的所有可能选项里系统选择出一个可行的解决方案。
+在某一步选择一个选项后，进入下一步，然后面临新的选项。重复选择，直至达到最终状态。
+
+回溯法解决的问题的所有选项可以用树状结构表示。
+
+- 在某一步有n个可能的选项，该步骤可看作树中一个节点。
+- 节点每个选项看成节点连线，到达它的n个子节点。
+- 叶节点对应终结状态。
+- 叶节点满足约束条件，则为一个可行的解决方案。
+- 叶节点不满足约束条件，回溯到上一个节点，并尝试其他叶子节点。
+- 节点所有子节点均不满足条件，再回溯到上一个节点。
+- 所有状态均不能满足条件，问题无解。
+
+![](https://user-gold-cdn.xitu.io/2019/8/20/16cac354abee3f00?imageView2/0/w/1280/h/960/format/webp/ignore-error/1)

src/dsa/dynamicProgramming/regexpMatch.js src/dsa/backTracking/bag.js

@@ -0,0 +1 @@
+export function solveNQueues() {}

src/dsa/backTracking/solveNQueens.js

@@ -1,3 +1,7 @@
+/**
+ * 广度优先算法
+ * 广度优先算法是一种遍历或搜索树或图的方法，沿着树的宽度遍历树的节点。
+ */
 export function BFSTraverseNR(rootNode, visitor) {
   if (!rootNode || typeof visitor !== 'function') {
     console.warn('rootNode is empty or visitor is not function');

src/dsa/backdateProgramming/getAllCombinEqualTarget.js

@@ -19,6 +19,17 @@ describe('BFS', () => {
     results = [1, 2, 3, 4, 5, 6, 10];
   });
 
+  it('rootNode is empty or visitor is not function', () => {
+    const nodes1 = [];
+    BFSTraverseNR(null, node => {
+      nodes1.push(node.name);
+    });
+    const nodes2 = [];
+    BFSTraverseNR(root);
+    expect(nodes1).toEqual([]);
+    expect(nodes2).toEqual([]);
+  });
+
   it('breadth-first search non-recursion', () => {
     const nodes = [];
     BFSTraverseNR(root, node => {

src/dsa/bfs/bfs.js

@@ -1,3 +1,7 @@
+/**
+ * 深度优先算法
+ * 深度优先算法是一种用于遍历或搜索树或图的算法。沿着树的深度遍历树的节点，尽可能深的搜索树的分支。
+ */
 export function DFSTraverse(rootNode, visitor) {
   if (!rootNode || typeof visitor !== 'function') {
     console.warn('rootNode is empty or visitor is not function');
@@ -14,6 +18,10 @@ export function DFSTraverse(rootNode, visitor) {
   }
 }
 
+/**
+ * 深度优先非递归解法
+ * 使用栈来解决
+ */
 export function DFSTraverseNR(rootNode, visitor) {
   if (!rootNode || typeof visitor !== 'function') {
     console.warn('rootNode is empty or visitor is not function');

src/dsa/bfs/bfs.test.js

@@ -19,6 +19,17 @@ describe('DFS', () => {
     results = [1, 2, 4, 5, 3, 6, 10];
   });
 
+  it('rootNode is empty or visitor is not function', () => {
+    const nodes1 = [];
+    DFSTraverse(null, node => {
+      nodes1.push(node.name);
+    });
+    const nodes2 = [];
+    DFSTraverseNR(root);
+    expect(nodes1).toEqual([]);
+    expect(nodes2).toEqual([]);
+  });
+
   it('depth-first search', () => {
     const nodes = [];
     DFSTraverse(root, node => {

src/dsa/dfs/dfs.js

@@ -0,0 +1,6 @@
+/**
+ * 双指针算法
+ * 双指正算法主要是利用两个或多个不同位置的指针，通过速度和方向的变换解决问题。
+ * 两个指针从不同位置出发：一个从始端开始，另一个从末端开始；
+ * 两个指针以不同速度移动：一个指针快一些，另一个指针慢一些。
+ */

src/dsa/dfs/dfs.test.js

@@ -6,18 +6,21 @@ export default function findKthToTail(head, k) {
     return null;
   }
 
+  // 双指针
   let first = head;
   let second = head;
   let index = 1;
 
   while (first.next) {
     first = first.next;
+    // 当 first 和 second 相距 k 时，second 开始逐渐前进
     if (index >= k) {
       second = second.next;
     }
     index++;
   }
 
+  // 循环结束后， k 如果大于 index 则说明倒数第 k 个节点不存在
   if (k > index) {
     return null;
   }

src/dsa/doublePointer/doublePointer.js

@@ -16,9 +16,11 @@ export function reOrderArray(arr) {
   let start = 0;
   let end = arr.length - 1;
   while (start < end) {
+    // 碰到偶数 start 前进一位
     while (arr[start] % 2 === 1) {
       start++;
     }
+    // 碰到奇数 end 前进一位
     while(arr[end] % 2 === 0) {
       end--;
     }

src/dsa/doublePointer/findKthToTail.js

@@ -0,0 +1,11 @@
+动态规划算法
+
+动态规划背后的基本思想非常简单。
+大致上，若要解一个给定问题，我们需要解其不同部分（即子问题），
+再根据子问题的解以得出原问题的解。
+
+动态规划算法，需要分析出每个阶段的状态，从而分析出阶段之间的关系转化。
+适用于动态规划的问题，需要满足最优子结构和无后效性
+动态规划的求解过程，在于找到状态转移方程，进行自底向上的求解。
+
+https://www.zhihu.com/question/23995189

src/dsa/doublePointer/reOrderArray.js

@@ -1,3 +1,10 @@
+/**
+ * matrix[i][j] = Math.min(
+ *    matrix[i - 1][j] + 1,
+ *    matrix[i][j - 1] + 1,
+ *    matrix[i - 1][j - 1] + (str1[i - 1] === str2[j - 1] ? 0 : 1)
+ * );
+ */
 export default function minEditDistance(str1, str2) {
   if (!str1 || !str2) {
     return Math.max(str1.length, str2.length);