Conceitos de esquemas personalizados

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Confira a seguir alguns conceitos e termos que você precisa conhecer ao trabalhar com esquemas personalizados no CodeCatalyst.

Projeto do esquema

Um projeto de esquema permite desenvolver e publicar esquemas em seu espaço. Um repositório de origem é criado durante o processo de criação do projeto, e o nome do repositório é aquele que você escolheu ao inserir os detalhes dos Recursos do projeto. Durante o processo de criação do esquema, se você optar por gerar uma versão do fluxo de trabalho, um fluxo de trabalho de publicação será criado no esquema com o Criador de esquema. O fluxo de trabalho publica automaticamente sua versão mais recente.

Esquemas de espaço

Você pode visualizar e gerenciar todos os esquemas na tabela Esquemas de espaço ao navegar até a seção Esquemas do seu espaço. Depois que são publicados em seu espaço, os esquemas são disponibilizados como um esquema de espaço para serem adicionados e removidos do catálogo de esquemas do seu espaço. Você também pode gerenciar as permissões de publicação e excluir esquemas na seção Esquemas do seu espaço. Para ter mais informações, consulte Visualização de detalhes, versões e projetos de um esquema personalizado.

Catálogo de esquemas de espaço

Você pode ver todos os esquemas personalizados adicionados no catálogo de esquemas de um espaço. É aqui que um membro do espaço pode escolher seu esquema personalizado para criar um projeto. Esse catálogo é diferente do catálogo do CodeCatalyst, que já tem esquemas disponíveis para todos os membros do espaço. Para ter mais informações, consulte Criando um projeto abrangente com CodeCatalyst plantas.

Síntese

A síntese é o processo de gerar um pacote de projeto do CodeCatalyst que representa o código-fonte, a configuração e os recursos em um projeto. O pacote é usado pelas operações da API de implantação do CodeCatalyst para implantar em um projeto. O processo pode ser executado localmente durante o desenvolvimento do esquema personalizado para emular a criação do projeto sem precisar criar um projeto no CodeCatalyst. Os comandos a seguir podem ser usados para realizar a síntese:

yarn blueprint:synth             # fast mode
yarn blueprint:synth --cache     # wizard emulation mode

O esquema é iniciado chamando a classe blueprint.ts principal com essa opção mesclada em defaults.json. Um novo pacote de projeto é gerado na pasta synth/synth.[options-name]/proposed-bundle/. A saída inclui o pacote de projeto que um esquema personalizado gera, dadas as opções definidas, incluindo as opções parciais que você pode ter configurado.

Ressíntese

A ressíntese é o processo de nova geração de um esquema com diferentes opções de esquema ou versões de esquema de projetos existentes. Como autor do esquema, você pode definir estratégias de mesclagem personalizadas no código do esquema personalizado. Você também pode definir limites de propriedade em um .ownership-file para especificar em quais partes da base de código um esquema pode ser atualizado. Embora o esquema personalizado possa propor atualizações para o .ownership-file, os desenvolvedores de projeto que usam o esquema personalizado podem determinar os limites de propriedade dos projetos. Você pode executar a ressíntese localmente, testar e atualizar antes de publicar seu esquema personalizado. Use os comandos a seguir para executar a ressíntese:

yarn blueprint:resynth             # fast mode
yarn blueprint:resynth --cache     # wizard emulation mode

O esquema é iniciado chamando a classe blueprint.ts principal com essa opção mesclada em defaults.json. Um novo pacote de projeto é gerado na pasta synth/resynth.[options-name]/. A saída inclui o pacote de projeto que um esquema personalizado gera, dadas as opções definidas, incluindo as opções parciais que você pode ter configurado.

Os seguintes conteúdos são criados após os processos de síntese e ressíntese:

Para saber mais sobre os pacotes de saída do esquema, consulte Gerar arquivos com ressíntese.

Opções parciais

Você pode adicionar variações de opções em src/wizard-configuration/ que não precisem enumerar toda a interface de Options, e as opções são mescladas no arquivo defaults.json. Isso permite que você personalize os casos de teste em opções específicas.

Exemplo:

Interface de Options:

{
  language: "Python" | "Java" | "Typescript",
  repositoryName: string
  ...
}

Arquivo defaults.json:

{
  language: "Python",
  repositoryName: "Myrepo"
  ...
}

Testes de configuração adicionais:

Projen

O Projen é uma ferramenta de código aberto que esquemas personalizados usam para se manterem atualizados e consistentes. Os esquemas vêm como pacotes do Projen porque essa estrutura permite criar, agrupar e publicar projetos, e você pode usar a interface para gerenciar as configurações de um projeto.

Você pode usar o Projen para atualizar os esquemas em grande escala, mesmo depois de criados. A ferramenta Projen é a tecnologia subjacente por trás da síntese do esquema que gera um pacote de projeto. O Projen possui a configuração de um projeto e isso não deve afetar você como autor do esquema. Você pode executar yarn projen para gerar novamente a configuração do projeto depois de adicionar dependências ou pode alterar as opções no arquivo projenrc.ts. O Projen também é a ferramenta de geração subjacente para esquemas personalizados para sintetizar um projeto. Para ter mais informações, consulte a página Projen no GitHub. Para saber mais sobre como trabalhar com o Projen, consulte a documentação do Projen.