커넥터 파일 구조

첨부된 파일 트리는 커넥터의 파일이 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를 포함해야 합니다.