shards

シャード

Crystal 言語の依存関係マネージャー。

使用法

Crystal アプリケーションとライブラリでは、ルートに次のようなshard.ymlファイルが存在することが想定されています。

 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

ライブラリが Git リポジトリからインストールされる場合、リポジトリには、semver に似た形式に従い、接頭辞vが付いているバージョン タグが含まれることが期待されます。例: v1.2.3 、 v2.0.0-rc1またはv2017.04.1 。

shard.yml形式の詳細については、SPEC を参照してください。

インストール

シャードは通常、Crystal 自体 (Homebrew パッケージや Debian パッケージなど) とともに配布されます。あるいは、システムでshardsパッケージを利用できる場合もあります。

同じページからソース tarball をダウンロード (またはリポジトリのクローンを作成) してから、 make release=1を実行して、 bin/shards PATHにコピーできます。たとえば、 /usr/local/bin 。

これで、プロジェクトのshard.ymlを作成する準備が整いました (詳細は SPEC を参照してください)。 shards initと入力すると、プロジェクト用のサンプルshard.ymlファイルが作成されます。

shards install実行して依存関係をインストールします。これにより、依存関係がshard.lockファイルにロックされます。 shard.ymlとshard.lock両方をバージョン管理にチェックインする必要があります。これにより、さらにshards install常にロックされたバージョンがインストールされ、コンピューター間で再現可能なインストールが実現されます。

shards --help実行して、他のコマンドとそのオプションをリストします。

ハッピーハッキング!

開発者

要件

これらの要件は、シャードをコンパイルする場合にのみ必要です。

• 結晶

  オペレーティング システムの手順については、https://crystal-lang.org/install/ を参照してください。

• molinillo

  シャードmolinilloクリスタル パス内にある必要があります。これは https://github.com/crystal-lang/crystal-molinillo で入手できます。既存のshardsバイナリ ( shards installを実行) を使用してインストールすることも、 lib/crystal-molinillo ( make libにあるリポジトリをチェックアウトすることもできます。 make lib )。

• リビアムル

  Debian/Ubuntu Linux では、 libyaml-devパッケージをインストールできます。

  Mac OS X では、 brew install libyamlで homebrew を使用してインストールできます。その後、 LIBRARY_PATH環境変数に/usr/local/libが含まれていることを確認してください (例： export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH" )。 Homebrew のインストールに応じてパスを調整してください。

• ホヤドクター

  マンページを構築するために必要です。

はじめる

シャードの構築と開発にはmake使用することを強くお勧めします。 Makefileコンパイルとテストのためのレシピが含まれています。 makeを使用してビルドすると、ソースの依存関係であるmolinilloも確実にインストールされます。自分でこれに対処する必要はありません。

make bin/shards実行してバイナリをビルドします。

• リリース ビルドの場合はrelease=1 (最適化を適用)
• 静的リンクの場合はstatic=1 (musl-libc でのみ動作します)
• debug=1 (完全なシンボリック デバッグ情報)

make install実行してバイナリをインストールします。ターゲット パスはPREFIXで調整できます (デフォルト: PREFIX=/usr/bin )。

make test実行してテスト スイートを実行します。

• make test_unit単体テストを実行します ( ./spec/unit )
• make test_integration bin/shardsで統合テスト ( ./spec/integration ) を実行します。

make docs実行してマンページを構築します。

デベンブ

このリポジトリには devenv.sh の構成が含まれており、ビルドとテストに必要なすべてのツールを備えた再現可能な環境を簡単にセットアップできます。

• リポジトリをチェックアウトする
• devenv shell実行して開発環境のシェルを取得します。

シェルを自動起動するためのフックも含まれています。 direnvがインストールされている場合、リポジトリ フォルダーに入ると devenv 環境が自動的にロードされます。

ライセンス

Apache License、バージョン 2.0 に基づいてライセンスされています。詳細については、「ライセンス」を参照してください。