DEV Community: Isa Giongo

Do Zero: git add -p - Qual é a desse comando simples e muito útil?

Isa Giongo — Sat, 26 Dec 2020 18:31:48 +0000

Se você está iniciando agora nos estudos e/ou carreira de desenvolvimento de software, provavelmente já deve ter criado seu GitHub e iniciando o versionamento dos seus projetos usando o Git, certo?

Se a resposta é "Ainda não 😔", fique tranquila! Aqui tem um tutorialzinho básico pra criar seu primeiro repositório no GitHub, versionar seu projeto e subir ele pro novo repositório, criando sua vitrine para expor seus projetos e estudos sobre programação.

Agora, se a resposta é "Claro! Já estou apanhando do Git!", você está no lugar certo!

Hoje, esse tutorial tem por objetivo falar um pouco sobre um dos comandos mais básicos do Git, o git add, porém abordando uma variante que vai te surpreender: o parâmetro "-p".

O comando "git add" é muito famoso por "adicionar conteúdo" (propor uma mudança qualquer, seja ela alterar, adicionar ou remover um conteúdo) de um arquivo local ao índice ou staging area, que terá a mudança confirmada, posteriormente, com o comando "git commit", e finalmente enviada ao repositório remoto pelo "git push".

Então, resumindo bem rasamente, esse conjunto de comandos, iniciado pelo git add, são os responsáveis por "salvar" nossas alterações no projeto:

Fiz uma alteração local em um ou mais arquivos
Vou propor essa mudança, com o comando git add, adicionando ela no índice(staging area).
Confirmo que quero realizar essa mudança com git commit, fazendo uma "captura/instantâneo" daquele estado do projeto, incluindo as mudanças propostas pelo git add.
Envio com git push esse "instantâneo" do meu repositório local para o repositório remoto.

Bom, mas o foco desse artigo é te dizer para que serve o tal do -p junto com o git add, então vamos ao que interessa!

Para introduzir o assunto, quero confessar que passei seis meses trabalhando como desenvolvedora e vários outros meses apenas estudando e sempre utilizava o git add da seguinte forma:

git add . que adicionava todos os arquivos/diretórios alterados (criados, modificados, deletados) à proposição de mudança do index.
git add meu_arquivo.java que adicionava apenas arquivos ou diretórios especificados por mim

E um belo dia, pareando com um colega de time, vi que ele utilizava o git add -p e que dessa forma conseguia, posteriormente, "organizar" melhor seus commits em etapas, agrupando alterações que tinham relação uma com as outras, o que no fim das contas produzia uma Pull Request muito mais fácil de analisar, mesmo que contivesse muitas alterações.

O parâmetro -p passado após o comando git add, é de "patch" ou "fragmento" em português, e permite que você selecione interativamente os "pedaços" que deseja adicionar ao índice e revise as diferenças antes de adicionar essas alterações.

Dessa forma, é possível adicionar aos poucos, agrupando para o commit, as alterações relacionadas e que façam sentido estar no mesmo commit.

A cada fragmento de alteração exibido (com as diferenças), é possível realizar algumas ações, dentre as quais, estão as que considero mais úteis, listadas abaixo:

y - adicione este pedaço de alteração
n - não adicione
d - não adicione este, nem os remanescentes do arquivo
a - adicione este e os outros pedaços restantes do arquivo
q - interrompe a adição, mantendo o que já foi adicionado

Na imagem seguinte temos os arquivos modificados em minha branch. Quero apenas adicionar os pedaços do arquivo TotalizerController.java, observando as diferenças que realizei.

Ao rodar o comando git add -p temos o seguinte:

Na primeira linha vemos o comando git diff e o nome do arquivo que está sendo "comparado" naquele momento.
Em verde, vemos a linha que foi adicionada neste arquivo. Se fosse uma linha removida, veríamos ela em vermelho.
E por último, vemos as opções disponíveis que foram citadas acima.

No vídeo abaixo, demonstro como ignorar algumas alterações (utilizando a opção - n) para que não entrem no commit específico que quero fazer de alterações no controller. Dessa forma, vou adicionar (com a opção y) apenas os pedaços que tenham ligação com essa alteração, e em seguida, interromper a adição (com a opção q) quando já tiver colocado no index os pedaços que quero commitar.

Viu como pode ser fácil organizar em commits distintos, agrupando as alterações de forma lógica, mesmo que tenhamos feito muitas mudanças?

