Skip to content

Commit fc5acff

Browse files
committed
refactor: 项目终极精简与规范化
## 主要变更 ### 清理冗余文件 - 删除 .omc/ 目录(过时的项目记忆) - 删除 docs/ 下的架构文档、教程等冗余子目录 - 删除 eslint.config.mjs, .prettierrc, .prettierignore, .editorconfig - 删除 stats.json, validation-report.json(生成文件) ### 配置优化 - 精简 .markdownlint.json,排除 node_modules - 更新 package.json:简化脚本命令、降低 Node 版本要求 - 精简 .vscode/ 配置,仅保留必要扩展 - 更新 .gitignore ### 文档更新 - 重写 AGENTS.md - 精简为核心信息 - 重写 CLAUDE.md - 聚焦项目配置 - 更新 copilot-instructions.md ### 版本 - 升级至 2.3.0
1 parent 30b5cdc commit fc5acff

35 files changed

Lines changed: 57 additions & 7363 deletions

.editorconfig

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/copilot-instructions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Cursor AI 编辑器规则集合中文版 - 提供精选的 `.cursorrules` 规则
66

77
## 技术栈
88

9-
- Node.js 22+
9+
- Node.js 20+
1010
- VitePress 1.6+
1111
- markdownlint-cli2
1212

@@ -19,16 +19,16 @@ Cursor AI 编辑器规则集合中文版 - 提供精选的 `.cursorrules` 规则
1919
### 文件结构
2020

2121
- `rules/` - 规则文件(核心资产)
22-
- `zh/` `en/` - 站点正文
23-
- `public/` - 静态资源
22+
- `docs/zh/` `docs/en/` - 文档源文件
23+
- `zh/` `en/` - 站点页面(符号链接)
2424
- `.vitepress/` - 站点配置
2525

2626
### 开发命令
2727

2828
```bash
29-
npm run docs:dev # 开发
30-
npm run docs:build # 构建
31-
npm run check # 质量检查
29+
npm run dev # 开发
30+
npm run build # 构建
31+
npm run check # 质量检查
3232
```
3333

3434
## 注意事项

.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Dependencies
22
node_modules/
3-
.pnpm-store/
43

54
# Build output
65
dist/
76
.vitepress/dist/
87
.vitepress/cache/
98
.vitepress/.temp/
109

10+
# Generated files
11+
validation-report.json
12+
stats.json
13+
1114
# IDE
1215
.vscode/
1316
.idea/
@@ -26,9 +29,6 @@ npm-debug.log*
2629
.cache/
2730
temp/
2831

29-
# OMC (oh-my-claudecode)
30-
.omc/
31-
3232
# Environment files (security)
3333
.env*
3434

