feat: 第三周笔记

docs/pages/conan2008/03-Week03-脚手架核心模块笔记.md

@@ -0,0 +1,124 @@
+### 脚手架 架构设计图
+![](images/03-脚手架设计图.png)<br />
+
+
+### require加载规则
+.js :  module.exports / exports
+.json:   会以JSON.parse 转化为对象
+.其他： 默认以.js解析   如果.txt文件内容是js 那么也可以正常解析
+
+
+### utils/log模块，增强npmlog日志功能：
+```javascript
+npmlog.level = process.env.LOG_LEVEL ? process.env.LOG_LEVEL : 'info' //判断debug模式
+npmlog.addLevel('success', 2000, { fg: 'green', bold: true });  //添加日志自定义指令
+npmlog.heading = 'yyds-cli'; // 增加前缀
+npmlog.headingStyle = { fg: 'yellow', bg: 'white' } // 修改前缀样式
+```
+
+
+### 脚手架核心模块： 初始化环境检测
+
+
+检测node版本
+使用semver进行版本比对，  semver可以进行兼容处理
+```javascript
+function checkNodeVersion() {
+   const currentVersion = process.version;
+   const lowNodeVersion = constant.LOW_NODE_VERSION;
+   if (semver.lt(currentVersion, lowNodeVersion)) {
+      throw new Error(colors.red(`Node版本错误， 不能低于${lowNodeVersion}`))
+   }
+}
+```
+用户权限检测
+使用root-check进行，降级处理，  防止有的是用root用户(sudo)的权限过高，没办法对文件等进行操作
+```javascript
+
+/**
+ * 检查用户目录是否正确
+ */
+const userHome = require('user-home');
+
+function checkUserHome() {
+   if (!userHome || !pathExists(userHome)) {
+      throw new Error(colors.red('用户主目录不正确！'))
+   }
+}
+```
+入参监测，兼容debug模式
+```javascript
+/**
+ * minimist(process.argv.slice(2)
+ * 输入yyds-cli --debug
+ * minimist(process.argv.slice(2) 输出为：{ _: [], debug: true }
+ */
+function checkInputArgs() {
+   const minimist = require('minimist'); // 处理入参
+   if (minimist(process.argv.slice(2)).debug) {
+      process.env.LOG_LEVEL = 'verbose';
+   } else {
+      process.env.LOG_LEVEL = 'info';
+   }
+
+   log.level = process.env.LOG_LEVEL
+}
+```
+检查用户环境变量， 当不存在时给予默认值
+
+
+dotenv.config 把环境变量文件中的属性 加载到 node的环境变量中 process.env
+```javascript
+/**
+ * 检查/设置 环境变量
+ */
+function checkEnv() {
+   const dotenv = require('dotenv')
+   const envPath = path.resolve(userHome, '.env');
+   if (pathExists(envPath)) {
+      dotenv.config({
+         path: envPath
+      })
+   }
+
+   setEnvDefaultConfig();
+
+   log.verbose('环境参数', process.env.CLI_HOME_PATH);
+}
+
+function setEnvDefaultConfig() {
+   const cliConfig = {
+      home: userHome
+   }
+
+   if (process.env.CLI_HOME) {
+      cliConfig['cli_home'] = path.join(userHome, process.env.CLI_HOME);
+   } else {
+      cliConfig['cli_home'] = path.join(userHome, constant.CONFIG_CLI_HOME);
+   }
+
+   process.env.CLI_HOME_PATH = cliConfig.cli_home;
+}
+```
+检查本地脚手架版本， npm上有新版本提示更新， 并显示对应的版本号
+```javascript
+/**
+ * 检查npm版本
+ */
+async function checkGlobalUpdate() {
+   // 获取当前版本信息
+   const currentNpmVersion = pkg.version;
+   const npmName = pkg.name;
+
+   // 获取线上版本信息
+   const { getLastVerion } = require('@yyds-cli/get-npm-info');
+   const lastVersion = await getLastVerion(npmName, currentNpmVersion);  //get-npm-info包内有详细代码
+
+   // 比对版本信息
+   if (lastVersion && semver.lt(currentNpmVersion, lastVersion)) {
+      log.warn(colors.yellow(`请升级到最新版本, 当前版本为: ${currentNpmVersion}, 最新版本为: ${lastVersion}, 更新命令: npm install -g ${npmName}`));
+   }
+}
+```
+
+

docs/pages/conan2008/04-Week04-命令注册和执行笔记.md

