fix: 基于Eslint规则修复一些文档格式问题 (#170)

* fix: 基于`Eslint`规则修复一些文档问题

* chore: update

---------

Co-authored-by: chufan <mmdapl@163.com>

Author: 微信公众号：储凡

code/algorithm/mergeLink.js

@@ -66,6 +66,4 @@ last.next = new ListNode(4)
 last.next.next = new ListNode(6)
 console.log('last:', last)
 console.log(Merge(pre, last))
-module.exports = {
-  Merge,
-}
+console.log(Merge1(pre, last))

code/algorithm/sword-point/isPopOrder.js

@@ -4,4 +4,7 @@
  * @param popV
  */
 function IsPopOrder(pushV, popV) {
+  console.log(pushV, popV)
 }
+
+console.log(IsPopOrder)

code/algorithm/sword-point/permutation.js

@@ -1,4 +1,4 @@
-function Permutation(str) {
+export function Permutation(str) {
   const result = []
   const i = 0
   while (i < str.length) {

code/algorithm/sword-point/reOrderArray.js

@@ -15,7 +15,8 @@
  */
 function reOrderArray(array) {
   // 奇数,偶数；
-  const oddArr = []; const evenArr = []
+  const oddArr = []
+  const evenArr = []
   for (let index = 0; index < array.length; index++) {
     if (array[index] % 2 !== 0) {
       // 奇数

code/design-patterns/lsp-demo.ts

@@ -2,7 +2,8 @@
  * 里氏替换原则Demo
  */
 
-namespace LspDemoFather{
+// eslint-disable-next-line ts/no-namespace
+namespace LspDemoFather {
   export class Rectangle {
     protected width: number
     protected height: number
@@ -24,13 +25,15 @@ namespace LspDemoFather{
       return this.width * this.height
     }
   }
+
   export function printArea(rectangle: Rectangle): void {
     rectangle.setWidth(4)
     rectangle.setHeight(5)
     console.log(`Area: ${rectangle.getArea()}`)
   }
 }
 
+// eslint-disable-next-line unused-imports/no-unused-vars,ts/no-namespace
 namespace LspDemo {
   import Rectangle = LspDemoFather.Rectangle
   import printArea = LspDemoFather.printArea

code/express/apps/error-handle-demo/app.js

@@ -4,7 +4,7 @@ const app = express()
 const port = 4000
 const appName = require('./package.json').name
 
-app.get('/', async (req, res) => {
+app.get('/', async (_req, _res) => {
   console.log('请求进来了...')
   throw new Error('手动抛错了！！')
 })

code/express/apps/static-source-demo/Readme.md

@@ -73,7 +73,7 @@ app.use('/static', express.static('public'))
 
 服务启动后，在浏览器中访问：
 
-```js
+```textmate
 http://localhost:3000/static/css/style.css
 http://localhost:3000/static/js/app.js
 http://localhost:3000/static/images/bg.png

code/express/apps/static-source-demo/app.js

@@ -1,6 +1,7 @@
 const express = require('express')
 
 const app = express()
+// eslint-disable-next-line import/order
 const path = require('node:path')
 // 服务启动端口
 const port = 3000

code/express/apps/template-demo/app.js

@@ -33,7 +33,7 @@ app.use((req, res, next) => {
 /**
  * 错误处理中间件
  */
-app.use((err, req, res, next) => {
+app.use((err, req, res, _next) => {
   res.locals.message = err.message
   res.locals.error = req.app.get('env') === 'development' ? err : {}
 
@@ -58,10 +58,12 @@ server.on('error', (error) => {
   switch (error.code) {
     case 'EACCES':
       console.error(`${bind} requires elevated privileges`)
+      // eslint-disable-next-line node/prefer-global/process
       process.exit(1)
       break
     case 'EADDRINUSE':
       console.error(`${bind} is already in use`)
+      // eslint-disable-next-line node/prefer-global/process
       process.exit(1)
       break
     default:

code/express/apps/template-demo/routes/index.js

@@ -3,8 +3,10 @@ const express = require('express')
 const router = express.Router()
 
 /* GET home page. */
-router.get('/', (req, res, next) => {
-  res.render('index', { title: 'Express' })
+router.get('/', (req, res, _next) => {
+  res.render('index', {
+    title: 'Express',
+  })
 })
 
 module.exports = router

code/koa/koa-listen.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/order
 const Koa = require('koa')
 
 const app = new Koa()

code/koa/koa-response.js

@@ -12,6 +12,7 @@ app.use(async (ctx, next) => {
   if (!body || body.pipe)
     return
 
+  // eslint-disable-next-line node/prefer-global/buffer
   if (Buffer.isBuffer(body))
     body = body.toString()
   ctx.body = minify(body)

code/node/es6/es5-2009-lastIndexOf.ts

@@ -1,4 +1,4 @@
-const stu = ['Tom', 'Lisa', '142vip']
+const stu: string[] = ['Tom', 'Lisa', '142vip']
 
 // 输出 2，数组中角标为2对应的就是142vip
 console.log(stu.lastIndexOf('142vip'))

code/node/es6/es5-2009-reduceRight.ts

@@ -1,5 +1,3 @@
 const nums = [12, 14, 33, 25, 28]
 
-const reuslt = 1
-
 nums.reduceRight()

code/node/es6/es6-2015-map.ts

@@ -16,11 +16,14 @@ studentAgeMap.set('fairy', 24)
  * 根据映射关键字获取值
  */
 const age = studentAgeMap.get('fairy')
+// 打印
+console.log(age)
 
 /**
  * 返回集合中元素个数
  */
 const size = studentAgeMap.size
+console.log(size)
 
 /**
  * 根据键删除映射关系
@@ -40,11 +43,15 @@ studentAgeMap.clear()
  * 判断类型，返回对象object
  */
 const mapType = typeof studentAgeMap
+// 打印
+console.log(mapType)
 
 /**
  * 判断实例，返回true
  */
 const isMap = studentAgeMap instanceof Map
+// 打印
+console.log(isMap)
 
 /**
  * 循环处理

code/node/es6/es6-2015-set.ts

@@ -3,6 +3,9 @@
  */
 const stuSet = new Set([1, 2, 3])
 
+// 打印
+console.log(stuSet)
+
 /**
  * 利用add()方法创建Set集合
  */

code/node/lodash/demo-set.js

@@ -44,7 +44,9 @@ const userList = [
   { user: 'barney', age: 36, active: true },
   { user: 'fred', age: 40, active: false },
 ]
-console.log(_.filter(userList, (o) => { return !o.active }))
+console.log(_.filter(userList, (o) => {
+  return !o.active
+}))
 // => objects for ['fred']
 // The `_.matches` iteratee shorthand.
 console.log(_.filter(userList, { age: 36, active: true }))

code/orm/sequelize/apis-demo/sequelize-datatypes.js

@@ -1 +1,3 @@
 const { DataTypes } = require('sequelize')
+
+console.log(DataTypes)

docs/README.md

@@ -18,25 +18,25 @@ actions:
 features:
   - title: SOLO算法
     details: 习题整理，代码通过记录，个人实际解题思路，助力刷题通关
-    link: /solo-algorithm
+    link: /solo-algorithm/
   - title: Battle面试官
     details: 校招社招八股文集合，分享面经与常见面试题，总结面试套路、经验，对线、Battle面试官丝毫不慌
-    link: /battle-interview
+    link: /battle-interview/
   - title: 前端
     details: 熟练前端基础知识、常用框架，总结、提炼前端部署方案
-    link: /front-end
+    link: /front-end/
   - title: 后端
     details: 夯实基础、熟练使用框架，有一定封装能力。造轮子、定制化插件功能，保姆级开发、部署流程
-    link: /server-end
+    link: /server-end/
   - title: 微服务
     details: 网关、服务间调用、ELK、消息中间件等对开发有更高要求，学习技术无止境
-    link: /microservice
+    link: /microservice/
   - title: 开发技巧
     details: 知识很重要，技巧不可缺。汇总日常软件安装、基础编译、代码管理等琐碎小技巧
-    link: /develop-skill
+    link: /develop-skill/
   - title: 读书写作
     details: 代码虽好，读书提升更为重要，不可偏执一端。人文社科、生活百态都是职场、人生的软技能
-    link: /read-books
+    link: /read-books/
   - title: 自媒体
     details: 尝试尝试再尝试，等等我呀。一路磕磕绊绊，自认并无天赋，辛酸、冷暖自知。 做好当下，便是不辜负自己
     link: /wechat-list.html
@@ -48,7 +48,9 @@ features:
 ## 本地浏览【推荐】
 
 由于平台、网络等原因，在线浏览容易出现加载面、加载不出来等常见问题，因此非常建议在本地进行浏览、学习。
-**下面指令默认你已经安装[Git](https://git-scm.com/download)、[NPM](https://www.npmjs.com/)、[PNPM](https://www.pnpm.cn/)、[Yarn](https://yarn.bootcss.com/)、[Node](http://nodejs.cn)等环境，并对此有一定了解!**
+
+- \*下面指令默认你已经安装[Git](https://git-scm.com/download)、[NPM](https://www.npmjs.com/)、[PNPM](https://www.pnpm.cn/)、[Yarn](https://yarn.bootcss.com/)、[Node](http://nodejs.cn)
+  等环境，并对此有一定了解!\*\*
 
 ::: code-tabs#shell
 @tab PNPM（推荐）

docs/front-end/base-begin/javascript.md

@@ -129,24 +129,24 @@ son.money()
 
 ```js
 // 利用new Object() 创建对象
-let obj = new Object();
+const obj1 = new Object()
 
 // 利用对象字面量创建对象
-let obj = {}
+const obj2 = {}
 
 // 利用构造函数创建对象
-function creatObj(name, sex) {
-  this.name = name;
-  this.sex = sex;
+function CreatObj(name, sex) {
+  this.name = name
+  this.sex = sex
   this.test = function () {
     console.log('xxxx')
   }
 }
 
 // 创建
-let obj = new creatObj('xxx', 'xx');
+const obj = new CreatObj('xxx', 'xx')
 // 使用
-obj.test();
+obj.test()
 ```
 
 **构造函数是一种特殊的函数，主要用来初始化对象，即为对象成员变量赋初始值，总是与new一起使用。
@@ -201,7 +201,7 @@ creatObj.prototype.test = function () {
 
 ```js
 // 实例化对象中的_proto对象原型 和 构造函数中的原型对象prototype是等价的  输出结构为:true;
-console.log(obj.__proto__ === creatObj.prototype)
+// console.log(obj.__proto__ === creatObj.prototype)
 ```
 
 ### 构造函数
@@ -323,6 +323,7 @@ const fn = function () {
 ```js
 // 利用Function构造函数 【所有函数都是Function的实例】
 const fn = new Function('a', 'b', 'return a+b')
+console.log(fn)
 ```
 
 ### 调用方式
@@ -357,7 +358,9 @@ function Fn() {
   // ...
 }
 
-new Fn()
+const fn = new Fn()
+
+console.log(fn)
 
 // 绑定事件函数(例如：按钮点击事件)
 button.onclick = function () {
@@ -369,10 +372,10 @@ setInterval(() => {
   // ....
 }, 1000)
 
-// 立即执行函数（自动调用）
-(() => {
-  // .....
-})()
+  // 立即执行函数（自动调用）
+  (() => {
+    // .....
+  })()
 ```
 
 ### 内部的this指向
@@ -546,6 +549,7 @@ fn()
 ```js
 function fn() {
   const num = 10
+  console.log(num)
 
   // 函数内部定义函数
   function fun() {

docs/server-end/database/redis/哨兵模式.md

@@ -40,14 +40,14 @@ Redis的Sentinel系统是一个分布式的系统，可以在系统中配置一
 
 - redis-sentinel-26380配置文件
 
-@[code conf](@code/redis/sentinel/conf/redis-sentinel-26380.conf)
+@[code nginx](@code/redis/sentinel/conf/redis-sentinel-26380.conf)
 
 - redis-sentinel-26381配置文件
 
-@[code conf](@code/redis/sentinel/conf/redis-sentinel-26381.conf)
+@[code nginx](@code/redis/sentinel/conf/redis-sentinel-26381.conf)
 
 - redis-sentinel-26382配置文件
 
-@[code conf](@code/redis/sentinel/conf/redis-sentinel-26382.conf)
+@[code nginx](@code/redis/sentinel/conf/redis-sentinel-26382.conf)
 
 注意修改各容器redis映射的配置文件;

docs/server-end/es-version/ES5-2009.md

@@ -41,8 +41,8 @@ str.charAt(1)
 
 ```js
 // 转义字符可能支持的不是很好
-const msg = 'Hello \
-Dolly!'
+// const msg = 'Hello \
+// Dolly!'
 
 // 更安全的做法
 const newMsg = 'Hello ' + 'Dolly!'

docs/server-end/es-version/Readme-back.md

@@ -63,7 +63,8 @@ arr[1]() // 输出1
 
 ```js
 const PI = 3.14
-PI = 100 // 出错
+// 出错
+// PI = 100
 
 const arr = [10, 11]
 
@@ -73,7 +74,7 @@ arr[1] = 13
 console.log(arr) // 输出 [12,13]
 
 // 注意：这种修改不行，不要试图去修改内存地址
-arr = [12, 13]
+// arr = [12, 13]
 ```
 
 ## let const var的区别
@@ -113,12 +114,12 @@ console.log(my_name, my_age) // leo 20
 ```
 
 ```js
-const fn = () => {
+function fn() {
   console.log(123)
 }
 
-const sum = (a, b) => a + b
-const sum = a => a
+const sum1 = (a, b) => a + b
+const sum2 = a => a
 ```
 
 ## 箭头函数的this关键字
@@ -200,6 +201,7 @@ let arrayLike = {
 
 // 伪数组转换为数组
 let arr2 = Array.from(arrayLike) // ['a',''b,'c']
+console.log(arr2)
 
 // 函数统一处理每一项
 let arr3 = Array.from(arrayLike, item => {