GitGud

Gitgud

Introdução

O Gitgud é um repositório de código aberto projetado para fornecer aos iniciantes e desenvolvedores experientes uma plataforma para aprender e aprimorar suas habilidades Git. O repositório é construído com o objetivo de proporcionar uma experiência de aprendizado interativa para desenvolvedores de todos os níveis de habilidade. Se você está começando com o Git ou procurando melhorar suas habilidades existentes, o Gitgud fornece um extenso conjunto de recursos e ferramentas que podem ajudá -lo a dominar o Git. O Gitgud permite visualizar e utilizar totalmente o GIT ao longo de seus projetos. Ele é criado usando tinta que fornece a mesma experiência de construção de interface do usuário baseada em componentes que o React oferece, mas em uma interface de linha de comando (CLI).

Requisitos

• Tem pelo menos o git versão 2.24.3 instalado
• Tem o npm instalado
• Não recomendamos o uso do ITERM2 para Gitgud devido a problemas de renderização. Hyper ou o terminal padrão são boas alternativas.

---

Instalação

 $ npm install --global gitgud

---

Isso instalará o pacote globalmente

Uso

 $ GitGud

• Navegue para qualquer projeto que tenha um diretório Git e execute o comando 'Gitgud'. Isso carregará a interface do usuário Gitgud na janela do seu terminal

• A interface do usuário do Gitgud consiste em: mudanças não agendadas, mudanças encenadas, visualização de árvore do ramo Git e botões de funcionalidade

• Navegue pela interface do usuário com o botão 'guia' ou teclas de seta esquerda/direita

• Pressione o botão 'Enter/Return' para selecionar/clicar em uma opção

• Em todo o aplicativo, você pode pressionar o botão 'esc (escape) para voltar

• Você pode sair do aplicativo executando Ctrl + C

---

Funcionalidade

• Mudanças de estágio

  • Você pode selecionar STAGE/UNSTAGE (all files) para mover todos os arquivos entre as alterações do estágio e as alterações do Desembrage.
  • Se você clicar, assim que ele moverá todos os arquivos da seção 'Alterações não estudadas' da interface do usuário para 'Alterações no estágio'. Se você clicar novamente, ele desfazerá as 'alterações encenadas' e moverá os arquivos de volta para 'Alterações não estudadas' e assim por diante.
  • Você também tem a opção de encenar/soltar arquivos individuais navegando através deles com as teclas UP/Down.
  • Pressione 'ESC' para sair do menu de alterações no estágio.

• Cometer mudanças

  • Ele solicitará que você insira uma 'mensagem de confirmação' que não exige que você envolva a entrada nas aspas. Depois de inserir e enviar a mensagem de confirmação, ele executa o compromisso e o traz de volta ao menu principal.
  • Pressione 'ESC' para sair de alterações de confirmação.

• Empurre mudanças encenadas

  • Isso levará as alterações encenadas para a filial atual em que você está.
  • Você pode ver em que ramo você está no topo da GUI.

• Filial de checkout

  • Ele exibirá a lista de todas as ramificações do projeto. As filiais não são selecionáveis, elas estão lá para ajudá -lo a ver quais ramificações locais estão disponíveis para alternar.
  • Você é solicitado a entrar em uma filial para fazer o checkout. Se você inserir uma filial que não existe, ela criará uma nova.
  • Se você tiver alterações sem gravação, um erro será mostrado e ele abortará a operação de check -out, informando que você tem alterações sem gravação e para comprometer ou esconder as alterações antes de trocar as ramificações. Você pode pressionar 'esc' para voltar e esconder/comprometer as mudanças antes de tentar fazer o checkout novamente

• Excluir ramo

  • Ele exibirá a lista de ramificações que não são selecionáveis, elas estão lá para ajudá -lo a ver quais ramificações locais estão disponíveis.
  • Você é solicitado a inserir um nome de ramificação e, se a filial existir, ele excluirá/removerá e o trará de volta ao menu principal. Se a filial não existir, ele lançará um erro.
  • Pressione 'ESC' para sair da filial de exclusão

• Acesse a árvore de madeira completa

  • Ele renderizará toda a árvore de madeira que se sobrepõe à GUI Gitgud.
  • Pressione 'ESC' para sair da árvore de madeira

---

Estilo

O Gitgud permite que os usuários personalizem a aparência e a sensação do aplicativo editando o 'Stylefile'.

Para acessar o 'arquivo de estilo' de um gitgud instalado globalmente, você precisará primeiro descobrir onde o NPM está salvando seus arquivos instalados globalmente. Para fazer isso, execute o seguinte comando:

 npm root -g

Isso retornará o local dos pacotes NPM instalados globalmente.

No Mac, você deve ver algo assim: /usr/local/lib/node_modules

No Windows, você pode obter o seguinte: *C: Users You AppData Roaming npm node_modules

Navegue até onde seus pacotes globais são armazenados, abra a pasta Gitgud e, em seguida, abra o arquivo de estilo em um editor (o comando: nano styleFile.js o abrirá na maioria dos sistemas Mac/Linux).

Quando você abrir o arquivo, ficará assim:

• showLogo :

  • Por padrão, isso está definido como false , mas se você deseja que o logotipo do Gitgud na parte superior da sua GUI possa alterar isso para true .

• defaultColor :

  • Esta é a cor para os principais blocos de texto em todo o aplicativo.

• accentColor :

  • Esta é a cor das fronteiras do aplicativo, bem como alguns cabeçalhos de texto em todo o aplicativo.

• gitTreeColor :

  • Esta é a cor da fonte Git Tree em todo o aplicativo.

• appResize :

  • Isso permite que o aplicativo seja responsivo, permitindo que os usuários redimensionem suas janelas de console sem precisar reiniciar o aplicativo. Isso pode diminuir o desempenho para alguns usuários.

• showFlag :

  • Permite que o usuário tenha escolhido se deve ou não exibir tags de saída Git pelos arquivos encenados/não registrados.
  • Definido como false por padrão.
  • Veja aqui para obter mais informações sobre tags de saída Git

---

Perguntas frequentes

---

Contribuindo

Gitgud é um projeto de código aberto e as contribuições são bem -vindas!

Ao enviar uma solicitação de tração, explique claramente o recurso que você adicionou ou o bug corrigido.

Os colaboradores iniciantes também são bem-vindos! Existem alguns problemas marcados com a good first issue . Este pode ser um bom lugar para iniciantes iniciarem!

Agradecemos a Joseph Garrone por nos dar o nome do pacote NPM.