Connector-Dateistruktur

Anbei ist ein Dateibaum, der zeigt, wie die Dateien von Connectors als TypeScript-Projekt organisiert sind.

Dateien, deren Name mit ^ endet, beziehen sich auf eine optionale Datei, andernfalls sind sie erforderlich.

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^
    └── ...

Basierend auf der Connector-Dateistruktur gehen wir jede Datei durch und finden heraus, wie sie zusammen als ein Gesamtsystem funktionieren.

package.json

package.json enthält Konfigurationen dieses Connector-Repos. Es wird mit einem gemeinsamen package.json zusammengeführt, das allgemeine Abhängigkeiten und Attribute enthält.

README.md

README.md ist ein ausführlicher Leitfaden zum Einrichten der Connector-Konfiguration.

logo.svg

logo.svg ist eine Datei, die das Logo des Connectors im Vektorbildformat speichert.

logo-dark.svg

Die Datei logo-dark.svg enthält die Vektorgrafik des Logos des Connectors im Dunkelmodus.

hinweis

Siehe Connector-Logo, um mehr über die Beziehung zwischen logo.svg und logo-dark.svg zu erfahren.

index.ts

index.ts ist die Datei für die Implementierung der Connector-Klasse.

index.test.ts

index.test.ts ist eine Datei, die entsprechende Unit-Tests (UTs) für Implementierungen in index.ts enthält.

types.ts

In types.ts solltest du die Typen der Variablen definieren.

constant.ts

In constant.ts solltest du Konstanten im Zusammenhang mit dem Connector ablegen, einschließlich Endpunkten, Connector-Metadaten usw.

mock.ts

mock.ts ist die Datei, in der du möglicherweise simulierte Werte für Testzwecke ablegst.

utils.ts

utils.ts ist die Datei, in der Entwickler Hilfsfunktionen ablegen, und utils.test.ts sollte die dazugehörigen UTs enthalten.