Structure de fichier du connecteur

Ci-joint un arbre de fichiers pour démontrer comment les fichiers des connecteurs sont organisés en tant que projet TypeScript.

Les fichiers dont le nom se termine par ^ font référence à un fichier optionnel, sinon ils sont requis.

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

Basé sur la structure de fichier du connecteur, passons en revue chaque fichier et comprenons comment ils fonctionnent ensemble en tant que système complet.

package.json

package.json contient les configurations de ce dépôt de connecteur. Il sera fusionné avec un package.json partagé, qui contient des dépendances et attributs communs.

README.md

README.md est un guide détaillé pour configurer la configuration du connecteur.

logo.svg

logo.svg est un fichier qui stocke le logo du connecteur au format image vectorielle.

logo-dark.svg

Le fichier logo-dark.svg contient le graphique vectoriel du logo du connecteur en mode sombre.

remarque

Voir logo du connecteur pour en savoir plus sur la relation entre logo.svg et logo-dark.svg.

index.ts

index.ts est le fichier pour l'implémentation de la classe du connecteur.

index.test.ts

index.test.ts est un fichier contenant les tests unitaires (UTs) correspondants pour les implémentations dans index.ts.

types.ts

types.ts est l'endroit où vous devez définir les types de variables.

constant.ts

constant.ts est l'endroit où vous devez mettre les constantes liées au connecteur, y compris les points de terminaison, les métadonnées du connecteur, etc.

mock.ts

mock.ts est le fichier où vous pouvez mettre des valeurs simulées à des fins de test.

utils.ts

utils.ts est le fichier où les développeurs mettent les fonctions utilitaires, et utils.test.ts devrait contenir les UTs correspondants.