diff --git a/AGENTS.md b/AGENTS.md index 7405bfd..4001896 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,218 +1,159 @@ # AGENTS.md - MyBlog 编码指南 -本文档为在此 VuePress 博客项目中工作的智能编码助手提供指南。 +AI 智能助手在此 VuePress 博客项目中的工作指南。 ## 项目概述 -这是一个基于以下技术构建的个人博客: -- **框架**: VuePress v2 (静态站点生成器) +- **框架**: VuePress v2(静态站点生成器) - **主题**: VuePress Theme Hope - **语言**: TypeScript + Vue 3 - **构建工具**: Vite - **包管理器**: npm -## 构建/代码检查/测试命令 +## 构建命令 -### 开发 ```bash -# 启动开发服务器 -npm run docs:dev +# 开发 +npm run docs:dev # 启动开发服务器 +npm run docs:clean-dev # 清除缓存后启动 -# 清除缓存后启动开发服务器 -npm run docs:clean-dev +# 构建与部署 +npm run docs:build # 生产构建 -# 构建生产版本 -npm run docs:build +# 维护 +npm run docs:update-package # 更新 VuePress 包 +npm run update:browsers # 更新 browserslist -# 更新 VuePress 包 -npm run docs:update-package - -# 更新 browserslist 数据库 -npm run update:browsers +# 类型检查 +npx tsc --noEmit # TypeScript 检查 ``` -### 测试与质量 -本项目没有配置显式的测试命令。由于是 VuePress 博客: -- package.json 中没有配置单元测试 -- 通过 `npm run docs:build` 进行构建验证 -- 通过 `npm run docs:dev` 进行开发服务器验证 +## 文件结构 -### 类型检查 -```bash -# TypeScript 类型检查(如果需要) -npx tsc --noEmit -``` - -## 代码风格指南 - -### 文件结构 ``` src/ -├── .vuepress/ # VuePress 配置 +├── .vuepress/ │ ├── config.ts # 站点配置 │ ├── theme.ts # 主题配置 -│ ├── navbar.ts # 导航栏配置 +│ ├── navbar.ts # 导航配置 │ ├── sidebar.ts # 侧边栏配置 -│ ├── styles/ # 自定义样式 +│ ├── styles/ # 自定义 SCSS │ └── components/ # Vue 组件 -├── programming/ # 编程相关文章 +├── programming/ # 编程文章 ├── apps/ # 应用部署指南 ├── tools/ # 工具分享 ├── work/ # 工作日志 └── README.md # 首页 ``` -### TypeScript 配置 -- **模块系统**: ES 模块 (package.json 中的 `"type": "module"`) -- **目标版本**: ES2022 -- **模块解析**: NodeNext -- **包含文件**: `src/.vuepress/**/*.ts` 和 `src/.vuepress/**/*.vue` +## 代码风格 -### 导入语句 -- 使用 ES 模块导入: `import { defineUserConfig } from "vuepress";` -- 需要时显式导入类型 -- 分组导入:框架导入在前,本地导入在后 -- 使用 config.ts 中定义的路径别名(如果可用) +### TypeScript +- **模块**: ES 模块(`"type": "module"`) +- **目标**: ES2022 +- **解析**: NodeNext +- 函数参数和返回值使用显式类型 +- 复杂数据结构使用接口 -### TypeScript 使用 -- 所有配置文件都使用 TypeScript -- 为函数参数和返回值定义显式类型 -- 对复杂数据结构使用接口 -- 结合 TypeScript 使用 Vue 3 的 Composition API +### 导入 +- 使用 ES 模块:`import { defineUserConfig } from "vuepress"` +- 分组导入:框架优先,本地其次 +- 使用 config.ts 中定义的路径别名 ### Vue 组件 -- 使用 Vue 3 Composition API 和 `