Elixir Phoenix Guidelines .cursorrules 提示文件

你是 Elixir、Phoenix 框架和函数式编程方面的专家。

核心原则

• 编写代码前仔细考虑所有因素和需求
• 使用函数式编程范式
• 利用管道操作符组合函数
• 使用模式匹配处理不同情况
• 遵循 Elixir 编码规范

技术栈

• 语言：Elixir
• 框架：Phoenix
• 数据库：PostgreSQL + Ecto
• 实时：Phoenix LiveView / Channels
• 容器：Docker
• 前端：Tailwind CSS
• 测试：ExUnit
• 安全：Sobelow
• 代码质量：Credo

最佳实践

项目结构

lib/
├── my_app/              # 业务逻辑
│   ├── accounts/        # 上下文模块
│   │   ├── user.ex      # Schema
│   │   └── accounts.ex  # 上下文 API
│   └── application.ex
├── my_app_web/          # Web 层
│   ├── controllers/
│   ├── live/
│   ├── components/
│   └── router.ex
└── my_app_web.ex

Ecto Schema

defmodule MyApp.Accounts.User do
  use Ecto.Schema
  import Ecto.Changeset

  schema "users" do
    field :name, :string
    field :email, :string
    field :role, Ecto.Enum, values: [:admin, :user]

    timestamps()
  end

  def changeset(user, attrs) do
    user
    |> cast(attrs, [:name, :email, :role])
    |> validate_required([:name, :email])
    |> validate_format(:email, ~r/@/)
    |> unique_constraint(:email)
  end
end

上下文模块

defmodule MyApp.Accounts do
  import Ecto.Query, warn: false
  alias MyApp.Repo
  alias MyApp.Accounts.User

  def list_users do
    Repo.all(User)
  end

  def get_user!(id), do: Repo.get!(User, id)

  def create_user(attrs \\ %{}) do
    %User{}
    |> User.changeset(attrs)
    |> Repo.insert()
  end
end

LiveView

defmodule MyAppWeb.UserLive do
  use MyAppWeb, :live_view

  def mount(_params, _session, socket) do
    {:ok, assign(socket, users: Accounts.list_users())}
  end

  def handle_event("delete_user", %{"id" => id}, socket) do
    user = Accounts.get_user!(id)
    {:ok, _} = Accounts.delete_user(user)
    {:noreply, assign(socket, users: Accounts.list_users())}
  end
end

关键约定

1. 提交消息规范

   <类型>[可选范围]: <描述>
   
   类型：fix, feat, build, chore, ci, docs, perf, refactor, style, test
   描述：用现在时态简要总结更改
   

2. 管道操作符

   user
   |> User.changeset(attrs)
   |> Repo.insert()
   

3. 模式匹配

   def handle_event({:ok, user}, state) do
     # 处理成功
   end
   
   def handle_event({:error, changeset}, state) do
     # 处理错误
   end
   

4. 代码质量工具

   • Sobelow：安全扫描
   • Credo：代码质量检查
   • ExCoveralls：测试覆盖率

安全实践

• 使用 Sobelow 进行安全审计
• 验证所有用户输入
• 使用 CSRF 保护
• 防止 SQL 注入（使用 Ecto）

测试规范

defmodule MyApp.AccountsTest do
  use MyApp.DataCase

  test "create_user/1 with valid data creates a user" do
    attrs = %{name: "John", email: "john@example.com"}
    assert {:ok, user} = Accounts.create_user(attrs)
    assert user.name == "John"
  end
end

Awesome Cursor Rules 中文版

🇨🇳 中文 | 🇺🇸 English

为中文开发者打造的 Cursor AI 编程规则集合 Chinese localized version of Awesome Cursor Rules

132 个规则文件 · 32 个技术领域 · 190 个技术文档 · 6,500+ 行代码

🚀 快速开始 · 📂 规则目录 · 💡 使用指南 · 📚 官网 · 🤝 贡献

---

📋 目录

• 这是什么？
• 什么是 .cursorrules？
• ✨ 特性亮点
• 🚀 快速开始
• 📂 规则目录
• 💡 使用指南
• 📊 数据统计
• 📚 文档
• 🤝 贡献
• 📄 许可证

---

这是什么？

Awesome Cursor Rules 是优秀的 Cursor AI 编程助手规则集合。本项目是其中文本地化版本，专为中文开发者优化：

• 🎯 精准翻译 — 高质量中文翻译，技术术语准确专业
• 📂 结构清晰 — 按技术领域分类，便于快速查找
• 🚀 开箱即用 — 复制 .cursorrules 文件即可开始使用
• 🌍 双语支持 — 完整的中英文文档对照
• ⚡ 132 个规则 — 涵盖前端、后端、移动端、AI、DevOps 等

🌐 在线文档: awesome-cursorrules-zh.js.org

---

什么是 .cursorrules？

.cursorrules 是 Cursor AI 编辑器的项目级配置文件，用于定义 AI 如何协助你的编程：

功能	说明	示例
编码规范	定义代码风格、命名约定	PascalCase 组件名、camelCase 函数名
技术栈	指定框架、库、工具链	React + TypeScript + Tailwind CSS
最佳实践	自动应用行业标准	错误处理、性能优化、安全策略
AI 行为	定制 AI 回复和代码生成风格	详细注释、函数式编程

💡 本质：给 AI 助手的"项目工作手册"，确保代码生成的一致性和高质量

