連接器 (Connector) 檔案結構
以下是一個檔案樹,展示連接器作為 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
包含此連接器 repo 的配置。它將與共享的 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
實現的單元測試(UTs)的檔案。
types.ts
types.ts
是你應該定義變數類型的地方。
constant.ts
constant.ts
是你應該放置與連接器相關的常數的地方,包括端點、連接器中繼資料等。
mock.ts
mock.ts
是你可以放置測試用模擬值的檔案。
utils.ts
utils.ts
是開發人員放置工具函數的檔案,而 utils.test.ts
應包含相關的單元測試。