chore: Node cli

life/majiang.md

@@ -1,14 +1,17 @@
-
-# 组合
+# 胡牌组合
 
 + 234
 + 23334 (234 + 33)
 
+## 胡几张
+
+## 上听数
+
 ## 多面听
+
 + 23XXXXX (14)   (8张)
 + 2233XXX (23)   (4张)
 + 2345XXX (25)   (4张)
-
 + 2345666 (12457)(17张)
   + 3456777 (23568)
   + 4567888 (34679)

node/cli.md

@@ -3,22 +3,27 @@ date: 2021-01-28 22:18
 loc: 山西洪洞
 title: 如何使用 Node 开发一个命令行工具
 description: 一个 Node 脚本，一个 PATH 环境变量，npm 安装全局模块时是如何处理命令行脚本的？本文将引导你使用 Node 开发一个好用漂亮的命令行工具
+ps:
+  + 2021-08-15，环境变量 PATH 与可交互性内容的补充
 
 ---
 
 # 使用 Node 开发一个命令行工具
 
-使用 Node 开发一个命令行工具在工作中也较为常见，也很有意思，较为其它语言而言也更加简单，今天写一篇文章总结一下如何写一个友好健壮的 cli 工具
+使用 Node 开发一个命令行工具很有意思，较为其它语言而言也更加简单，今天山月写一篇文章总结一下如何写一个友好且健壮的 cli 工具。
 
