Drizzle DBML Generator 使用教程

1. 项目目录结构及介绍

Drizzle DBML Generator 是一个用于从 Drizzle ORM 定义的 schema 生成 DBML 标记的工具。以下是项目的目录结构及其简要介绍：

drizzle-dbml-generator/
├── .github/              # GitHub 工作流和其他 GitHub 相关配置
├── .vscode/              # Visual Studio Code 的项目配置
├── src/                  # 源代码目录
│   ├── dbml.ts           # 包含生成 DBML 的逻辑
│   └── schema.ts         # 包含 Drizzle ORM 定义的 schema
├── .eslintrc.json        # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .npmignore            # npm 忽略文件
├── .prettierrc.json      # Prettier 配置文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── package.json          # npm 项目配置文件
└── tsconfig.json         # TypeScript 配置文件

2. 项目的启动文件介绍

dbml.ts 是项目的启动文件，它负责调用 drizzle-dbml-generator 来生成 DBML 文件。以下是 dbml.ts 文件的主要内容：

import * as schema from './schema';
import { pgGenerate } from 'drizzle-dbml-generator';

const out = './schema.dbml';
const relational = true;

pgGenerate({
  schema,
  out,
  relational
});

这段代码导入了在 schema.ts 文件中定义的 schema，然后使用 pgGenerate 函数生成 DBML 文件。生成的文件将保存到当前目录下的 schema.dbml 文件中。

3. 项目的配置文件介绍

项目的配置文件主要包括 .eslintrc.json、.prettierrc.json 和 tsconfig.json。

• .eslintrc.json：ESLint 配置文件，用于定义代码风格和语法规则，确保代码质量。
• .prettierrc.json：Prettier 配置文件，用于统一代码格式，与 ESLint 配合使用，提高代码的可读性。
• tsconfig.json：TypeScript 配置文件，定义了 TypeScript 编译器的选项，包括模块解析、编译选项等。

这些配置文件帮助维护代码的一致性和质量，确保项目遵循一定的编码规范。