Do Zero: Pareamento a distância? O CodeTogether pode deixar essa tarefa mais agradável!

Isa Giongo — Thu, 06 Aug 2020 11:20:57 +0000

Indo na linha dos plugins para IDE's que muito nos facilitam, hoje trago um pequeno post sobre o CodeTogether! (dá uma olhada abaixo no primeiro artigo dessa série, sobre o incrível Sonarlint)

Do Zero: Sonarlint - para que serve esse plugin e por que você não vai mais viver sem ele

Isa Giongo for Dev Girls ・ Jul 28 '20

#beginners #productivity #codequality #java

Esse plugin emergiu na lista de necessidades a partir desse momento de isolamento social 😷, onde é preciso que cada um esteja em sua casa, porém ainda estamos em times e seguimos com a necessidade e a vontade de parear (Se você ainda não sabe o que é ou como funciona o pareamento - ou ainda pensa que pode ser desperdício de tempo -, da uma olhada aqui).

O CodeTogether promete ser uma ferramenta de colaboração muito superior à experiência de parear apenas compartilhando a tela através das ferramentas conhecidas de vídeo-chamada, como o Hangouts, Meet, Zoom, Teams e etc, pois permite a real interação de ambas as partes envolvidas na tarefa.

Vamos para a prática então!

Primeiramente, é necessário que uma das pessoas que irá parear tenha uma conta no CodeTogether e instale o plugin na sua IDE.

Registro

Clique aqui e preencha as informações obrigatórias que são username, email e senha.

Download e Instalação

Aqui você vai fazer o download do CodeTogether de acordo com sua IDE (no momento, está disponível para Eclipse, IntelliJ e VsCode).

Para instalar no Eclipse, basta estar com o ele aberto e arrastar o botão Drag to Eclipse IDEs para dentro do Eclipse. O Eclipse Marketplace será iniciado e só você só precisa clicar em Install.

Para instalar no IntelliJ, basta clicar em Download for Jetbrains IDEs. Um arquivo .zip será baixado, e no IntelliJ você vai fazer o seguinte caminho: File, Settings..., Plugins e nos três pontinho perto de Installed, você vai clicar em Install Plugin from Disk... e selecionar o arquivo .zip que você baixou do site do CodeTogether.

Utilização

Para iniciar o pareamento, são três etapas: iniciar o compartilhamento, com o "Start Sharing", depois copiar o link de acesso em "Copy Invite URL" e por fim, a pessoa que irá parear, acessar esse link no seu navegador.

No IntelliJ, basta ir no menu View, Tool Windows, CodeTogether. Uma "janela" se abrirá na lateral direita da IDE. Clique em Start Sharing e em Copy Invite URL.

No Eclipse, basta clicar no menu Help, CodeTogether e Start Sharing. Uma "janela" vai se abrir na direita da sua IDE e basta clicar em Copy Invite URL.

Acesso ao código do host

Ao receber o link da pessoa que instalou o plugin do CodeTogether em sua IDE, basta acessá-lo de qualquer navegador.

A primeira tela, oferece as opções de tema preferido (Ligth ou Dark, para cada IDE) e também de atalhos de teclado, afinal você não tem que ser obrigada a aguentar aquele tema branco e apático que seu colega acha lindo!😆

Na sequência, vamos informar nosso nome, pois essa informação ficará visível para a pessoa que está pareando conosco.

Visualização do convidado através do navegador

A partir daí, começaremos a ter visualização e acesso ao código como se estivéssemos pareando lado a lado, diretamente na IDE de origem, inclusive com as facilidades como o auto-complete da IDE, facilitando a busca por classes, a nomear variáveis, e também os atalhos que estamos acostumados a utilizar no dia a dia para aumentar a produtividade.

Visualização do host na sua IDE

E aqui é como o host, que instalou o plugin, está vendo na sua IDE as ações da pessoa que está pareando com ele.

Claro que nem tudo são maravilhas🦄! A versão free do CodeTogether apresenta algumas limitações, dentre as quais a que mais nos afeta, que é a limitação de tempo do pareamento. Após 45 minutos de pareamento, a sessão é interrompida e é preciso clicar novamente no link de compartilhamento para voltar a visualizar e acessar a tela.(temporariamente, está tudo liberado do plano "Pro", por conta da pandemia do Covid)

