Schemats 开源项目使用教程
1. 项目的目录结构及介绍
Schemats 是一个用于从 PostgreSQL 数据库模式生成 TypeScript 接口定义的开源工具。以下是其基本的目录结构:
schemats/
├── bin/
│ └── schemats.js
├── lib/
│ ├── index.js
│ ├── cli.js
│ ├── database.js
│ ├── generator.js
│ └── typescript.js
├── test/
│ ├── integration/
│ └── unit/
├── .gitignore
├── .npmignore
├── package.json
├── README.md
└── LICENSE
目录结构介绍
- bin/: 包含可执行文件
schemats.js
,用于命令行操作。 - lib/: 包含项目的主要逻辑文件,如
index.js
、cli.js
、database.js
、generator.js
和typescript.js
。 - test/: 包含单元测试和集成测试文件。
- .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
- .npmignore: 指定 npm 包发布时忽略的文件和目录。
- package.json: 包含项目的依赖、脚本和其他元数据。
- README.md: 项目的说明文档。
- LICENSE: 项目的开源许可证。
2. 项目的启动文件介绍
Schemats 的启动文件位于 bin/
目录下的 schemats.js
。这个文件是命令行接口的入口点,负责解析命令行参数并调用相应的功能。
#!/usr/bin/env node
const cli = require('../lib/cli');
cli.run();
启动文件介绍
- schemats.js: 使用 Node.js 环境执行,调用
lib/cli.js
中的run
方法来处理命令行参数。
3. 项目的配置文件介绍
Schemats 的配置主要通过命令行参数进行,没有独立的配置文件。用户可以通过命令行指定数据库连接参数、输出文件路径等。
常用命令行参数
-c, --conn
: 数据库连接字符串。-s, --schema
: 数据库模式名称。-o, --output
: 生成的 TypeScript 文件路径。-t, --tables
: 指定要生成的表,多个表用逗号分隔。-e, --extras
: 包含额外的 TypeScript 类型定义。
示例命令
schemats generate -c postgres://user:password@localhost/dbname -s public -o schema.ts
以上命令将连接到指定的 PostgreSQL 数据库,从 public
模式中生成 TypeScript 接口定义,并输出到 schema.ts
文件中。
通过以上教程,您应该能够了解 Schemats 项目的基本结构、启动文件和配置方式,并能够使用命令行生成 TypeScript 接口定义。