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。

安裝

Shards 通常與 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 ）。

• 利比亞

  在 Debian/Ubuntu Linux 上，您可以安裝libyaml-dev軟體套件。

  在 Mac OS X 上，您可以使用 homebrew 和brew install libyaml安裝它，然後確保LIBRARY_PATH環境變數中有/usr/local/ /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取得具有開發環境的 shell

還包括一個用於自動 shell 啟動的鉤子。如果安裝了direnv ，則在進入 repo 資料夾時會自動載入 devenv 環境。

執照

根據 Apache 授權 2.0 版授權。有關詳細信息，請參閱許可證。