chore: type: modules

Author: 冯道廷

README.md

@@ -135,17 +135,69 @@
 #### 安装依赖
 
 ```
-npm install // yarn
+pnpm install
 ```
 
 #### 运行
 
 ```
-npm run dev // yarn dev
+pnpm run dev
+```
+
+关于执行指令的说明：
+
+```json
+"scripts": {
+		"dev": "vite",
+    /**
+    1、run-p 是 npm-run-all 包提供的一个命令，用于并行执行多个 npm 脚本，如果type-check失败，不会阻止vite build
+    2、type-check是一个用于在 Vue.js 项目中执行 TypeScript 类型检查的命令，它不会生成任何实际的编译输出文件，只进行类型检查。比如类型不匹配，属性不存在等
+    3、vue-tsc --noEmit 默认会使用项目根目录下的 tsconfig.json 文件进行类型检查。
+    4、如果想要在类型检查失败，构建命令不执行，可以改成run-s（串联），或者 npm run type-check && vite build
+    */
+		"build": "run-p type-check build-only",
+		"build-only": "vite build",
+		"prepare": "husky install",
+		"type-check": "vue-tsc --noEmit",
+		"changelog": "conventional-changelog -p custom-config -i CHANGELOG.md -s -r 0  -n ./changelog.config.js",
+
+    /**
+      运行后，对暂存区内容进行eslint和stylelint校验。校验配置如下：
+        "lint-staged": {
+            "*.{vue,ts,tsx,js,jsx,json}": [
+              "eslint --cache --quiet"
+            ],
+            "*.{css,less,vue}": [
+              "stylelint --cache --quiet"
+            ]
+          }
+    */
+		"lint-staged": "lint-staged",
+
+
+    /**
+      对整个项目进行eslint校验，但是不自动修复
+    */
+		"lint": "eslint --cache --cache-location node_modules/.cache/.eslintcache --ext .vue,.ts,.tsx,.js,.jsx,.json --quiet src/",
+    /**
+      对整个项目进行eslint校验，自动修复可以修复的。
+    */
+		"lint:fix": "eslint --cache --cache-location node_modules/.cache/.eslintcache --ext .vue,.ts,.tsx,.js,.jsx,.json --quiet src/ --fix",
+
+    /**
+      对整个项目进行stylelint校验，但是不自动修复
+    */
+		"stylelint": "stylelint \"src/**/*.{css,less,vue}\" --cache --cache-location node_modules/.cache/.stylelintcache",
+
+    /**
+      对整个项目进行stylelint校验，但是不自动修复
+    */
+    "stylelint:fix": "stylelint \"src/**/*.{css,less,vue}\" --cache --cache-location node_modules/.cache/.stylelintcache --fix"
+	},
 ```
 
 #### 构建
 
 ```
-npm run build // yarn build
+pnpm run build
 ```