-在阅读完本篇文章之后，可以阅读 Github 上的一篇文章: [Node CLI 工具最佳实践](https://github.com/lirantal/nodejs-cli-apps-best-practices)
+在阅读完本篇文章之后，**强烈推荐阅读** Github 上的一篇文章: [Node CLI 工具最佳实践](https://github.com/lirantal/nodejs-cli-apps-best-practices)。正如它的标题而言，在 Github 上用于 2000 颗星星的该文章的确称得上最佳实践。
 
-## 命令行工具
+## 命令行工具与环境变量 PATH
 
 什么是命令行工具？
 
-最初印象大致是 `ls`，`pwd` 这些能够**在终端执行的系统命令**，这样的命令有很多，数不胜数，被称为系统内置命令。如果使用 `which` 查看他们的来历，则能够发现他们的庐山真面目:
+最初印象大致是 `ls`，`pwd` 这些能够**在终端执行的系统命令**，这样的命令很多，数不胜数，被称为系统内置命令。
+
+如果使用 `which` 查看他们的来历，则能够发现他们的庐山真面目:
 
 ``` bash
+# 由此可知，pwd 为一个系统内置命令
 $ which pwd
 pwd: shell built-in command
 ```
@@ -31,7 +36,7 @@ pwd: shell built-in command
 + dig
 + man
 
-使用 `which` 侦查情况，发现他们实际执行的路径在某一个 bin 目录
+使用 `which` 追根究底，发现它们实际执行的路径在某一个 bin 目录
 
 ``` bash
 $ which top
@@ -41,27 +46,43 @@ $ which ps
 /bin/ps
 ```
 
-而这些 bin 目录在环境变量 PATH 中，豁然开朗。简而言之: **在 PATH 中路径的命令可在其它任意地方执行**。
+而这些 bin 目录在环境变量 PATH 中，豁然开朗。简而言之: **在环境变量的 PATH 中路径的命令可在其它任意地方执行**。
 
 ``` bash
 export PATH=$HOME/bin:/usr/local/bin:$PATH
 ```
 
-你好像想起点什么？在大学配置 Java 时被环境变量支配的各种恐惧？是了，所有语言的可执行命令都要放在 `PATH` 下，只不过其它语言自动给你做了，而 Java 让你自己做这件事。
+> 说起环境变量，你可以使用 `env` 列出所有的环境变量。
+> 
+> ``` bash
+> $ env
+> LANG=zh_CN.UTF-8
+> USER=root
+> LOGNAME=root
+> HOME=/root
+> PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin
+> ```
+
+你好像想起点什么？在大学配置 Java 时被环境变量支配的各种恐惧？
+
+是了，所有语言的可执行命令都要放在 `PATH` 下，只不过其它语言的安装工具自动给你做了这件事，而 Java 让你自己来处理它。
 
 + java
 + python
 + pip
 + node
 + npm
 
-开发命令行的原理也是如此，而本篇文章的目标就是:
+**开发命令行的原理也是如此，将你开发的命令行工具脚本置于环境变量 PATH 下的路径之中**，而本篇文章的目标就是:
 
-**使用 Javascript 这门前端开发者熟悉的语言，借助 Node 环境，开发一个命令行工具。**
+> 使用 Javascript 这门前端开发者熟悉的语言，借助 Node 环境，开发一个命令行工具。
 
 ## 原理
 
-先看两个命令行工具: `serve` 一个流行的静态文件服务器，`markdown` 一个我自己写的解析 URL 到 markdow 的命令行。通过命令解析出他们指向的符号链接
+先看两个 Node 的命令行工具:
+
++ `[serve](https://github.com/vercel/serve)` 一个流行的静态文件服务器，大名鼎鼎 Vercel 团队(Next.js 团队)的力作
++ `markdown` 一个山月自己写的解析 URL 到 markdow 的命令行。通过命令解析出他们指向的符号链接
 
 ``` bash
 $ ls -lah $(which serve)
@@ -71,29 +92,29 @@ $ ls -lah $(which markdown)
 lrwxr-xr-x  1 xiange  admin    48B  1 28 20:06 /usr/local/bin/markdown -> ../lib/node_modules/markdown-read/md-read-cli.js
 ```
 
-从中可以看出他们关于命令行的解析:
+从中可以看出关于 Node 全局命令行的原理:
 
-1. npm 全局下载 Package 到 /usr/local/lib/node_modules 下 (yarn 同理)
-1. 根据 package.json 中 bin 选项的指示，对应的二进制脚本挂载到 PATH 路径
+1. npm 全局下载某个 package 到路径 `/usr/local/lib/node_modules` 下 (yarn 同理，对应路径 `~/.config/yarn/global/node_modules`)
+1. 根据该库的 package.json 中 `bin` 字段的指示，把对应的命令行路径通过符号索引挂载到 PATH 路径
 1. 对应的二进制脚本添加 x 权限 (可执行文件权限)
 
-简而言之，Node 环境下的命令行工具，借助的原理无非是环境变量 Path 与一个符号链接
+简而言之，Node 环境下的命令行工具，借助的原理无非是**环境变量 Path**与一个**符号链接**
 
 ## 从 package.json 说起
 
-在 **package.json 中的 bin 选项**，用以指定最终的命令行工具的名字
+在 **package.json 中的 bin 字段**，用以指定最终的命令行工具的名字
 
 ``` json
 {
-  "bin": {
-    "markdown": "./md-read-cli"
+   "bin": {
+    "serve": "./bin/serve.js"
   }
 }
 ```
 
-如上所示，`markdown` 是最终在终端执行的命令，而 `./md-read-cli` 是该命令实际执行的文件。
+如上所示，`server` 是最终在终端执行的命令，而 `./bin/serve.js` 是该命令实际执行的脚本文件。
 
-对于最终可执行的命令行工具，Node 项目一般倾向置文件于 `bin` 目录下，如以下 Typescript 的配置:
+对于最终可执行的命令行工具，Node 项目一般倾向置文件于 `bin` 目录下，如以下 Typescript 关于它命令行的配置:
 
 ``` json
 {
@@ -116,22 +137,26 @@ lrwxr-xr-x  1 xiange  admin    48B  1 28 20:06 /usr/local/bin/markdown -> ../lib
 
 这一句话是啥子意思了？
 
-1. `#!` 后接解释器，标明该文件使用 `/usr/bin/env node` 来执行
+1. `#!` 加解释器，标明该文件使用 `/usr/bin/env node` 来执行
 1. `/usr/bin/env` 为 env 的绝对路径，用以在 PATH 路径中执行命令 (在各种不同的系统中，node 命令行的位置不同，因此使用 `env node` 找到路径并执行)
 1. `env node` 在人为层面可理解为执行 `node` 命令
 
-所以这句话的意思是: **使用 node 执行这个脚本**
+所以这句话的意思是: **使用 node 解释器来执行这个脚本，而通过 `env node` 能够正确定位到 node 解释器的位置**
 
 ``` bash
-// 不写 #!/usr/bin/env node
+// 如果不写 #!/usr/bin/env node，需要这么执行
 $ node serve .
 
-// 写上 #!/usr/bin/env node
+// 如果写上 #!/usr/bin/env node，可以直接执行
 $ serve .
 ```
 
 ## 解析命令输入
 
+在服务端应用中，可以通过 `request.url.querystring` 及 `request.body` 获取用户输入。
+
+而在命令行工具中，可通过 `progress.argv` 可获取用户输入。请看以下示例：
+
 ``` bash
 $ node cmd.js 1 2 3
 ```
@@ -147,7 +172,9 @@ $ node cmd.js 1 2 3
 process.argv
 ```
 
-根据解析 `process.argv` 来获取各式各样的参数作为命令行的输入，当然解析参数也要参照基本规律: 格式、可选、必选、简写、说明、帮助等等。[命令行工具命名协议](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html) 文章中已说的足够详细。
+根据解析 `process.argv` 可以定制格式来获取各式各样的参数作为命令行的输入。`
+
+当然解析参数也要参照 POSIX 兼容的基本规律: 格式、可选、必选、简写、说明、帮助等等。[命令行工具命名协议](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html) 文章中已说的足够详细。
 
 ``` bash
 // 一个较为规整的命令行帮助
@@ -168,12 +195,12 @@ Options:
                                             to the current working directory.
 ```
 
-以此衍生出了关于解析命令参数的多个库，在实际工作中就直接用吧！
+因为 POSIX 兼容繁杂的规则，以此衍生出了关于解析命令参数的多个库，站在巨人的肩膀上，在实际工作中就直接开用吧！
 
 + [yargs](https://github.com/yargs/yargs): Star 8.5K，周下载量 4900K
 + [commander](https://github.com/tj/commander.js): Star 19.7K，周下载量 5300K，tj 大神的作品
 
-使用 `commander` 解析不同的输入指令
+以下是一个 Demo: 使用 `commander` 解析不同的输入指令
 
 ``` js
 const { program } = require('commander')
@@ -190,13 +217,23 @@ const options = program.opts()
 console.log(options)
 ```
 
-## 丰富的色彩体验
+## 用户体验与丰富的色彩
 
 ![Next 构建输出](./assets/cli.png)
 
-目前大部分终端已支持彩色输出，丰富的高亮色彩如同代码高亮一样使用户可以快速抓住重点。把异常、警告、成功的信息用不同的颜色标出，命令行工具的输出一目了然。在现代构建工具，如 Webpack 下，也大都支持彩色输出。
+以上是 `next build` 命令行的标准输出，拥有色彩多样的高亮格式与丰富的列表展示，可以提供更丰富的用户体验。
+
+目前大部分终端已支持彩色输出，即通过 ANSI 编码进行控制，并拥有成熟的库控制色彩。如 [ansi-styles](https://npm.devtool.tech/ansi-styles)
+
+``` js
+import styles from 'ansi-styles';
+
+console.log(`${styles.green.open}Hello world!${styles.green.close}`);
+```
 
-以下是在命令行工具中常用的两个色彩库，支持多种多样色彩的输出。
+丰富的高亮色彩如同代码高亮一样使用户可以快速抓住重点。把异常、警告、成功的信息用不同的颜色标出，命令行工具的输出一目了然。在现代构建工具，如 Webpack 下，也大都支持彩色输出。
+
+以下是在命令行工具中常用的两个较为高级的色彩库，支持多种多样色彩的输出，当然基本原理仍是 ANSI 编码。
 
 + [chalk](https://www.npmjs.com/package/chalk)
 + [colors](https://www.npmjs.com/package/colors)
@@ -213,6 +250,18 @@ console.log(error('Error!'))
 console.log(warning('Warning!'))
 ```
 
+## 可交互性
+
+![enquirer prompt](https://raw.githubusercontent.com/enquirer/enquirer/master/media/heartbeat.gif)
+
+在 Web 中，可使用 Input 来展现丰富多彩的表单，如开关、多选、单选、输入框等。
+
+而在命令行工具中，也可借用多种库来实现强交互性。
+
++ [enquirer](https://www.npmjs.com/package/enquirer)
++ [ora](https://www.npmjs.com/package/ora)
++ [ink](https://www.npmjs.com/package/ink)
+
 ## 发布与安装
 
 在辛苦努力写完一个 cli 工具后，就是检验成果的时候。发布到 npm 仓库，可使所有人使用你的命令行工具，这也是最重要的一步
@@ -237,7 +286,6 @@ $ markdown https://shanyue.tech
 
 ## [#](#名字由来) 名字由来
 ```
-
 ## 总结
 
 本篇文章由浅至深讲解了以下几方面的内容:

node/cls.md

@@ -1,4 +1,5 @@
 date: 2020-04-10 20:00
+location: 北京市皂君庙
 
 ---
 

node/stringify.md

@@ -15,6 +15,10 @@ const user = {
 }
 ```
 
+在服务端向客户端发送数据时，需要把梳理好的 Object 序列化为可在 http 中传输的数据，如文本数据。因此，在服务端的末尾一般是进行序列化。
+
+在 Node 中借用 `JSON.stringify` 进行数据模型的序列化操作。
+
 ``` js
 const server = http.createServer((req, res) => {
   res.setHeader('Content-Type', 'application/json; charset=utf-8');
@@ -33,15 +37,20 @@ const user._user = user
 JSON.stringify(user)
 ```
 
+在服务端进行数据处理时，如果不小心混入了环形嵌套数据，则会构成序列化失败，造成意外情况，发生异常。
+
 ![circular](https://cdn.jsdelivr.net/gh/shfshanyue/assets@master/20210619/circular.1urtfrtgm1og.png)
 
+在实际生产环境中发生这种问题的概率极小，因为对于数据库中 ORM 而言，他们有专门的 `toJSON()` 进行序列化处理。
+
+即使出现嵌套数据，嵌套数据也会通过 `defineProperty` 定义 `enumerable: false` 使它不可枚举，而 `JSON.stringify` 会跳过不可枚举数据进行序列化。
+
 ## 更快的序列化
 
-+ [fast-json-stringify](https://github.com/fastify/fast-json-stringify): 2x faster than JSON.stringify()
+如果对一个对象进行序列化，那么它的时间复杂多是多少呢？
 
 ``` js
-// stringify 函数根据 schema 自动生成
-const stringify = (user) {
+const stringify = (user) => {
   return `{
     "id": ${user.id},
     "name": "${user.name}",
@@ -53,6 +62,10 @@ const stringify = (user) {
 stringify(user)
 ```
 
++ [fast-json-stringify](https://github.com/fastify/fast-json-stringify): 2x faster than JSON.stringify()
+
+
+
 `JSON Schema` 是基于 JSON 的 Schema，对 JSON 进行数据规范化及校验，并附有一份规范 [json-schema.org](http://json-schema.org/)。
 
 ``` json

post/js-puzzles.md

@@ -1,6 +1,6 @@
 # You-Dont-Know-JS 疑难汇总
 
-最近我看了 You-Dont-Know-JS 的两个小册，在看书的过程中，为了方便以后索引与更深入的了解，也为了避免遗忘，我对每一册的较为复杂的点做了总结，编辑如下
+最近山月看了 You-Dont-Know-JS 的两个小册，在看书的过程中，为了方便以后索引与更深入的了解，也为了避免遗忘，我对每一册的较为复杂的点做了总结，编辑如下
 
 <!--more-->