关于 neon-js
neon-js 是用于集成 Neon 统一 JavaScript SDK 的技能,面向需要身份验证和数据库查询的应用开发者。它提供设置指南、PostgREST 风格的数据访问参考,以及类型生成和迁移相关指导。
主要功能
- 01配置身份验证与数据 API 客户端
- 02使用 PostgREST 风格查询数据库
- 03支持生成类型的查询流程
- 04提供 BetterAuth 和 Supabase 适配器参考
- 05包含设置指南与代码模板
适用场景
- 01为 Next.js 应用配置认证和数据访问
- 02为现有认证接入数据库查询
- 03从 Supabase 迁移到 Neon
- 04为数据库查询配置生成类型
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ neondatabase/ ai-rules --skill neon-js安装后在 Claude Code 中输入/neon-js确认已加载。
附带文件guides/setup.mdtemplates/full-client.ts
详细介绍
Neon JS SDK 集成
在一个软件包中配置统一的 Neon JS SDK,用于身份验证和数据库查询。
何时使用此技能
- 构建同时需要身份验证和数据库查询的应用
- 从 Supabase 迁移到 Neon
- 使用 PostgREST 风格的 API 访问数据库
- 需要使用生成的类型进行类型安全的数据库查询
软件包:@neondatabase/neon-js(包含身份验证和数据 API 的完整 SDK)
只需要身份验证? 请改用 neon-auth 技能,以使用更精简的 @neondatabase/auth 软件包。
代码生成规则
生成 TypeScript/JavaScript 代码时,请遵循以下规则:
完整参考: 请参阅代码生成规则,了解:
- 导入路径处理(路径别名与相对导入)
- Neon 软件包导入(子路径导出、适配器模式)
- CSS 导入策略(Tailwind 检测、单一导入方式)
- 文件结构模式
要点:
- 生成导入语句前,检查
tsconfig.json中的路径别名 - 如果不确定或没有别名,请使用相对导入
BetterAuthReactAdapter必须从auth/react/adapters子路径导入- 适配器是工厂函数——请调用它们,即
() - 选择一种 CSS 导入方式(Tailwind 或 CSS,不能同时使用)
可用指南
每份指南都包含分阶段编号的完整独立操作流程:
guides/setup.md- Next.js 身份验证和数据 API 的完整配置指南
我会自动检测你的上下文(软件包管理器、框架、现有配置),并根据你的请求选择合适的指南。
如需排查问题,请参阅 references 中的故障排查指南。
快速示例
告诉我你要构建什么——其余工作交给我:
- “为我的 Next.js 应用配置 Neon JS” -> 加载完整全栈指南,配置身份验证和数据
- “在我的身份验证配置中添加数据库查询” -> 配置数据 API 客户端
- “从 Supabase 迁移” -> 使用 SupabaseAuthAdapter 以实现兼容性
参考文档
主要资源: 请参阅 neon-js.mdc,了解全面的指南,包括:
- 所有框架的客户端设置
- 数据库查询模式(PostgREST 语法)
- 身份验证适配器选项(BetterAuth、Supabase)
- 类型生成
- 错误处理
身份验证详情: 请参阅 neon-auth.mdc,了解:
- 所有身份验证方法
- UI 组件
- 会话管理
框架专属设置(选择你的框架):
框架专属 UI(选择你的框架):
Data API 和共享参考资料:
- Data API 参考 - PostgREST 查询模式和示例
- 常见错误 - 导入路径、适配器模式、CSS
- 故障排除指南 - 错误解决方案
- 代码生成规则 - 导入和 CSS 策略
- 身份验证适配器指南 - 适配器对比
- 导入参考 - 完整的导入路径
模板
templates/full-client.ts- 统一的身份验证 + 数据客户端配置
相关技能
- neon-auth - 仅身份验证(更小的包,不包含数据查询)
- neon-drizzle - Drizzle ORM 设置(PostgREST 的替代方案)
- neon-serverless - 直接数据库连接
- add-neon-docs - 将 Neon 最佳实践添加到你的项目中(设置后运行)
工作流
我将:
- 自动检测你的项目上下文(Next.js、React SPA、Node.js)
- 选择并加载相应的指南
- 按顺序遵循指南的各个阶段
- 使用指南中的工作流检查清单跟踪进度
- 仅在需要时加载参考文件
- 提议将 Neon 最佳实践添加到你的项目文档中
准备好开始了吗?只需描述你要构建的内容!
评论
支持 Markdown