shards

Pecahan

Manajer ketergantungan untuk bahasa Crystal.

Penggunaan

Aplikasi dan perpustakaan Crystal diharapkan memiliki file shard.yml di root mereka yang terlihat seperti ini:

 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

Ketika perpustakaan diinstal dari repositori Git, repositori tersebut diharapkan memiliki tag versi yang mengikuti format mirip semver, diawali dengan v . Contoh: v1.2.3 , v2.0.0-rc1 atau v2017.04.1 .

Silakan lihat SPEC untuk detail lebih lanjut tentang format shard.yml .

Memasang

Pecahan biasanya didistribusikan dengan Crystal itu sendiri (misalnya paket Homebrew dan Debian). Alternatifnya, paket shards mungkin tersedia untuk sistem Anda.

Anda dapat mengunduh tarball sumber dari halaman yang sama (atau mengkloning repositori) lalu menjalankan make release=1 dan menyalin bin/shards ke PATH Anda. Misalnya /usr/local/bin .

Anda sekarang siap membuat shard.yml untuk proyek Anda (lihat detailnya di SPEC). Anda dapat mengetikkan shards init untuk membuat contoh file shard.yml untuk proyek Anda.

Jalankan shards install untuk menginstal dependensi Anda, yang akan mengunci dependensi Anda ke dalam file shard.lock . Anda harus memeriksa shard.yml dan shard.lock ke dalam kontrol versi, sehingga shards install selanjutnya akan selalu memasang versi yang terkunci, sehingga mencapai pemasangan yang dapat direproduksi di seluruh komputer.

Jalankan shards --help untuk membuat daftar perintah lain beserta opsinya.

Selamat Meretas!

Pengembang

Persyaratan

Persyaratan ini hanya diperlukan untuk menyusun Pecahan.

• Kristal

  Silakan merujuk ke https://crystal-lang.org/install/ untuk petunjuk sistem operasi Anda.

• molinillo

  Pecahan molinillo harus berada di jalur Kristal. Ini tersedia di https://github.com/crystal-lang/crystal-molinillo Anda dapat menginstalnya dengan biner shards yang sudah ada sebelumnya (menjalankan shards install ) atau cukup periksa repositori di lib/crystal-molinillo ( make lib ).

• libyaml

  Di Debian/Ubuntu Linux Anda dapat menginstal paket libyaml-dev .

  Di Mac OS X Anda dapat menginstalnya menggunakan homebrew dengan brew install libyaml lalu pastikan untuk memiliki /usr/local/lib di variabel lingkungan LIBRARY_PATH Anda (misalnya: export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH" ). Harap sesuaikan jalur sesuai instalasi Homebrew Anda.

• asciidoctor

  Diperlukan untuk membuat halaman manual.

Memulai

Sangat disarankan untuk menggunakan make untuk membuat pecahan dan mengembangkannya. Makefile berisi resep untuk kompilasi dan pengujian. Membangun dengan make juga memastikan ketergantungan sumber molinillo terinstal. Anda tidak perlu mengurusnya sendiri.

Jalankan make bin/shards untuk membangun biner.

• release=1 untuk versi rilis (menerapkan pengoptimalan)
• static=1 untuk tautan statis (hanya berfungsi dengan musl-libc)
• debug=1 untuk info debug simbolik lengkap

Jalankan make install untuk menginstal biner. Jalur target dapat disesuaikan dengan PREFIX (default: PREFIX=/usr/bin ).

Jalankan make test untuk menjalankan rangkaian pengujian:

• make test_unit menjalankan pengujian unit ( ./spec/unit )
• make test_integration menjalankan pengujian integrasi ( ./spec/integration ) pada bin/shards

Jalankan make docs untuk membuat halaman manual.

Devenv

Repositori ini berisi konfigurasi untuk devenv.sh yang memudahkan pengaturan lingkungan yang dapat direproduksi dengan semua alat yang diperlukan untuk membangun dan menguji.

• Periksa repositori
• Jalankan devenv shell untuk mendapatkan shell dengan lingkungan pengembangan

Sebuah kait untuk aktivasi shell otomatis juga disertakan. Jika Anda telah menginstal direnv , lingkungan devenv dimuat secara otomatis saat memasuki folder repo.

Lisensi

Berlisensi di bawah Lisensi Apache, Versi 2.0. Lihat LISENSI untuk detailnya.