feat: plop new docs or template set alias; update docs about alias (#21)

Author: Rain120

CHANGELOG.md

@@ -1,4 +1,4 @@
-# 1.0.0 (2020-04-13)
+# 1.0.0 (2020-07-05)
 
 
 ### Bug Fixes
@@ -50,6 +50,7 @@
 * observer pattern ([77c78f7](https://github.com/Rain120/awesome-javascript-code-implementation/commit/77c78f7359161c0e64b3143e3a66fea3f5d4eb46))
 * plop create code and docs model ([2dece76](https://github.com/Rain120/awesome-javascript-code-implementation/commit/2dece76fbfd83514551dbabadf7c54d73674730d))
 * plop new code and docs template ([61a936b](https://github.com/Rain120/awesome-javascript-code-implementation/commit/61a936b58bc52a1cf984dc6156746b43f65da7f1))
+* plop new docs or template set alias; update docs about alias ([99acb07](https://github.com/Rain120/awesome-javascript-code-implementation/commit/99acb07f03348613efab69049a240bf04928dc6b))
 * promise; debugger launch ([cc8ad80](https://github.com/Rain120/awesome-javascript-code-implementation/commit/cc8ad803956e65431cedd97f1ebb333ffe78c28e))
 * proxy design ([e615f39](https://github.com/Rain120/awesome-javascript-code-implementation/commit/e615f39497043f4c2357c7366cb13226b57208e6))
 * sort -> bubbleSort(algorithm, readme, test) ([36fab7b](https://github.com/Rain120/awesome-javascript-code-implementation/commit/36fab7b029d425ac129b6c4f202b18a9a3852fef))
@@ -60,10 +61,10 @@
 * update readme for plans ([b427b96](https://github.com/Rain120/awesome-javascript-code-implementation/commit/b427b9667cc97c77df75ef0af56eb84b6b4c3ba6))
 * update test.yml -> ci.yml and set command ([43b96b6](https://github.com/Rain120/awesome-javascript-code-implementation/commit/43b96b63fc2788a5ea37fa7567c6a6dced4b875f))
 * update vdom-diff docs ([06590c5](https://github.com/Rain120/awesome-javascript-code-implementation/commit/06590c56d0df7cbba68bb705cb7e159f6f765c3a))
-* update xmind ([71317c6](https://github.com/Rain120/awesome-javascript-code-implementation/commit/71317c67376bc8196f80e25391adfdc9b2496380))
-* update xmind ([4256758](https://github.com/Rain120/awesome-javascript-code-implementation/commit/4256758c5fe0a036ce3ececc43f848e48964d7a0))
-* update xmind ([408ca68](https://github.com/Rain120/awesome-javascript-code-implementation/commit/408ca685142dc425e90be64a284016d57d580893))
 * update xmind ([cb23933](https://github.com/Rain120/awesome-javascript-code-implementation/commit/cb23933f46152c59a7b08f84d7355b35bba25002))
+* update xmind ([408ca68](https://github.com/Rain120/awesome-javascript-code-implementation/commit/408ca685142dc425e90be64a284016d57d580893))
+* update xmind ([4256758](https://github.com/Rain120/awesome-javascript-code-implementation/commit/4256758c5fe0a036ce3ececc43f848e48964d7a0))
+* update xmind ([71317c6](https://github.com/Rain120/awesome-javascript-code-implementation/commit/71317c67376bc8196f80e25391adfdc9b2496380))
 * update: plans; fix: readme bug ([d44e559](https://github.com/Rain120/awesome-javascript-code-implementation/commit/d44e559def7834fcccbb19797a1d29bf5cc4e5b7))
 * vdom diff algorithm ([3b7779d](https://github.com/Rain120/awesome-javascript-code-implementation/commit/3b7779dcad7e184027d1bddfa6387224c2f009d3))
 * vuepress docs v1.0.0 ([785caeb](https://github.com/Rain120/awesome-javascript-code-implementation/commit/785caeb41beeff7a0f53646fc952d1c89ebb61d5))

README.md

@@ -45,9 +45,9 @@ Document Link:
 
 [Xmind Download](plans.xmind)
 
-#### 🔨 Usage
+#### 🔨 Quick Start
 
-⌨️
+<!-- ⌨️ To be Continue... -->
 
 生成 `code` 模板
 
@@ -69,6 +69,18 @@ npm run template-docs
 
 [how-to-write-docs](docs/zh/how-to-write-docs/README.md)
 
+#### 🌏Deploy
+
+##### -> https://rain120.github.io/awesome-javascript-code-implementation
+
+```
+npm run deploy
+```
+
+##### -> https://awesome-javascript-code-implementation.netlify.com/
+
+`netlify auto deploy`
+
 #### 🤝 Contributing
 
 ![PR](https://img.shields.io/badge/PRs-Welcome-orange?style=flat-square&logo=appveyor)

docs/.vuepress/config.js

@@ -1,23 +1,17 @@
 const path = require('path');
 const plugins = require('./utils/plugins');
-const { sidebarHelper } = require('./utils/sidebarHelper');
+const { sidebarHelper, sortSidebar } = require('./utils/sidebarHelper');
 const nav = require('./utils/nav');
 
 /**
- * @description [guide, how-to-write-docs, ...]
+ * sortSidebar 根据 alias 设置顺序，默认顺序为 文件夹名字的顺序
  */
-const docs = sidebarHelper();
-const sidebar = [];
-docs.map(item => {
-  if (item.path.includes('guide') || item.path.includes('how-to-write-docs')) {
-      sidebar.unshift(item)
-  } else {
-      sidebar.push(item)
-  }
-});
-[sidebar[1], sidebar[0]] = [sidebar[0], sidebar[1]];
+
+const sidebar = sortSidebar(sidebarHelper());
 
 // git pages base project name -> /awesome-javascript-code-implementation/, netlify base: ''
+// deploy https://rain120.github.io/awesome-javascript-code-implementation build has argv
+// more info go to deploy.sh
 const ARGV = (process.argv || []).slice(-1)[0];
 const base = ARGV !== 'docs' ? ARGV : '';
 

docs/.vuepress/utils/alias.js

@@ -0,0 +1,55 @@
+{
+  "guide": "介绍",
+  "how-to-write-docs": "如何写文档? ",
+  "math-------": "",
+  "math": "数学",
+  "factorial": "阶乘",
+  "fibonacci": "斐波那契数列",
+  "gcd": "最大公约数",
+  "lcm": "最小公倍数",
+  "binary": "二进制",
+  "primitive-------": "",
+  "primitive": "原生 Javascript",
+  "function-------": "",
+  "function": "函数",
+  "debounce": "防抖",
+  "throttle": "节流",
+  "vdom-diff-------": "",
+  "vdom-diff": "实现React/Vue DOM Diff算法",
+  "es6-------": "",
+  "es6": "ECMAScript 6(ES6)",
+  "promise": "手写Promise",
+  "Array-------": "",
+  "array": "Array(MDN + Function)",
+  "Object-------": "",
+  "object": "Object(MDN + Function)",
+  "types-------": "",
+  "types": "Types",
+  "utils-------": "",
+  "utils": "Utils",
+  "design-pattern-------": "",
+  "design-pattern": "设计模式",
+  "adapter-pattern": "适配器模式",
+  "decorator-pattern": "装饰器模式",
+  "factory-pattern": "工厂模式",
+  "facade-pattern": "外观模式",
+  "iterator-pattern": "迭代器模式",
+  "proxy-pattern": "代理模式",
+  "observer-pattern": "观察者模式",
+  "singleton-pattern": "单例模式",
+  "algorithms-------": "",
+  "algorithms": "算法",
+  "binaryTree": "二叉树",
+  "sort-------": "",
+  "sort": "排序算法",
+  "bubbleSort": "冒泡排序",
+  "bucketSort": "桶排序",
+  "countingSort": "计数排序",
+  "heapSort": "堆排序",
+  "insertionSort": "插入排序",
+  "mergeSort": "归并排序",
+  "quickSort": "快速排序",
+  "radixSort": "基数排序",
+  "selectionSort": "选择排序",
+  "shellSort": "希尔排序"
+}

docs/.vuepress/utils/alias.json

@@ -4,7 +4,22 @@ const path = require('path');
 const filePath = path.join(__dirname, '../../zh');
 const ignore = ['images', '.vuepress', '.DS_Store'];
 const README_REG = /README/;
-const { alias } = require('./alias');
+
+/**
+ * @description 特殊处理文档顺序
+ * alias 的顺序决定了文档菜单的目录顺序，子菜单亦可
+ * Eg:
+ * p2: p2
+ * p1: p1
+ * p1-c2: p1-c2
+ * p1-c1: p1-c1
+ * -> 菜单顺序是
+ * p2
+ * p1
+ *   c2
+ *   c1
+ */
+const alias = require('./alias.json');
 
 const mapper = code => {
   return alias[code];
@@ -32,13 +47,15 @@ function helper({ dir, fPath }) {
       const name = sub.replace('\.md', '');
       return {
         title: mapper(name) || `${name}`,
+        key: name,
         path: `${prefixPath}/${fPath}/${name}`,
       }
     }
   }).filter(Boolean);
 
   return {
     title: mapper(fPath) || `${fPath}`,
+    key: fPath,
     path: `${prefixPath}/${fPath}/`,
     collapsable: true,
     children: Array.isArray(children) ? children : [children],
@@ -53,6 +70,24 @@ function sidebarHelper(dir = filePath) {
     });
 }
 
+
+function findIndex(value) {
+  return Object.keys(alias).findIndex(item => item === value)
+}
+
+function sortSidebar(sidebar) {
+  sidebar.sort((a, b) => {
+    return findIndex(a.key) - findIndex(b.key);
+  });
+  for (const item of sidebar) {
+    if (item && Array.isArray(item.children)) {
+      item.children = sortSidebar(item.children);
+    }
+  }
+  return sidebar;
+}
+
 module.exports = {
-  sidebarHelper
+  sidebarHelper,
+  sortSidebar,
 };

docs/.vuepress/utils/sidebarHelper.js

@@ -20,6 +20,13 @@ npm run docs
 touch docs/zh/test/README.md
 ```
 
+```sh
+# npm run docs
+? please input the docs model name:  model
+? please input the docs model alias name (default same as model name)? 
+? generator model path (etc: docs/zh/model) ? docs/zh
+```
+
 `Eg: File Path`
 
 ```sh
@@ -46,11 +53,54 @@ docs/zh
 │   │   └── README.md
 ```
 
+**模板文件**
+`plop-templates/docs/zh/README.md.hbs`
+
+<<< @/plop-templates/docs/zh/README.md.hbs
+
+## 新建 Code 模板 + 单测模板
+
+```sh
+npm run template-docs
+```
+
+```sh
+? please input the name:  template
+? please input the docs model alias name (default same as model name)? 
+? Do you want test file ?  Yes
+? generator path (etc: src/template) ? src
+? generator model path (etc: docs/zh/model) ? docs/zh
+```
+
+**模板文件**
+
+`plop-templates/code/__tests__.ts.hbs`
+
+<<< @/plop-templates/code/__tests__.ts.hbs
+
+`plop-templates/code/index.ts.hbs`
+
+<<< @/plop-templates/code/index.ts.hbs
+
+`plop-templates/code/README.md.hbs`
+
+<<< @/plop-templates/code/README.md.hbs
+
+## 文档顺序
+
+::: tip
+`alias.json` 的顺序就是文档的顺序
+:::
+
 ## 配置别名
 
-我们不支持中文名文件夹, 所以你需要给文件名配置别名, 只需要在`docs/.vuepress/utils/alias.js`中配置 `key-value`值即可
+::: tip
+通过使用 [新建文件](#新建文件) 的脚本来动态配置 `alias`, 妈妈再也不用担心我找不到配置了。
+:::
+
+我们不支持中文名文件夹, 所以你需要给文件名配置别名, 只需要在`docs/.vuepress/utils/alias.json`中配置 `key-value`值即可
 
-<<< @/docs/.vuepress/utils/alias.js
+<<< @/docs/.vuepress/utils/alias.json
 
 ## 图片
 

docs/zh/how-to-write-docs/README.md

@@ -48,7 +48,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged",
+      "pre-commit": "npm run changelog && npm run deploy && lint-staged",
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   },