# eslint

**Repository Path**: five-tiger-generals/eslint

## Basic Information

- **Project Name**: eslint
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-08
- **Last Updated**: 2025-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vue 3 + Vite 项目

这是一个使用 Vue 3 + Vite 构建的现代化前端项目，集成了完整的代码质量工具链。

## 🛠️ 技术栈

- **框架**: Vue 3
- **构建工具**: Vite
- **包管理器**: pnpm
- **代码质量工具链**:
  - ESLint - JavaScript/TypeScript 代码检查
  - Stylelint - CSS 代码检查
  - Husky - Git hooks 管理
  - lint-staged - 暂存文件检查
  - Commitlint - Commit message 规范检查
  - Commitizen - 交互式 commit 工具

## ⚠️ 包管理器要求

本项目强制使用 [pnpm](https://pnpm.io/) 进行依赖管理，禁止使用 npm/yarn。
如用 npm/yarn 安装依赖会自动中断并提示错误。

安装依赖请使用：
```bash
pnpm install
```

## 🚀 开发命令

```bash
# 启动开发服务器
pnpm dev

# 构建生产版本
pnpm build

# 预览生产构建
pnpm preview
```

## 🔧 代码质量工具

### ESLint
```bash
# 检查代码
pnpm lint

# 自动修复
pnpm lint:fix
```

### Stylelint
```bash
# 检查样式
pnpm stylelint

# 自动修复样式
pnpm stylelint:fix
```

### 格式化所有文件
```bash
pnpm format
```

## 📝 代码提交规范

- 使用 `pnpm commit` 或 `npx git-cz` 进行交互式提交，选择中文类型提示。
- Commit message 必须以 `feat`、`fix`、`chore` 等类型开头，自动校验。
- 规范示例：
  ```
  feat: 新增用户登录功能
  fix: 修复导航栏样式错乱
  chore: 升级依赖
  ```

## 🎨 代码格式化和风格

- 项目统一使用 ESLint 进行格式化和风格校验。
- `.vue` 文件顺序强制为：`<template>` → `<script>` → `<style>`。
- 保存时自动修复格式和样式问题（VSCode 推荐安装 ESLint、Stylelint 插件）。

## 💡 推荐 VSCode 插件

- ESLint
- Stylelint
- Volar
- Prettier（可选，仅做 markdown 格式化）
- EditorConfig for VS Code

## ❓ 常见问题

- **npm/yarn 安装依赖报错？**
  请用 pnpm 安装依赖。

- **提交时报错？**
  请用 `pnpm commit`，并按提示选择类型。

- **格式化顺序不对？**
  请确保 VSCode 默认格式化器为 ESLint，保存时自动修复。

## 📁 项目结构

```
├── src/
│   ├── assets/          # 静态资源
│   ├── components/      # Vue 组件
│   ├── App.vue         # 根组件
│   ├── main.js         # 入口文件
│   └── style.css       # 全局样式
├── public/             # 公共资源
├── .husky/            # Git hooks 配置
├── eslint.config.js   # ESLint 配置
├── stylelint.config.js # Stylelint 配置
├── commitlint.config.js # Commitlint 配置
├── .czrc              # Commitizen 配置
└── package.json       # 项目配置
```

## 🎯 开发建议

1. **提交前检查**: 每次提交前会自动运行代码检查，确保代码质量
2. **使用规范提交**: 使用 `pnpm commit` 进行交互式提交，确保 commit message 符合规范
3. **及时修复**: 如果检查失败，请及时修复问题后再提交
4. **保持整洁**: 定期运行 `pnpm format` 保持代码格式一致

## 📄 许可证

MIT