@@ -0,0 +1,194 @@
+**核心：基于 Commander 完成脚手架命令注册和命令执行过程开发**
+**
+#### 脚手架优化架构图：
+![](images/04-脚手架架构优化.jpeg)<br />
+
+
+
+
+#### Command基类核心代码：
+```javascript
+class Command {
+  constructor(argv) {
+    console.log("argv:", argv)
+    // 校验入参
+    this.validateArgv(argv)
+
+    this._argv = argv
+    this.runner = new Promise((resolve, reject) => {
+      let chain = Promise.resolve()
+      chain = chain.then(() => this.checkNodeVersion()) // 检查node版本
+      chain = chain.then(() => this.initArgv()) // 初始化参数， 把cmd分离
+      chain = chain.then(() => this.init()) // 初始化
+      chain = chain.then(() => this.exec()) // 执行
+      chain.catch(err => {
+        log.error(err.message)
+      })
+    })
+  }
+
+  ...
+}
+```
+
+
+#### exec类核心代码：
+
+- 主要是处理包的加载与更新
+- 获取执行文件地址， 加载并使用node 多进程child_process执行
+- 兼容不同系统(win, linux)
+```javascript
+// 缓存目录位于用户主目录下的 .yyds-cli，如果没有生成该目录时，我们可以手动创建，或者通过如下代码生成：
+const userHome = require('user-home');
+const fse = require('fs-extra');
+const path = require('path');
+
+const cachePath = path.resolve(userHome, '.imooc-cli'); // 生成缓存目录路径
+
+fse.mkdirpSync(cachePath); // 生成缓存目录
+
+```
+
+
+#### execCommand 设计流程图：
+
+
+![](images/04-命令动态加载架构设计.jpeg)
+
+
+#### execCommand
+```javascript
+// 需要安装的包（执行）
+const SETTING = {
+  init: '@yyds-cli/init'
+}
+
+// 缓存目录(.yyds-cli/CACHE_DIR)
+const CACHE_DIR = 'dependencies'
+
+async function exec() {
+  let targetPath = process.env.CLI_TARGET_PATH;
+  let storePath = ''
+  let pkg;
+  const homePath = process.env.CLI_HOME_PATH;
+
+  const cmdObj = arguments[arguments.length - 1];
+  const cmdName = cmdObj.name();
+  const packageName = SETTING[cmdName]
+  const packageVersion = 'latest'
+
+  /* 安装更新命令包 start */
+  if (!targetPath) {
+    // 未指定targetPath -- 线上
+    targetPath = path.resolve(homePath, CACHE_DIR)
+    storePath = path.resolve(targetPath, 'node_modules')
+
+    pkg = new Package({
+      targetPath,
+      storePath,
+      packageName,
+      packageVersion
+    });
+
+    if (await pkg.exists()) {
+      // 更新package
+      await pkg.update()
+    } else {
+      // 安装package
+      await pkg.install()
+    }
+  } else {
+    // 用户指定了targetPath -- 本地
+    pkg = new Package({
+      targetPath,
+      packageName,
+      packageVersion
+    });
+  }
+  /* 安装更新命令包 end */
+
+  // 执行动态加载命令
+  const rootFile = pkg.getRootFilePath()
+  if (rootFile) {
+    try {
+      // require(rootFile)(Array.from(arguments))
+      const argv = Array.from(arguments)
+
+      /** start: argv中的cmd很大， 有许多冗余字段， 需要去除 */
+      const newCmdArgv = Object.create(null) // 纯净的对象， 没有原型链
+      const cmd = argv[argv.length - 1]
+      Object.keys(cmd).forEach(key => {
+        if (cmd.hasOwnProperty(key) && !key.startsWith('_') && key !== 'parent') {
+          newCmdArgv[key] = cmd[key]
+        }
+      })
+      argv[argv.length - 1] = newCmdArgv
+      /** end: argv中的cmd很大， 有许多冗余字段， 需要去除 */
+
+      const code = `require('${rootFile}')(${JSON.stringify(argv)})`
+      // stdio: 'inherit' -> 将所有的子进程输出流 直接输出到 主进程中
+      const child = spawn('node', ['-e', code], {
+        cwd: process.cwd(),
+        stdio: 'inherit'
+      })
+
+      child.on('error', e => {
+        log.error(e.message)
+        process.exit(1)
+      })
+
+      child.on('exit', e => {
+        console.log('命令正确执行完毕', e)
+        process.exit(e)
+      })
+    } catch (err) {
+      log.error(err.message)
+    }
+  }
+}
+```
+
+
+**try catch 异常-异步的捕获不到，  异步任务 异常需要单独捕获**
+
+
+#### 写代码中遇到的问题汇总：
+```javascript
+// 初始化尝试结构 结果报错SyntaxError: Rest element must be last element
+// ...rest只能出现在最后
+initArgv() {
+  	// 错误
+    [...this._argv, this._cmd] = this._argv
+    console.log('argv', this._argv)
+    console.log('_cmd', this._cmd)
+
+  	// 正确
+  	// slice(start, end) 包括start 不包括end
+  	this._cmd = this._argv[this._argv.length - 1]
+    this._argv = this._argv.slice(0, this._argv.length - 1)
+  }
+// 测试代码
+const obj = {	
+  a: 10,	
+  b: 20,	
+  c: 30	
+};	
+const {...rest, a} = obj;    // → SyntaxError: Rest element must be last element
+```
+
+
+#### node子进程， child_process理解
+**
+exec、execFile、spawn、fork 都用来创建子进程
+exec、execFile 底层都是使用spawn实现
+spawn 可以 逐步输出信息， exec、execFile类似同步，最终输出信息
+fork是增强版本的spawn， fork可以与父进程通信??， 使用send 和 on api
+
+
+`process.cwd()` 方法返回 Node.js 进程的当前工作目录。
+
+child_process  stdio: 'inherit'，  这个参数会把子进程同步给父进程， 父进程在控制台输出的效果为 会出现执行进度条， 否则不出现
+
+课程中的这个场景`require(rootFile)(Array.from(arguments))`，主进程一直在等待子进程回调，所以处于等待状态，我们项目用多进程提升性能是不明显的，多进程最典型的一个应用场景就是下载，当需要下载大文件时，可以同时启动多个进程进行下载，下载完毕后进行文件合并，这个场景比较典型。
+
+node.js 是单线程的，如果某一个操作需要消耗大量资源和时间，会导致程序整体性能下降。我们可以创建子进程，让子进程去跑那些费时费力的操作，而主线程该干嘛干嘛。子进程间可以共享内存，通过互相通信来完成数据的交换。