perf(scripts): 修改lint脚本，优化markdown文档格式化配置 (#85)

Author: 微信公众号：储凡

.dockerignore

@@ -1 +1,4 @@
-node_modules
+node_modules
+.idea
+.github
+.husky

.github/workflows/CI.yaml

@@ -65,7 +65,7 @@ jobs:
 
       - name: Code LintFix
         run: |
-          ./scripts/lint --fix
+          bash ./scripts/lint
 
       - name: Build Site
         run: |

.gitignore

@@ -7,76 +7,33 @@ logs
 .DS_Store
 */.vscode
 .idea
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# docs/.vuepress
-pids
-*.pid
-*.seed
-*.pid.lock
-
 # Coverage directory used by tools like istanbul
 coverage
 *.lcov
-
 # nyc test coverage
 .nyc_output
-
-
 # Dependency directories
 node_modules/
 jspm_packages/
-
 # TypeScript v1 declaration files
 typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
 # Optional npm cache directory
 .npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
 # Output of 'npm pack'
 *.tgz
-
-
-# dotenv environment variables file
-.env
-.env.test
-
 # parcel-bundler cache (https://parceljs.org/)
 .cache
-
 # Next.js build output
 .next
-
 .nuxt
 dist
-
 # Gatsby files
 .cache/
-
-
 # vuepress build output
 # .vuepress/dist
-
-## static resource
 docs/.vuepress/.cache/
 docs/.vuepress/.temp/
 docs/.vuepress/dist/
-
-
 # TernJS port file
 .tern-port
-/docs/.vuepress/.temp/
 /.husky/

.markdownlint.js

@@ -1,4 +1,4 @@
-// 参考：https://github.com/updownpress/markdown-lint/tree/master/rules
+// 参考：<https://github.com/updownpress/markdown-lint/tree/master/rules>
 module.exports = {
   "default": true,
   "MD001": false,
@@ -69,4 +69,4 @@ module.exports = {
   "MD042": false,
   "MD046": false,
   "MD049": false
-}
+}

.markdownignore renamed to .markdownlintignore

@@ -1,3 +1,5 @@
 **/node_modules/**
-CHANGELOG.md
 LICENSE
+.idea
+.husky
+.github

package.json

@@ -9,7 +9,6 @@
   },
   "scripts": {
     "preinstall": "chmod +x ./scripts/*",
-    "prepare": "rm -f .husky/pre-commit && husky install && npx husky add .husky/pre-commit \"./scripts/lint --fix\" && chmod +x .husky/pre-commit",
     "dev": "vuepress dev docs",
     "build": "vuepress build docs",
     "build:proxy": "./scripts/bundle build_proxy",

scripts/ci

@@ -37,4 +37,3 @@ fi
 
 # 安装项目依赖
 pnpm i --frozen-lockfile --registry https://registry.npmmirror.com
-

scripts/lint

@@ -1,26 +1,22 @@
-#!/usr/bin/env node
+#!/bin/bash
 
-/**
- *
- * 格式化代码
- * 例如：
- *   - ./scripts/lint
- *   - ./scripts/lint --fix
- */
+##
+## 自动格式化
+##  - 代码
+##  - markdown文档
+## 使用:
+#    - ./scripts/lint
+## 参考链接：
+##   - https://eslint.org/docs/latest/use/getting-started
+##   - https://github.com/igorshubovych/markdownlint-cli
+##
 
-const { execShell } = require('./.exec')
-const scriptName = process.argv[2]
-const fixed = scriptName != null ? '--fix' : '';
+# 设置 PATH 环境变量，避免command not found问题
+export PATH="$(pnpm bin):$PATH"
 
-// 格式化代码
-const lintCode = `eslint ${fixed} --ext .js,.ts,.vue --ignore-path .gitignore .`;
+# ESLint格式化代码
+eslint --fix --ext .js,.ts,.vue --ignore-path .gitignore .
 
-// 遍历格式化docs目录下的markdown 文档
-const lintMd = 'find docs -type f -name \"*.md\" -print0 | xargs -0 -I {} markdownlint  -c .markdownlint.js --fix {}';
-
-// 可以在--fix后指定目录
-(async () => await execShell([
-  lintCode,
-  lintMd
-]))()
+# markdown-cli格式化markdown 文档
+markdownlint '**/*.md'  -c .markdownlint.js -p .markdownlintignore --fix