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/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 版获得许可。有关详细信息，请参阅许可证。