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 .

Вы можете загрузить исходный архив с той же страницы (или клонировать репозиторий), затем запустить 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 вы можете установить его с помощью brew install libyaml затем убедитесь, что /usr/local/lib в вашей переменной среды LIBRARY_PATH (например: export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH" ). Пожалуйста, измените путь в соответствии с вашей установкой Homebrew.

• врач-ассистент

  Нужен для создания man-страниц.

Начиная

Настоятельно рекомендуется использовать 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 запускает интеграционные тесты ( ./spec/integration ) в bin/shards

Запустите make docs для создания страниц руководства.

Девенв

Этот репозиторий содержит конфигурацию devenv.sh, которая позволяет легко настроить воспроизводимую среду со всеми необходимыми инструментами для сборки и тестирования.

• Оформить репозиторий
• Запустите devenv shell чтобы получить оболочку со средой разработки.

В комплект также входит крючок для автоматической активации оболочки. Если у вас установлен direnv , среда devenv загружается автоматически при входе в папку репо.

Лицензия

Лицензия Apache, версия 2.0. Подробности см. в разделе ЛИЦЕНЗИЯ.