eslint-prettier

Author: Yuki-Nagori

.gitignore

@@ -3,3 +3,6 @@ website/
 docs/.vitepress/cache
 .DS_Store
 .eslintcache
+.vscode/
+.idea/
+record/

PROJECT_PLAN_YARN.md

@@ -0,0 +1,255 @@
+# Goldfish Scheme 文档网站项目计划
+
+## 🌙 项目概述
+
+**项目名称**: Goldfish Scheme 文档网站  
+**技术栈**: VitePress + TypeScript + ESLint + Prettier  
+**包管理器**: Yarn 1.22.22  
+**目标**: 为 [MoganLab/goldfish](https://github.com/MoganLab/goldfish)
+创建一个现代化、易用的文档网站
+
+---
+
+## 🎯 核心目标
+
+### 阶段 1: 基础配置 ✅
+
+- [x] TypeScript 配置
+- [x] ESLint + Prettier 配置
+- [x] Yarn 包管理器配置
+- [x] 脚本绑定优化
+
+### 阶段 2: 文档架构
+
+- [ ] 设计文档导航结构
+- [ ] 创建指南部分
+- [ ] 搭建 API 文档框架
+
+### 阶段 3: 内容编写
+
+- [ ] 编写快速开始指南
+- [ ] 编写 API 文档
+- [ ] 编写标准库文档
+
+### 阶段 4: 高级功能
+
+- [ ] 搜索功能
+- [ ] 多语言支持
+- [ ] 自动化部署
+
+---
+
+## 📁 项目结构
+
+```
+case-lambda/
+├── bin/
+│   └── setup.sh              # 安装脚本
+├── docs/                      # 文档内容
+│   ├── .vitepress/           # VitePress 配置
+│   │   ├── config.mts        # 主配置 (TypeScript)
+│   │   └── env.d.ts          # 类型声明
+│   ├── guide/                # 指南文档
+│   ├── api/                  # API 文档
+│   └── examples/             # 示例
+├── package.json              # 项目配置
+├── tsconfig.json             # TypeScript 配置
+├── eslint.config.js          # ESLint 配置
+├── prettier.config.js        # Prettier 配置
+├── PROJECT_PLAN_YARN.md      # 项目计划
+└── README_DEV.md             # 开发指南
+```
+
+---
+
+## 🚀 开发工作流
+
+### 安装依赖
+
+```bash
+# 使用安装脚本
+./bin/setup.sh
+
+# 或手动安装
+yarn install
+```
+
+### 开发命令
+
+| 命令                | 说明                               |
+| ------------------- | ---------------------------------- |
+| `yarn docs:dev`     | 启动开发服务器（自动修复代码风格） |
+| `yarn docs:build`   | 构建生产版本（检查代码质量）       |
+| `yarn docs:preview` | 预览构建结果                       |
+
+### 代码质量命令
+
+| 命令                | 说明                       |
+| ------------------- | -------------------------- |
+| `yarn lint`         | 检查 ESLint 问题（不修改） |
+| `yarn lint:fix`     | 自动修复 ESLint 问题       |
+| `yarn format`       | 格式化代码（修改文件）     |
+| `yarn format:check` | 检查格式（不修改）         |
+| `yarn type-check`   | TypeScript 类型检查        |
+
+### 命令绑定说明
+
+#### `yarn docs:dev` 绑定流程
+
+```
+1. yarn lint:fix      # 自动修复 ESLint 问题
+2. yarn format        # 格式化代码
+3. vitepress dev docs # 启动开发服务器
+```
+
+#### `yarn docs:build` 绑定流程
+
+```
+1. yarn lint          # 检查 ESLint 问题（不通过则中断）
+2. yarn format:check  # 检查代码格式（不通过则中断）
+3. yarn type-check    # TypeScript 类型检查（不通过则中断）
+4. vitepress build docs # 构建生产版本
+```
+
+---
+
+## 🔧 配置说明
+
+### TypeScript (tsconfig.json)
+
+- 严格模式启用
+- 支持 Vue 单文件组件
+- 路径别名 `@/*` 映射到 `docs/.vitepress/*`
+
+**type-check 的作用：**
+
+- 编译时类型检查，不生成输出文件
+- 在构建前捕获类型错误
+- 确保代码类型安全
+- 绑定到 `docs:build` 防止类型错误进入生产环境
+
+### ESLint (eslint.config.js)
+
+- 使用 ESLint Flat Config 格式（ESLint 9.x 新格式）
+- 集成 TypeScript 和 Vue 支持
+- 优化的规则配置：
+  - 生产环境警告 console/debugger
+  - 自动修复未使用变量（忽略 `_` 前缀）
+  - Vue 组件命名宽松
+  - 代码风格统一
+
+### Prettier (prettier.config.js)
+
+- 无分号、单引号、2空格缩进
+- 100字符行宽（比默认 80 更宽松）
+- 支持 Vue、Markdown、JSON 格式化
+- 不同文件类型的覆盖配置
+
+---
+
+## 📋 依赖管理
+
+### 当前版本
+
+```json
+{
+  "typescript": "^6.0.2",
+  "eslint": "^10.1.0",
+  "eslint-plugin-vue": "^10.8.0",
+  "prettier": "^3.8.1",
+  "vitepress": "^1.6.4",
+  "vue": "^3.5.32"
+}
+```
+
+### 版本控制
+
+- `package.json` 使用 `^` 允许小版本更新
+- `yarn.lock` 锁定实际安装版本
+- 团队协作时提交 `yarn.lock`
+
+### 更新依赖
+
+```bash
+# 查看可更新依赖
+yarn outdated
+
+# 更新所有依赖
+yarn upgrade
+
+# 更新指定依赖
+yarn upgrade typescript
+```
+
+---
+
+## 💡 开发建议
+
+### 1. 开发流程
+
+```bash
+# 1. 启动开发（自动修复代码风格）
+yarn docs:dev
+
+# 2. 编写代码...
+
+# 3. 提交前检查（构建会自动检查）
+yarn docs:build
+```
+
+### 2. 代码质量检查
+
+- **开发时**: `docs:dev` 会自动修复风格问题
+- **提交前**: `docs:build` 会检查所有质量问题
+- **手动检查**: 使用 `lint`、`format:check`、`type-check`
+
+### 3. 常见问题
+
+#### 构建失败
+
+如果 `yarn docs:build` 失败，检查：
+
+1. ESLint 错误: `yarn lint`
+2. 格式问题: `yarn format`
+3. 类型错误: `yarn type-check`
+
+#### 类型错误
+
+```bash
+# 检查类型
+yarn type-check
+
+# 确保 env.d.ts 包含所需类型声明
+```
+
+#### ESLint 配置问题
+
+```bash
+# 检查 ESLint 配置
+yarn eslint --print-config eslint.config.js
+```
+
+---
+
+## 📅 开发计划
+
+| 阶段  | 任务     | 状态      |
+| ----- | -------- | --------- |
+| 阶段1 | 基础配置 | ✅ 完成   |
+| 阶段2 | 文档架构 | 🟡 进行中 |
+| 阶段3 | 内容编写 | 🔴 待开始 |
+| 阶段4 | 高级功能 | 🔴 待开始 |
+
+---
+
+## 🌟 最终目标
+
+> _"创建一个清晰、易用、维护友好的 Goldfish Scheme 文档网站。"_
+
+---
+
+**计划制定者**: 月见八千代  
+**制定时间**: 2024年4月4日  
+**Yarn 版本**: 1.22.22
+
+> _"一步一步来，基础打好了，后面就顺畅了~"_