De qualquer forma, é sim uma incrível melhoria na experiência do pareamento remoto, delegando a ação de compartilhar o código para uma ferramenta especializada - o super CodeTogether🚀, enquanto seguimos usando as ferramentas de vídeo chamada para o que elas fazem bem: vídeos chamadas.

Tem alguma dica de plugin ou ferramenta mágica para um próximo post dessa série? Deixa aqui nos comentários!

Image cover Designed by master1305 / Freepik

Do Zero: Sonarlint - para que serve esse plugin e por que você não vai mais viver sem ele

Isa Giongo — Tue, 28 Jul 2020 14:26:19 +0000

Se você está iniciando agora no mundo do desenvolvimento de software, provavelmente já deve ter a sua IDE escolhida e devidamente instalada, certo? Caso não tenha ainda (e talvez nem saiba o que é e para que serve), dá uma olhada nesse artigo introdutório aqui e também em algumas opções para Java aqui.

Com sua IDE já à postos, chegou a hora de conhecer um plugin que é muito útil e até, eu diria, essencial para nos auxiliar a escrever código com qualidade - o Sonarlint.

A grande vantagem dessa ferramenta é que ela nos ajuda a ver e a corrigir pontos negativos que talvez nem saibamos ainda que estão habitando nosso código: como possíveis bugs, nullpointers, condições desnecessárias e tudo aquilo que pode gerar códigos mal escritos e com problemas de qualidade.

Outra boa notícia acerca do Sonarlint, é que ele pode ser utilizado nas mais famosas IDE's, como por exemplo, Eclipse, IntelliJ e VS Code. E também, ele não está restrito a linguagem Java (minha queridinha 💘 ), mas também trabalha com Javascript, Python, Kotlyn, Ruby, Php, C#, dependendo da IDE escolhida.

A instalação é muito simples e rápida:

No Eclipse, basta ir no menu Help e Eclipse Marketplace. Buscar "Sonarlint" e clicar em "Install".
No IntelliJ, vá em "File", "Settings", "Plugins" e busque por Sonarlint e clique em "Install".

Nos dois casos, será necessário reiniciar a IDE para a alteração ser aplicada e o plugin funcionar efetivamente.

O Sonarlint é um detector, em tempo real, de códigos fedidos - que geram dificuldades de manutenção (leia mais aqui - em inglês), bugs 🐛 e vulnerabilidades. Para essas categorias, temos também o nível de severidade dos problemas, que são: Minor, Major, Critical e Blocker.

Em seu trabalho, o Sonarlint, sinaliza o trecho de código a ser corrigido/melhorado e ainda fornece uma explicação para o problema e como corrigí-lo, mostrando exemplos de código que não estão em conformidade com a regra e o exemplo de código em conformidade, isto é, a forma mais adequada de escrever aquele trecho. Mas são apenas sugestões, e não segui-las não quer dizer que seu código não irá funcionar da mesma forma.

Vamos ver um exemplo abaixo:

Nesse caso, temos um teste que tem a intenção de validar se dois nomes (do tipo String) são iguais. Porém, estou usando para comparar o firstName e o secondName o operador de igualdade == . Nesse exemplo, meu teste não está passando, mesmo com os dois nomes tendo valores iguais. 😞 O que pode estar acontecendo???

Imediatamente, o Sonarlint me alerta que algo errado não está certo!

Logo abaixo, na aba do Sonarlint, temos mais informações: Ele me mostra uma breve descrição da regra, com o seu tipo, que nesse caso seria um "bug" e com o nível de severidade "Major". (Caso não esteja visualizando a aba do Sonarlint, você pode acessá-la no IntelliJ indo no menu "View", "Tool Windows", "Sonarlint". E no Eclipse, no menu "Window", "Show view", "Other...", "Sonarlint").

E por fim, a cereja do bolo 🍒🍰: A forma de como corrigir esse código, com um exemplo que não causaria mais bugs.

Então, me aproveitando dessa dica do Sonarlint, vou corrigir meu código, sendo o resultado final este:

Além desse exemplo acima, o Sonarlint dá muitas dicas para deixar seu código sem bugs, mais legível e com qualidade. Se quiser uma lista completa das regras que ele aponta, clica aqui.

Esse plugin é ou não é maravigold?!🧙‍♀️

Do Zero: Git + Github - Como criar primeiro repositório e subir seu primeiro projeto

Isa Giongo — Sat, 18 Jul 2020 13:10:06 +0000

