# vue3-admin

**Repository Path**: atnx/vue3-admin

## Basic Information

- **Project Name**: vue3-admin
- **Description**: 基于vue3+ts的admin系统
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-26
- **Last Updated**: 2025-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 1.安装eslint

```bash
npx eslint --init
```

## 2.安装husky配置git钩子

```bash
pnpm install husky lint-staged -D
```

package.json添加以下配置

```json
  "scripts": {
    "dev": "vite",
    "build": "vue-tsc -b && vite build",
    "preview": "vite preview",
    "lint": "eslint",
    "lint:fix": "eslint --fix --quiet",
    "prepare": "husky"
  },
```

```json
  "lint-staged": {
    "src/**/*.{js,cjs,ts,vue}": [
      "npm run lint:fix"
    ],
    "src/**/*.{html,json,css,scss}": [
      "npx prettier --write"
    ]
  }
```

## 3.执行 npx husky init 生成.husky配置文件

修改pre-commit文本内容为
npx lint-staged

## 4.对提交的说明进行规范-commitlint

```bash
pnpm install @commitlint/config-conventional @commitlint/cli -D
```

4.1 在根目录创建commitlint.config.cjs文件

```js
module.exports = {
  extends: ["@commitlint/config-conventional"]
}
```

4.2 在.husky目录下创建commit-msg文件并输入:
npx commitlint --edit $1

提交信息的格式通常为：
<类型>(<范围>): <描述>
例如：
feat(user): add user login functionality
fix(api): resolve authentication bug

以下是常见的提交类型及其含义：
fix: 修复 bug（通常是代码中的错误）。
feat: 新增功能（通常是新功能或特性）。
perf: 性能优化（提升性能的代码更改）。
docs: 文档更新（如 README、注释等）。
style: 代码样式调整（如格式化、空格等，不涉及功能变更）。
refactor: 代码重构（既不修复 bug 也不新增功能，优化代码结构）。
test: 测试相关（如新增或修改测试代码）。
chore: 构建或工具链变更（如依赖更新、配置文件修改等）。
ci: CI/CD 相关变更（如 GitHub Actions、Travis CI 等配置）。
revert: 回滚之前的提交。