Loading repository data…
ricardopedias / repository
Framework para criação de programas de terminal
Este é um simples framework para criação de scripts bash, oferecendo diversas facilidades para implementação de ferramentas de configuração, instalação e afins.
Em um projeto qualquer, faça o clone deste framework em algum subdiretório de sua preferência:
git clone https://github.com/ricardopedias/shelly.git meu/shelly
Na raiz do projeto, crie um arquivo .sh contendo a seguinte implementação:
#!/bin/bash
# determina o caminho completo para este arquivo
ROOT_PATH=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
# inclui as funcionalidades do framework
source "$ROOT_PATH/meu/shelly/setup.sh"
# determina o arquivo .md que será usado para exibir ajuda
DSETUP_HELP_FILE="$ROOT_PATH/meu/help.md"
# padroniza a lista de argumentos passados pelo usuário
argumentList=$(prepareArgumentPairs $@)
for argumentPair in $argumentList
do
paramKey=$(pairKey $argumentPair)
paramValue=$(pairValue $argumentPair)
# configura as opções para seus respectivos comandos
case "$paramKey" in
hello) echo "Olá mundo!" ;;
*)
showError "Opção inválida: $paramKey"
exitSuccess
;;
esac
done
O programa acima, além das opções -h e --help padrões, também possui uma nova chamada --hello. Considerando que chamamos o arquivo .sh de config.sh, o uso será o seguinte:
./config.sh --hello
# exibe: Olá mundo!
Por padrão, um arquivo de ajuda do framework é carregado, contendo somente as informações básicas sobre as opções -h e --help. A declaração da variável $DSETUP_HELP_FILE muda esse comportamento, possibilitando o carregamento de um arquivo de ajuda personalizado.
O arquivo deve ser no formato markdown, de forma que o título principal (começando com #) será desenhado como o "nome do programa" e os subtítulos (começando com ##) serão seções da ajuda.
O seguinte arquivo .md é um bom exemplo:
# Meu programa
## Como usar
Modo de uso - config.sh <opções>
## Exemplos
setup.sh -h
setup.sh --help
## Opções
-h|--help : Exibe essa ajuda
--hello : Exibe uma mensagem de Olá
Que será desenhado no terminal da seguinte forma:
OBS: Embora as funcionalidades possuam testes de unidade, a respectiva documentação ainda será elaborada tão logo seja possível.
Selected from shared topics, language and repository description—not editorial ratings.
JRBARROZ /
O projeto tem como principal objetivo facilitar a instalação de frameworks através da linguagem shell script para a execução no terminal linux. Também, o projeto servirá de aprendizado da linguagem, com foco em automação, agilidade e eficácia na hora de criação/instalação de projetos.