Pra começar, Git e Github são sim coisas diferentes. Porém, trabalham juntos no propósito de tornar nosso código e projetos possíveis de serem versionados e compartilhados.

Na minha pequena experiência de Deva Java, digo pra você que: GitHub é apenas uma das opções de "onde armazenar" as diversas versões do seu projeto/código. Outros serviços muito utilizados, especialmente nas empresas, são o Bitbucket, GitLab e Azure(Microsoft).

Já o Git, que é a ferramenta para "versionar" nosso código (que basicamente funciona como um "backup" de cada versão e permite que você consiga voltar atrás, quando fizer alguma grande besteira), é uma unanimidade: todo mundo usa!

É importante salientar que esse post não tem a intenção de ensinar os conceitos sobre Git, nem tampouco ser um tutorial para trabalho em equipes com o Git, utilizando de conceitos como branches, merges, rebases e etc. Aqui, só queremos garantir que alguém que nunca utilizou a ferramenta, consiga publicar as alterações em seu código no GitHub, utilizando os comandos mais triviais e que não deixam de ser também, os mais usados no dia a dia, como git add, git commit e git push.

Para facilitar sua navegação e/ou você não perder muito tempo com coisa que já tem ou já sabe, aqui tem uns atalhos pra você ir pras etapas que te interessam:

Atalhos

Para instalar o Git, clica aqui.
Para criar sua conta no GitHub e seu primeiro repositório, clica aqui.
Caso queira iniciar seu projeto de exemplo utilizando o Spring Initializr, é aqui.
Se isso tudo já está ok e você está pronta para dar os primeiros comandos e subir as coisas lá no seu GitHub, clica aqui.

Instalação do Git

Como pré requisito, precisamos ter instalado o Git na nossa máquina. Para cada sistema operacional há uma forma de instalar.

Confesso que, desde que iniciei a jornada me tornar desenvolvedora, migrei para o linux (Ubuntu) e faço muito uso da linha de comando (terminal). Parece mais difícil num primeiro momento, mas acho que facilita muito para diversas instalações e coisas que devemos utilizar como dev no dia a dia.

Aqui tem o site oficial com as formas de instalar em cada SO. Para quem usa Windows, uma opção é utilizar o client do GitHub para desktop -> GitHub Desktop. Outra opção também, é utilizar uma IDE (Integrated Development Environment - que basicamente é um softfware que vai te facilitar a desenvolver softwares :D). Como exemplos podemos citar o IntelliJ, que já vem com o Git instalado por padrão ou o Eclipse, que podemos adicionar o plugin Egit.

Se você está, como eu, utilizando Linux, o processo é bem simples. Basta um comando no terminal e tcharamm...

sudo apt install git-all

Para conferir se a instalação foi sucesso, digite

git --version

Se aparecer algo semelhante ao abaixo é porque está tudo certo e já podemos começar.

git version 2.25.1

Criar conta e repositório no GitHub

O GitHub é um serviço que vai armazenar nossos projetos e nos auxiliar a gerenciá-los. É uma excelente vitrine para expor nossos trabalhos e estudos.

A primeira etapa é criar uma conta no GitHub, que é um cadastro básico como em qualquer site ou serviço: Na página inicial você deve preencher seus dados, escolhendo um username (que será sua identificação no site), colocando seu email e escolhendo uma senha.

Depois disso, vamos criar nosso primeiro repositório: o local para expor nossa arte!

Agora é preciso preencher o nome do novo repositório e colocar uma breve descrição (não é obrigatório, mas dá um tom de organização, né?!). O restante das opções, eu geralmente deixo o padrão que está: public e desmarcado para criação do README e do learning lab.

Quando você clicar em "Create repository", vem a chave para nosso primeiro teste: todos os comandos que precisamos executar em nosso PC para conseguir "subir" nosso primeiro arquivo! Segura esses comandos aí que, já já, vamos precisar deles.

Criar projeto básico Spring Initializr

Uma forma de criar um projetinho mais próximo da vida real para subir em nosso repositório, é utilizar o Spring Initializr https://start.spring.io/, que pode gerar um pacote já com toda a estrutura de um projeto Java.
Mas, para enviar ao GitHub utilizando o Git, podemos usar qualquer projeto ou conjunto de arquivos. Vamos criar o projeto com as seguintes definições:

Em "Project": "Maven Project"; Em "Language": "Java"; Em "Spring Boot": A versão que já vier marcada;
Em "Project Metadata": Eu preencho assim: "Group": "com.isagiongo"; "Artifact": "basic-git"; "Name": "basic-git"; "Description": "Testing Git"; "Package name": "com.isagiongo.basic-git";
Em "Packaging": "Jar"; Em "Java": "8"; (não precisa selecionar nenhuma dependência no momento). Agora basta clicar em Generate que o site vai baixar nossa base de projeto em um arquivo compactado.

Descompacte esse arquivo em seu diretório(pasta) de projetos-java, por exemplo. Acesse a pasta que você acabou de descompactar. Você deve conseguir ver pelo menos o seguinte lá dentro:

Comandos para inicializar nosso repositório e subir nosso projeto para o GitHub

Agora vem a hora de utilizar aqueles comandos que o GitHub nos passou assim que criamos nosso repositório (para uma lista mais completa de comandos do Git, dá uma olhada aqui.

Uma coisa importante para entender o que os comandos abaixo estão fazendo, é dar uma olhada nas "áreas" que o Git gerencia pra gente, e o fluxo que nossas alterações percorrem até chegar lá no nosso repositório no GitHub. A imagem abaixo ilustra isso.

Quando utilizamos "git add", enviamos o arquivo para o "staging area" (área de preparo), que significa que ele está sendo preparado para entrar na próxima revisão do repositório. São as coisas que vão entrar no próximo commit.

Ao executar "git commit", vamos pegar tudo que foi enviado com git add ao staging área e "tirar uma foto" do estado atual do projeto e registrar isso no nosso repositório local.

E por fim, o comando "git push", vai enviar essas alterações commitadas para o repositório remoto.

Estando dentro da pasta do seu projeto, vamos digitar os seguintes comandos:

o comando echo está "enviando" (>>) o conteúdo que está entre aspas duplas para o arquivo README.md (para saber mais sobre a função do README e como montar um bem legal olha esse artigo.

echo "# Project Basic Git" >> README.md

o comando git init está criando um novo repositório do git

git init

como já tínhamos arquivos dentro da nossa pasta, fizemos um pouco diferente do indicado nos comandos do GitHub. O comando git add . adiciona todo o conteúdo do atual diretório à área de index do Git (para saber mais)

git add .

o comando seguinte, vai confirmar que queremos adicionar essas mudanças, e sempre vamos colocar dentro de aspas duplas uma mensagem que explique o que esse commit está fazendo, o que ele está adicionando.É importante que a mensagem de commit realmente seja explicativa em relação às alterações que foram feitas.

git commit -m "Enviando primeiro projeto ao GitHub"

Depois disso vamos nos conectar ao nosso servidor remoto, ao nosso repositório do GitHub

git remote add origin https://github.com/isagiongo-tutorial/basic-git.git

E por fim, enviar essas alterações lá para o nosso repositório do GitHub

git push -u origin master

Pronto! Nosso projeto já está na nossa página do GitHub!

Só para fazer um teste, vamos editar nosso arquivo de README, acrescentando algumas informações para comprovar que o Git está mesmo "monitorando" nossas alterações. E claro, vamos novamente enviar o que alteramos em nosso projeto para nosso repositório remoto.

Se nenhum arquivo de nosso projeto tiver sido alterado, ao executar o comando git status, temos como resultado:

Isso nos informa que estamos trabalhando na branch master (assunto para próximos posts) e que estamos atualizados em relação ao que está no nosso repositório remoto (no GitHub). E nos informa também que, não temos nada a commitar, pois não acrescentamos nenhuma alteração.

Agora vamos alterar e salvar o arquivo README, acrescentando qualquer informação. Após isso, vamos testar o comando git status novamente.

Agora sim, temos a informação de que um arquivo foi modificado e que temos o que commitar.

E assim faremos! Vamos adicionar o arquivo com git add README.md, commitar informando uma mensagem do que alteramos com git commit -m "mensagem" e enviar ao repositório remoto no GitHub com o comando git push.

E essa é a rotina básica de uso do Git! Toda vez que fizermos algum acréscimo ou alteração em nosso projeto, podemos adicionar e submeter essas alterações ao nosso repositório!

Abaixo alguns links interessantes e úteis para você aprender mais:

Curso grátis na Udemy sobre Git e GitHub básico - em português.
Para aprender mais sobre branches no git interativamente - em português.
App desktop para aprender na prática sobre Git - em inglês.
Acha que fez merda e não sabe como resolver? Aqui tem a resposta! :D - em português.