---

✨ 特性亮点

🏆 热门技术栈

📊 覆盖领域

• 🌐 应用开发: 前端、后端、移动端、数据库、系统编程
• 🤖 AI 与数据: 机器学习、数据科学、数据工程
• ☁️ 基础设施: DevOps、云服务、边缘计算、安全
• 🔬 专业领域: 区块链、物联网、量子计算、生物科技

---

🚀 快速开始

安装使用

# 克隆仓库
git clone https://github.com/LessUp/awesome-cursorrules-zh.git

# 浏览可用规则
cd awesome-cursorrules-zh
ls rules/frontend/react/

使用方法

# 复制规则到你的项目
cp rules/frontend/react/nextjs-typescript/.cursorrules /你的项目路径/

完成！在 Cursor 中打开项目，AI 将自动遵循规则。

热门规则示例

技术栈	规则	命令
Next.js + TypeScript	nextjs-typescript	cp rules/frontend/react/nextjs-typescript/.cursorrules ./
Vue 3	composition-api	cp rules/frontend/vue/composition-api/.cursorrules ./
FastAPI	fastapi-api-example	cp rules/backend/python/fastapi-api-example/.cursorrules ./
Flutter	flutter-app-expert	cp rules/mobile/flutter/flutter-app-expert/.cursorrules ./

📖 完整快速开始指南

---

📂 规则目录

领域	目录	技术
前端	frontend/	React, Vue, Angular, Svelte, SolidJS, TypeScript
后端	backend/	Node.js, Python, Go, Java, PHP, .NET, Elixir
移动端	mobile/	Flutter, React Native, SwiftUI, Jetpack Compose
数据库	database/	云原生、时空数据库
系统编程	systems/	C++ 现代规范、Rust

领域	目录	技术
AI/ML	ai/	计算机视觉、MLOps、知识图谱、边缘 AI
数据科学	data-science/	Pandas, PyTorch, TensorFlow, Scikit-learn
数据工程	data/	Kafka, Spark, Flink, 数据仓库

领域	目录	技术
DevOps	devops/	Docker, Kubernetes, Terraform, CI/CD
云服务	cloud/	中间件、无服务器
边缘计算	edge/	AI 推理、模型压缩
安全	security/	零信任、隐私计算、同态加密

领域	目录	技术
区块链	blockchain/	Solidity, Web3, 智能合约, Foundry
物联网	iot/	嵌入式、数字孪生
量子计算	quantum/	量子纠错、超导计算
生物科技	bio/	生物电子、生物传感器
硬件	hardware/	神经形态芯片、光子计算
游戏开发	gaming/	DragonRuby, 云游戏

领域	目录	技术
开发工具	tools/	Convex, GitHub Quality
通用规范	general/	代码规范、风格一致性、测试

完整目录请查看 rules/ 文件夹

---

💡 使用指南

单技术栈项目

cp rules/frontend/react/nextjs-typescript/.cursorrules ./

多技术栈项目

方案一：合并规则

cat rules/frontend/react/nextjs-typescript/.cursorrules > .cursorrules
echo "" >> .cursorrules
cat rules/backend/python/fastapi-api-example/.cursorrules >> .cursorrules

方案二：目录级规则（推荐用于单体仓库）

project/
├── .cursorrules           # 通用规则
├── frontend/
│   └── .cursorrules       # 前端规则
└── backend/
    └── .cursorrules       # 后端规则

自定义规则

# 追加项目特定规则
cat >> .cursorrules << 'EOF'

## 项目自定义规则
- API 路由使用 /api/v1 前缀
- 所有模型必须包含 created_at 和 updated_at 字段
- 优先使用函数组件而非类组件
EOF

📖 完整最佳实践指南

---

📊 数据统计

指标	数值
规则文件	132 个 .cursorrules
技术领域	32 个分类
技术文档	190 个 Markdown 文件
总行数	6,500+ 行
翻译进度	100% 中英双语
覆盖范围	前端、后端、移动端、AI、DevOps、区块链、物联网等

热门技术

TypeScript  ████████████████████████████████  29 个规则
React       ██████████████████████            19 个规则
Tailwind    ███████████████                   13 个规则
Python      █████████████                     11 个规则
Next.js     ██████████                         8 个规则
Node.js     █████████                          7 个规则
Docker      █████████                          7 个规则

---

📚 文档

文档	说明	链接
🚀 快速开始	5 分钟上手指南	在线阅读 · GitHub
📖 安装指南	详细安装配置	在线阅读 · GitHub
💡 最佳实践	配置和使用建议	在线阅读 · GitHub
🔧 故障排除	问题诊断解决	在线阅读 · GitHub
📋 API 参考	规则格式参考	在线阅读 · GitHub
📝 更新日志	版本历史	中文 · English

---

🤝 贡献

欢迎所有形式的贡献：

• 🐛 报告问题 — 提交 Issue
• 🔧 改进内容 — 提交 Pull Request
• 🔄 同步上游 — 帮助与原项目保持同步
• 📝 完善文档 — 优化使用指南

详见 贡献指南

---

🙏 致谢

本项目是 PatrickJS/awesome-cursorrules 的中文本地化版本。感谢原作者和所有贡献者。

---

📄 许可证

MIT License

---

如果这个项目对你有帮助，请给一个 ⭐ Star！

🌐 访问官方网站 · ⬆ 返回顶部