feat: 添加提交校验及自动格式化文件。

Author: Evansy

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit ""

.husky/common.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+command_exists () {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# Workaround for Windows 10, Git Bash and pnpm
+if command_exists winpty && test -t 1; then
+  exec < /dev/tty
+fi

.husky/lintstagedrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  '*.{js,jsx,ts,tsx}': ['eslint --fix', 'prettier --write'],
+  '{!(package)*.json,.!(browserslist)*rc}': ['prettier --write--parser json'],
+  'package.json': ['prettier --write'],
+  '*.vue': ['eslint --fix', 'prettier --write', 'stylelint --fix'],
+  '*.{vue,css,scss,postcss,less}': ['stylelint --fix', 'prettier --write'],
+  '*.md': ['prettier --write'],
+}

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+. "$(dirname -- "$0")/common.sh"
+
+pnpm type-check
+pnpm lint:style
+pnpm link:format
+pnpm link:lint-staged

.stylelintrc.cjs

@@ -0,0 +1,22 @@
+module.exports = {
+  // 注册 stylelint 的 prettier 插件
+  plugins: ['stylelint-prettier'], // 继承一系列规则集合
+  extends: [
+    // standard 规则集合
+    'stylelint-config-standard',
+    // standard 规则集合的 scss 版本
+    'stylelint-config-standard-scss',
+    // 样式属性顺序规则
+    'stylelint-config-recess-order',
+    // 样式属性 vue 规则
+    'stylelint-config-recommended-vue',
+    // 接入 Prettier 规则
+    'stylelint-config-prettier',
+    'stylelint-prettier/recommended',
+  ],
+  // 配置 rules
+  rules: {
+    // 开启 Prettier 自动格式化功能
+    'prettier/prettier': true,
+  },
+}

commitlint.config.js

@@ -0,0 +1,37 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+  // 忽略部分
+  ignores: [(commit) => commit.includes('init')],
+  // 继承的规则
+  extends: ['@commitlint/config-conventional'],
+  // 定义规则类型
+  rules: {
+    'body-leading-blank': [2, 'always'],
+    'footer-leading-blank': [1, 'always'],
+    'header-max-length': [2, 'always', 108],
+    'subject-empty': [2, 'never'],
+    'type-empty': [2, 'never'],
+    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat', // 新增feature
+        'fix', // 修复bug
+        'perf', // 优化相关，比如性能、体验的提升
+        'style', // 仅仅修改了空格、格式缩进、逗号等等，不改变代码逻辑;
+        'docs', // 	仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等;
+        'test', // 测试用例，包括单元测试、集成测试等
+        'refactor', // 代码重构，没有加新功能或者修复bug
+        'build',
+        'ci',
+        'chore', // 改变构建流程、或者增加依赖库、工具等
+        'revert', // 回滚到上一个版本
+        'wip',
+        'workflow',
+        'types',
+        'release',
+      ],
+    ],
+  },
+}

package.json

@@ -13,7 +13,10 @@
     "build-only": "vite build",
     "type-check": "vue-tsc --noEmit",
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
-    "format": "prettier --write src/"
+    "link:format": "prettier --write src/",
+    "link:lint-staged": "lint-staged -c ./.husky/lintstagedrc.js",
+    "lint:style": "stylelint --fix \"src/**/*.{css,scss}\"",
+    "prepare": "husky install"
   },
   "dependencies": {
     "@alova/scene-vue": "^1.0.4",
@@ -30,6 +33,8 @@
     "vue-router": "^4.1.6"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.6.5",
+    "@commitlint/config-conventional": "^17.6.5",
     "@iconify-json/ep": "^1.1.10",
     "@rushstack/eslint-patch": "^1.2.0",
     "@types/dompurify": "^3.0.2",
@@ -42,9 +47,20 @@
     "@vue/tsconfig": "^0.1.3",
     "eslint": "^8.40.0",
     "eslint-plugin-vue": "^9.11.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.2",
     "npm-run-all": "^4.1.5",
+    "postcss-html": "^1.5.0",
+    "postcss-scss": "^4.0.6",
     "prettier": "^2.8.8",
     "sass": "^1.62.1",
+    "stylelint": "^15.6.3",
+    "stylelint-config-prettier": "^9.0.5",
+    "stylelint-config-recess-order": "^4.0.0",
+    "stylelint-config-recommended-vue": "^1.4.0",
+    "stylelint-config-standard": "^33.0.0",
+    "stylelint-config-standard-scss": "^9.0.0",
+    "stylelint-prettier": "^3.0.0",
     "typescript": "~4.8.4",
     "unplugin-auto-import": "^0.15.3",
     "unplugin-icons": "^0.15.3",