Central de Conteúdos

Ritchie: como criar uma fórmula do zero

O processo para criar uma fórmula é feito através do comando rit create formula. Ele cria a estrutura necessária para o usuário começar a desenvolver uma nova fórmula em sua máquina local.

Antes de seguir as etapas para criar uma fórmula, é recomendável ter o Ritchie instalado e testado corretamente para garantir que todos os comandos estejam funcionando.

Criação da fórmula

Passo 1

Quando o comando rit create formula é executado no terminal, algumas informações são solicitadas ao usuário:

1. o novo comando de fórmula

O ideal é seguir o padrão rit + grupo + verbo + substantivo.

2. a linguagem de programação da nova fórmula

Um modelo Hello World será criado neste idioma.

3. o espaço de trabalho (path) onde a nova fórmula será adicionada

Pode ser um espaço de trabalho de fórmula existente. Se não houver nenhum disponível, um espaço de trabalho padrão da fórmula será criado automaticamente, denominado ritchie-formulas-local na HOME da máquina do usuário.

Criação de uma nova fórmula

O comando rit create formula também cria a fórmula automaticamente (gera os arquivos executáveis da fórmula e os adiciona à pasta .rit).

Isso significa que é possível executar o novo comando diretamente após sua criação. Nesse caso, o modelo da fórmula Hello World será executado como mostrado abaixo:

Execução do modelo Hello World

Atualmente, este modelo do Hello World é composto por 3 parâmetros de entrada:

  1. uma variável de texto
  2. uma lista de variáveis de texto
  3. uma variável booleana

Esses representam os três tipos de entradas disponíveis atualmente ao usar o Ritchie.

Passo 2

Estrutura da fórmula

Todas as áreas de trabalho de fórmulas do Ritchie seguem a mesma arquitetura. Você pode encontrar mais informações na seção de fórmulas.

Ao executar o comando rit create formula, a nova fórmula é adicionada ao espaço de trabalho informado, atualizando automaticamente a estrutura do espaço de trabalho com os arquivos de modelo do Hello World.

Estrutura do repositório ritchie-formula-local com o modelo para a formula rit demo create fórmula.

Passo 3

Implementação da fórmula

Com a nova estrutura de fórmula gerada com sucesso dentro da área de trabalho escolhida, é possível começar a implementar a nova automação, atualizando o modelo Hello World.

Para implementar a operação desejada, é necessário atualizar 3 arquivos localizados dentro do pacote / src da pasta raiz da nova fórmula:

  1. O arquivo config.json, para configurar as entradas da fórmula.
  2. O arquivo main (geralmente usado para extrair essas entradas)
  3. Os arquivos na pasta / pkg.

Observação: Dependendo da linguagem escolhida, pode ser necessário atualizar mais arquivos, por exemplo, para manipular dependências.

Algumas outras instruções:

❗Não altere o nome das pastas raiz da fórmula (grupo / verbo / substantivo) sem atualizar o tree.json e o Makefile (da área de trabalho) com os caminhos apropriados.

❗O tree.json e o Makefile (do repositório) já foram criados / atualizados executando o comando rit create formula. Conseqüentemente, você não precisará alterá-las para poder testar a nova fórmula, mesmo depois de alterar os arquivos comentados acima.

Passo 4

Testando a nova implementação da fórmula

Após a implementação da nova automação, é necessário executar o comando rit build formula para atualizar os arquivos executáveis da fórmula que foram gerados em sua criação.

Quando o comando rit build formula é executado no terminal, algumas informações são solicitadas ao usuário:

  1. o espaço de trabalho (path) em que a fórmula foi implementada
  2. o caminho para o pacote formula /src (grupo / verbo / substantivo, se esse padrão tiver sido seguido)

Compilação da formula

Após criar com êxito a fórmula, é possível executar o comando da fórmula novamente para ver a implementação atualizada.

Nota: o comando rit build formula também pode ser usado com uma flag “— — watch”
Usando esse sinalizador, o comando “vigia” automaticamente o pacote / src da formula especificada e atualiza os arquivos executáveis da fórmula se alguma alteração for salva pelo usuário.

Beta: atualmente, o comando rit build formula não está disponível no Windows para todas as linguagens de programação. A linguagem Golang é a única suportada por este comando no Windows até o momento. No entanto, todos os idiomas são suportados no Linux e MacOs.

Comunidade

✅ Parabéns, você criou sua primeira fórmula usando o Ritchie !

Para nós, o Ritchie é uma ferramenta comunitária em que cada indivíduo pode contribuir, compartilhando suas criações com o resto do mundo!

Sua fórmula pode ser útil para outras pessoas?

→ Compartilhe ela com a comunidade, abrindo uma pull request no repositório ritchie-formulas.

Guillaume Falourd
Back-end Developer
Zupper curioso, sempre procurando impactar da melhor forma as pessoas ao seu redor.

This website uses cookies to ensure you get the best experience on our website. Learn more