Gestor de dependencias para el lenguaje Crystal.
Se espera que las aplicaciones y bibliotecas de Crystal tengan un archivo shard.yml
en su raíz con este aspecto:
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
Cuando las bibliotecas se instalan desde repositorios Git, se espera que el repositorio tenga etiquetas de versión siguiendo un formato similar a semver, con el prefijo v
. Ejemplos: v1.2.3
, v2.0.0-rc1
o v2017.04.1
.
Consulte las especificaciones para obtener más detalles sobre el formato shard.yml
.
Shards generalmente se distribuye con el propio Crystal (por ejemplo, paquetes Homebrew y Debian). Alternativamente, es posible que haya un paquete shards
disponible para su sistema.
Puede descargar un archivo tar de origen desde la misma página (o clonar el repositorio), luego ejecutar make release=1
y copiar bin/shards
en su PATH
. Por ejemplo /usr/local/bin
.
Ahora está listo para crear un shard.yml
para sus proyectos (consulte los detalles en SPEC). Puede escribir shards init
para crear un archivo shard.yml
de ejemplo para su proyecto.
Ejecute shards install
para instalar sus dependencias, lo que bloqueará sus dependencias en un archivo shard.lock
. Debe verificar tanto shard.yml
como shard.lock
en el control de versiones, de modo que shards install
siempre instale versiones bloqueadas, logrando instalaciones reproducibles en todas las computadoras.
Ejecute shards --help
para enumerar otros comandos con sus opciones.
¡Feliz piratería!
Estos requisitos sólo son necesarios para compilar Shards.
Cristal
Consulte https://crystal-lang.org/install/ para obtener instrucciones para su sistema operativo.
molinillo
El fragmento de molinillo
debe estar en el camino del Cristal. Está disponible en https://github.com/crystal-lang/crystal-molinillo. Puede instalarlo con un binario shards
preexistente (ejecutando shards install
) o simplemente consultar el repositorio en lib/crystal-molinillo
( make lib
).
libia
En Debian/Ubuntu Linux puede instalar el paquete libyaml-dev
.
En Mac OS X, puede instalarlo usando homebrew con brew install libyaml
y luego asegúrese de tener /usr/local/lib
en su variable de entorno LIBRARY_PATH
(por ejemplo: export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH"
). Ajuste la ruta según su instalación de Homebrew.
asciidoctor
Necesario para crear páginas de manual.
Se recomienda encarecidamente utilizar make
para crear fragmentos y desarrollarlos. El Makefile
contiene recetas para compilar y probar. Construir con make
también garantiza que el molinillo
de dependencia de fuente esté instalado. No es necesario que te ocupes de esto tú mismo.
Ejecute make bin/shards
para compilar el binario.
release=1
para una versión de lanzamiento (aplica optimizaciones)static=1
para enlaces estáticos (solo funciona con musl-libc)debug=1
para obtener información de depuración simbólica completa Ejecute make install
para instalar el binario. La ruta de destino se puede ajustar con PREFIX
(predeterminado: PREFIX=/usr/bin
).
Ejecute make test
para ejecutar los conjuntos de pruebas:
make test_unit
ejecuta pruebas unitarias ( ./spec/unit
)make test_integration
ejecuta pruebas de integración ( ./spec/integration
) en bin/shards
Ejecute make docs
para crear las páginas de manual.
Este repositorio contiene una configuración para devenv.sh que facilita la configuración de un entorno reproducible con todas las herramientas necesarias para construir y probar.
devenv shell
para obtener un shell con el entorno de desarrollo También se incluye un gancho para la activación automática del caparazón. Si tiene instalado direnv
, el entorno devenv se carga automáticamente al ingresar a la carpeta del repositorio.
Licenciado bajo la Licencia Apache, Versión 2.0. Consulte LICENCIA para obtener más detalles.