.markdownlint.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
{
2-
"MD001": false,
2+
"extends": "markdownlint/style/relaxed",
33
"MD004": false,
4-
"MD009": { "br_spaces": 2 },
5-
"MD012": false,
64
"MD013": false,
75
"MD022": false,
86
"MD024": { "siblings_only": true },
9-
"MD030": false,
107
"MD031": false,
118
"MD032": false,
129
"MD033": false,
1310
"MD034": false,
1411
"MD036": false,
15-
"MD040": false,
1612
"MD041": false,
1713
"MD047": false,
1814
"MD051": false,

.prettierignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

.prettierrc

Lines changed: 0 additions & 10 deletions
This file was deleted.

AGENTS.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,46 @@
22

33
## 项目定位
44

5-
本仓库是面向中文开发者的 Cursor 规则库与双语站点,目标是维持一个可稳定归档、可持续验证、可低成本接手的最终状态
5+
Awesome Cursor Rules 中文版 - Cursor AI 编辑器规则集合。提供 **132+**`.cursorrules` 规则文件,覆盖 **32+** 个技术领域
66

77
## 权威源
88

9-
- `rules/`:唯一规则资产源(132+ .cursorrules 文件)
10-
- `zh/``en/`:唯一公开站点正文源
11-
- `public/`:站点静态资源(logo、og-image)
12-
- `docs/`:内部开发文档,不参与公开站点发布
9+
| 目录 | 用途 |
10+
|------|------|
11+
| `rules/` | 规则资产源(.cursorrules 文件) |
12+
| `zh/` | 中文站点页面 |
13+
| `en/` | 英文站点页面 |
14+
| `docs/zh/` `docs/en/` | 文档源文件(zh/en 为符号链接) |
15+
| `public/` | 站点静态资源 |
1316

1417
## 技术栈
1518

1619
| 技术 | 版本 | 用途 |
1720
|------|------|------|
18-
| Node.js | >=22.0.0 | 运行时 |
21+
| Node.js | >=20.0.0 | 运行时 |
1922
| VitePress | ^1.6.4 | 静态站点生成 |
2023
| markdownlint-cli2 | ^0.22.1 | Markdown 检查 |
2124

2225
## 常用命令
2326

2427
```bash
25-
npm run docs:dev # 开发服务器
26-
npm run docs:build # 构建站点
27-
npm run check # lint + validate
28-
npm run ci # check + build
28+
npm run dev # 开发服务器
29+
npm run build # 构建站点
30+
npm run check # lint + validate
31+
npm run ci # check + build
2932
```
3033

3134
## 开发边界
3235

33-
- 不把 `docs/` 当作公开正文源
3436
- 不扩张 GitHub Actions
35-
- 不在生成产物里引入时间戳漂移
36-
- 对外文档优先中文,维护 `zh/` `en/` 信息对齐
37+
- 对外文档优先中文
38+
- `docs/` 仅存放文档源文件,不参与公开站点发布(通过符号链接引用)
3739

3840
## 提交规范
3941

4042
使用约定式提交:`feat`/`fix`/`docs`/`chore`/`translate`
4143

4244
## 相关文档
4345

44-
- [README.md](./README.md) - 项目说明
46+
- [CLAUDE.md](./CLAUDE.md) - Claude Code 项目配置
4547
- [CONTRIBUTING.md](./CONTRIBUTING.md) - 贡献指南

CLAUDE.md

Lines changed: 21 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1-
# CLAUDE.md - Claude Code 项目配置
1+
# CLAUDE.md
22

33
> 本文件为 Claude Code CLI 提供项目特定配置和指导。
44
55
## 项目概述
66

7-
**awesome-cursorrules-zh** 是一个 Cursor AI 编辑器规则集合网站,提供精选的 `.cursorrules` 规则文件,帮助开发者在使用 Cursor AI 时获得更好的代码辅助体验
7+
**awesome-cursorrules-zh** 是一个 Cursor AI 编辑器规则集合网站,提供精选的 `.cursorrules` 规则文件。
88

99
## 技术栈
1010

1111
| 技术 | 版本 | 用途 |
1212
|------|------|------|
13-
| Node.js | >=18.0.0 | 运行时 |
13+
| Node.js | >=20.0.0 | 运行时 |
1414
| VitePress | ^1.6.4 | 静态站点生成 |
15-
| Vue.js | 3.x | 前端框架 |
16-
| markdownlint-cli2 | ^0.17.2 | Markdown 检查 |
15+
| markdownlint-cli2 | ^0.22.1 | Markdown 检查 |
1716

1817
## 常用命令
1918

2019
```bash
21-
# 开发
22-
npm run docs:dev # 启动开发服务器
23-
24-
# 构建
25-
npm run docs:build # 构建静态站点
26-
npm run docs:preview # 预览构建结果
27-
28-
# 质量检查
29-
npm run lint # Markdown 格式检查
30-
npm run lint:fix # 自动修复格式问题
31-
npm run validate # 验证规则文件
32-
npm run stats # 生成统计数据
33-
npm run check # lint + validate
34-
npm run ci # check + build
20+
npm run dev # 启动开发服务器
21+
npm run build # 构建静态站点
22+
npm run preview # 预览构建结果
23+
npm run lint # Markdown 格式检查
24+
npm run lint:fix # 自动修复格式问题
25+
npm run validate # 验证规则文件
26+
npm run check # lint + validate
27+
npm run ci # check + build
3528
```
3629

3730
## 目录结构
@@ -40,14 +33,12 @@ npm run ci # check + build
4033
awesome-cursorrules-zh/
4134
├── .vitepress/ # VitePress 配置
4235
├── docs/ # 文档源文件
43-
│ ├── architecture/ # 架构文档
44-
│ ├── setup/ # 安装指南
45-
│ ├── tutorials/ # 使用教程
46-
│ ├── en/ # 英文文档
47-
│ └── zh/ # 中文文档
48-
├── rules/ # 规则文件 (核心)
36+
│ ├── zh/ # 中文文档
37+
│ └── en/ # 英文文档
38+
├── zh/ # 中文站点页面(符号链接)
39+
├── en/ # 英文站点页面(符号链接)
40+
├── rules/ # 规则文件(核心)
4941
├── scripts/ # 工具脚本
50-
├── specs/ # SDD 规范文档
5142
├── AGENTS.md # AI 助手工作指南
5243
└── CLAUDE.md # 本文件
5344
```
@@ -60,7 +51,6 @@ awesome-cursorrules-zh/
6051
2. 编写 `.cursorrules` 文件
6152
3. 编写 `README.md` 说明
6253
4. 运行 `npm run validate` 验证
63-
5. 更新统计数据
6454

6555
### 文档更新
6656

@@ -70,15 +60,7 @@ awesome-cursorrules-zh/
7060

7161
### 提交规范
7262

73-
使用约定式提交:
74-
75-
```
76-
feat: 添加新规则
77-
fix: 修复问题
78-
docs: 文档更新
79-
refactor: 重构
80-
translate: 翻译更新
81-
```
63+
使用约定式提交:`feat`/`fix`/`docs`/`chore`/`translate`
8264

8365
## 规则文件规范
8466

@@ -93,7 +75,6 @@ translate: 翻译更新
9375

9476
- 原则1
9577
- 原则2
96-
- 原则3
9778

9879
## 技术栈
9980

@@ -104,11 +85,6 @@ translate: 翻译更新
10485

10586
1. 实践1
10687
2. 实践2
107-
108-
## 关键约定
109-
110-
1. 约定1
111-
2. 约定2
11288
```
11389

11490
### 质量要求
@@ -128,9 +104,8 @@ translate: 翻译更新
128104

129105
| 工作流 | 触发 | 功能 |
130106
|--------|------|------|
131-
| quality-check.yml | push/PR | 质量检查 |
132-
| security.yml | 定时 | 安全审计 |
133-
| deploy.yml | push main | 部署 |
107+
| ci.yml | push/PR | 质量检查 + 构建 |
108+
| deploy.yml | push main | 部署 GitHub Pages |
134109

135110
## 注意事项
136111

@@ -141,6 +116,5 @@ translate: 翻译更新
141116

142117
## 相关文档
143118

144-
- [AGENTS.md](./AGENTS.md) - 详细的 AI 助手工作指南
119+
- [AGENTS.md](./AGENTS.md) - AI 助手工作指南
145120
- [CONTRIBUTING.md](./CONTRIBUTING.md) - 贡献指南
146-
- [specs/](./specs/) - Spec-Driven Development 规范

docs/README.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)