pgtyped 开源项目教程

pgtyped 开源项目教程

pgtypedpgTyped - Typesafe SQL in TypeScript项目地址:https://gitcode.com/gh_mirrors/pg/pgtyped

1. 项目的目录结构及介绍

pgtyped 项目的目录结构如下：

pgtyped/
├── bin/
├── docs/
├── examples/
├── packages/
│   ├── cli/
│   ├── core/
│   ├── esbuild-plugin/
│   ├── jest-preset/
│   ├── react/
│   ├── runtime/
│   ├── typescript/
│   └── webpack-loader/
├── scripts/
└── tests/

目录介绍

• bin/: 包含可执行文件。
• docs/: 包含项目文档。
• examples/: 包含使用示例。
• packages/: 包含各个子包，每个子包都有其独立的功能。
  • cli/: 命令行接口。
  • core/: 核心功能。
  • esbuild-plugin/: esbuild 插件。
  • jest-preset/: Jest 预设配置。
  • react/: React 相关功能。
  • runtime/: 运行时功能。
  • typescript/: TypeScript 相关功能。
  • webpack-loader/: Webpack 加载器。
• scripts/: 包含各种脚本文件。
• tests/: 包含测试文件。

2. 项目的启动文件介绍

pgtyped 的启动文件位于 packages/cli/src/index.ts。这个文件是命令行接口的入口点，负责解析命令行参数并调用相应的功能。

import { run } from './runner';
import { parseArgs } from './args';

const args = parseArgs();
run(args);

启动文件功能

• parseArgs(): 解析命令行参数。
• run(args): 根据解析的参数执行相应的操作。

3. 项目的配置文件介绍

pgtyped 的配置文件通常是一个 config.json 文件，位于项目根目录或用户指定的路径。配置文件的格式如下：

{
  "transforms": [
    {
      "mode": "sql",
      "include": "**/*.sql",
      "emitTemplate": "{{dir}}/{{name}}.queries.ts"
    }
  ],
  "srcDir": "./src",
  "failOnError": false,
  "camelCaseColumnNames": true
}

配置文件字段介绍

• transforms: 定义转换规则。
  • mode: 转换模式，例如 sql。
  • include: 包含的文件模式。
  • emitTemplate: 生成的文件模板。
• srcDir: 源代码目录。
• failOnError: 是否在遇到错误时终止。
• camelCaseColumnNames: 是否将列名转换为驼峰命名。

以上是 pgtyped 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 pgtyped。

pgtypedpgTyped - Typesafe SQL in TypeScript项目地址:https://gitcode.com/gh_mirrors/pg/pgtyped