コネクタファイル構造

以下に、コネクタのファイルが 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 が含まれているべきです。