shards

Fragmentos

Gerenciador de dependências para a linguagem Crystal.

Uso

Espera-se que os aplicativos e bibliotecas Crystal tenham um arquivo shard.yml em sua raiz semelhante a este:

 name : shards
version : 0.1.0

dependencies :
  openssl :
    github : datanoise/openssl.cr
    branch : master

development_dependencies :
  minitest :
    git : https://github.com/ysbaddaden/minitest.cr.git
    version : ~> 0.3.1

license : MIT

Quando as bibliotecas são instaladas a partir de repositórios Git, espera-se que o repositório tenha tags de versão seguindo um formato semelhante ao semver, prefixado com v . Exemplos: v1.2.3 , v2.0.0-rc1 ou v2017.04.1 .

Consulte o SPEC para obter mais detalhes sobre o formato shard.yml .

Instalar

Shards geralmente são distribuídos com o próprio Crystal (por exemplo, pacotes Homebrew e Debian). Alternativamente, um pacote shards pode estar disponível para o seu sistema.

Você pode baixar um tarball de origem da mesma página (ou clonar o repositório) e executar make release=1 e copiar bin/shards em seu PATH . Por exemplo /usr/local/bin .

Agora você está pronto para criar um shard.yml para seus projetos (veja detalhes no SPEC). Você pode digitar shards init para criar um arquivo shard.yml de exemplo para o seu projeto.

Execute shards install para instalar suas dependências, o que irá bloqueá-las em um arquivo shard.lock . Você deve verificar shard.yml e shard.lock no controle de versão, para que shards install adicionais sempre instale versões bloqueadas, obtendo instalações reproduzíveis em computadores.

Execute shards --help para listar outros comandos com suas opções.

Feliz hacking!

Desenvolvedores

Requisitos

Esses requisitos são necessários apenas para compilar Shards.

• Cristal

  Consulte https://crystal-lang.org/install/ para obter instruções para o seu sistema operacional.

• molinillo

  O fragmento molinillo precisa estar no caminho do Cristal. Ele está disponível em https://github.com/crystal-lang/crystal-molinillo Você pode instalá-lo com um binário shards pré-existente (executando shards install ) ou apenas verificar o repositório em lib/crystal-molinillo ( make lib ).

• líbiaml

  No Debian/Ubuntu Linux você pode instalar o pacote libyaml-dev .

  No Mac OS X você pode instalá-lo usando homebrew com brew install libyaml e certifique-se de ter /usr/local/lib em sua variável de ambiente LIBRARY_PATH (por exemplo: export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH" ). Ajuste o caminho de acordo com a instalação do Homebrew.

• asciidoctor

  Necessário para construir páginas de manual.

Começando

É altamente recomendável usar make para construir fragmentos e desenvolvê-los. O Makefile contém receitas para compilação e teste. Construir com make também garante que a dependência de origem molinillo seja instalada. Você não precisa cuidar disso sozinho.

Execute make bin/shards para construir o binário.

• release=1 para uma versão de lançamento (aplica otimizações)
• static=1 para vinculação estática (funciona apenas com musl-libc)
• debug=1 para informações completas de depuração simbólica

Execute make install para instalar o binário. O caminho de destino pode ser ajustado com PREFIX (padrão: PREFIX=/usr/bin ).

Execute make test para executar os conjuntos de testes:

• make test_unit executa testes de unidade ( ./spec/unit )
• make test_integration executa testes de integração ( ./spec/integration ) em bin/shards

Execute make docs para construir as páginas de manual.

Devenv

Este repositório contém uma configuração para devenv.sh que facilita a configuração de um ambiente reproduzível com todas as ferramentas necessárias para construção e teste.

• Confira o repositório
• Execute devenv shell para obter um shell com ambiente de desenvolvimento

Um gancho para ativação automática do shell também está incluído. Se você tiver direnv instalado, o ambiente devenv será carregado automaticamente ao entrar na pasta repo.

Licença

Licenciado sob a Licença Apache, Versão 2.0. Consulte LICENÇA para obter detalhes.