连接器文件结构

附上一个文件树，展示连接器的文件如何组织为一个 TypeScript 项目。

文件名以 ^ 结尾的文件是可选文件，否则为必需文件。

ConnectorRootDir/
├── package.json
├── README.md
├── logo.svg
├── logo-dark.svg^
└── src/
    ├── index.ts
    ├── index.test.ts
    ├── types.ts
    ├── constant.ts
    ├── mock.ts^
    ├── utils.ts^
    ├── utils.test.ts^
    └── ...

基于连接器文件结构，让我们逐一了解每个文件，并弄清它们如何作为一个整体系统协同工作。

package.json

package.json 包含此连接器仓库的配置。它将与共享的 package.json 合并，后者包含通用依赖项和属性。

README.md

README.md 是一个详细的指南，用于设置连接器的配置。

logo.svg

logo.svg 是一个以矢量图像格式存储连接器标志的文件。

logo-dark.svg

logo-dark.svg 文件包含连接器暗模式标志的矢量图形。

备注

查看 连接器标志 以了解更多关于 logo.svg 和 logo-dark.svg 之间的关系。

index.ts

index.ts 是连接器类实现的文件。

index.test.ts

index.test.ts 是一个包含 index.ts 实现的单元测试 (UT) 的文件。

types.ts

types.ts 是定义变量类型的地方。

constant.ts

constant.ts 是放置与连接器相关的常量的地方，包括端点、连接器元数据等。

mock.ts

mock.ts 是用于放置测试目的的模拟值的文件。

utils.ts

utils.ts 是开发人员放置实用函数的文件，而 utils.test.ts 应包含相关的 UT。