Hacks do Github - Variáveis

O Github é cheio de funcionalidades e o mais utilizado isso vocês já sabem e vamos continuar a série de "hacks" da plataforma que vão otimizar e melhorar sua experiência.

⚠️ Importante: Os prints que serão exibidos para exemplificar podem estar diferentes da interface do seu GitHub, por que sou muito adepto a extensões que melhoram a usabilidade e que ajudam no meu dia a dia. Partindo desse ponto peço que dê uma olhada nesse artigo antes.

Sabia que é possível utilizar variáveis nos seus arquivos Markdown? Mostrarei hoje como e, porque você deveria utilizar! Imagine que o seu Markdown tem vários links, como por exemplo:

[![NPM version](https://badge.fury.io/js/getmodule.svg?style=flat)](https://npmjs.org/package/getmodule)
[![Build Status](https://travis-ci.org/fdaciuk/getmodule.svg)](https://travis-ci.org/fdaciuk/getmodule)
[![Coverage Status](https://img.shields.io/coveralls/fdaciuk/getmodule.svg?style=flat)](https://coveralls.io/r/fdaciuk/getmodule?branch=master)
[![Code Climate](https://codeclimate.com/github/fdaciuk/getmodule/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fdaciuk/getmodule)
[![NPM](https://nodei.co/npm/getmodule.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/getmodule/)

Como você pode ver, no exemplo ele faz chamadas de alguns badges com links apontando para versão do módulo no NPM, Status do TravisCI, Status do Code Coverage no Coveralls, Code Climate, etc. Isso acaba ficando bastante verboso no seu arquivo e, se você precisar usar a mesma URL em outro lugar do seu README, terá que repetí-la.

Variáveis

Mas podemos usar um segredo guardado a sete chaves pelos Ninjas do Github, que são as variáveis. No final do seu arquivo, podemos colocar as suas variáveis nesse formato:

[nome-da-variavel]: valor-da-variavel

E para usar, só fazer assim:

[nome-da-variavel]

No caso do arquivo Markdown acima, aquele trecho de código ficaria assim:

[![NPM version][npm-version-image]][npm-version-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[![NPM][npm-image]][npm-url]

Assim como falei no artigo sobre Task lists e Tabelas interessante no Github a linguagem utilizada para escrita desses textos é o Markdown que é uma linguagem simples de marcação originalmente criada por John Gruber e Aaron Swartz. Markdown converte seu texto em HTML válido, mas essa linguagem é utilizada também no Discord, Notion entre outros que possuem como base essa linguagem.

Isso significa que a output de saída será a mesma inserindo o texto formatado conforme o que está inserido no Github, é um pouco repetitivo mas é importante que tenham isso em mente.

Fontes onde pesquisei esse conteúdo:

• https://docs.github.com/pt/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes