Pular para o conteúdo principal

Estrutura de arquivos do conector

Anexado está uma árvore de arquivos para demonstrar como os arquivos dos conectores são organizados como um projeto TypeScript.

Arquivos cujo nome termina com ^ referem-se a um arquivo opcional, caso contrário, são obrigatórios.

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

Com base na estrutura de arquivos do conector, vamos examinar cada arquivo e entender como eles funcionam juntos como um sistema completo.

package.json​

package.json contém as configurações deste repositório de conector. Ele será mesclado com um package.json compartilhado, que contém dependências e atributos comuns.

README.md​

README.md é um guia elaborado para configurar a configuração do conector.

logo.svg​

logo.svg é um arquivo que armazena o logotipo do conector em formato de imagem vetorial.

logo-dark.svg​

O arquivo logo-dark.svg contém o gráfico vetorial do logotipo do conector no modo escuro.

nota

Veja logotipo do conector para saber mais sobre a relação entre logo.svg e logo-dark.svg.

index.ts​

index.ts é o arquivo para implementação da classe do conector.

index.test.ts​

index.test.ts é um arquivo que contém testes unitários (UTs) correspondentes para implementações em index.ts.

types.ts​

types.ts é onde você deve definir os tipos de variáveis.

constant.ts​

constant.ts é onde você deve colocar constantes relacionadas ao conector, incluindo endpoints, metadados do conector, etc.

mock.ts​

mock.ts é o arquivo onde você pode colocar valores simulados para fins de teste.

utils.ts​

utils.ts é o arquivo onde os desenvolvedores colocam funções utilitárias, e utils.test.ts deve conter os UTs relacionados.