命名风格

代码命名风格

• 变量总是使用小驼峰。
• 类，接口总是使用大驼峰。

文件命名风格

• 无特殊说明的情况，文件名（包括文件夹）一律使用 kebab-case，如：
  • functional-utils.ts
  • 一个理由是在 macOS 上，文件名是不区分大小写的
  • 这会被 unicorn/filename-case 规则检查
• 约定俗称的文件使用约定的名称，如：
  • README.md
• 测试文件以 .test.ts 结束，如：
  • io.test.ts

数据库命名风格

库名和表名都使用 snake_case。

Prisma

如果数据库是用Prisma生成的，那么schema.prisma文件中的表名应使用大驼峰，字段名应使用小驼峰.

但为了解决数据库中不区分大小写的问题，需要手动写map将表名和字段映射为下划线风格.

一个例子:

model User {
  id String @id @default(uuid())

  email                            String    @unique @db.Text
  passwordHash                     String    @map("password_hash") @db.Text
  name                             String?   @db.Text
  avatarUrl                        String?   @map("avatar_url") @db.Text

  createdAt DateTime @default(now()) @map("created_at") @db.Timestamp(3)
  updatedAt DateTime @updatedAt @map("updated_at") @db.Timestamp(3)

  @@map("user")
}