bundle-gem - справочное руководство, опции, примеры команд

ИМЯ

bundle-gem - Сгенерировать скелет проекта для создания rubygem

СИНТАКСИС

bundle gem GEM_NAME OPTIONS

ОПИСАНИЕ

Создает каталог с именем GEM_NAME с Rakefile, GEM_NAME.gemspec и другими вспомогательными файлами и каталогами, которые можно использовать для разработки rubygem с этим имя.

Запустите rake -T в получившемся проекте, чтобы получить список задач Rake, которые можно использовать для тестирования и публикации драгоценного камня на rubygems.org.

Сгенерированный скелет проекта можно настроить с помощью OPTIONS, как описано ниже. Обратите внимание, что эти параметры также можно указать через глобальный файл конфигурации Bundler, используя следующие имена:

gem.coc
gem.mit
gem.test

ПАРАМЕТРЫ

--exe, -b, --bin

Укажите, что Bundler должен создать двоичный исполняемый файл (как exe/GEM_NAME) в сгенерированном проекте rubygem. Этот двоичный файл также будет добавлен в манифест GEM_NAME.gemspec. Это поведение отключено по умолчанию.

--no-exe

Не создавать двоичный файл (переопределяет --exe, указанный в глобальной конфигурации).

--coc

Добавьте файл CODE_OF_CONDUCT.md в корень созданного проекта. Если этот параметр не указан, будет отображаться интерактивная подсказка, а ответ будет сохранен в глобальной конфигурации Bundler для будущего использования bundle gem.

--no-coc

Не создавайте CODE_OF_CONDUCT.md (переопределяет --coc, указанный в глобальной конфигурации).

--ext=c, --ext=rust

Добавьте стандартный код расширения для C или Rust (в настоящее время основанный на https://docs.rs/magnus) в сгенерированный проект. Это поведение отключено по умолчанию.

--no-ext

Не добавляйте код расширения (переопределяет --ext, указанный в глобальной конфигурации).

--mit

Добавьте лицензию MIT в файл LICENSE.txt в корне сгенерированного проекта. Ваше имя из глобальной конфигурации git используется для заявления об авторских правах. Если этот параметр не указан, будет отображаться интерактивная подсказка, а ответ будет сохранен в глобальной конфигурации Bundler для будущего использования bundle gem.

--no-mit

Не создавайте файл LICENSE.txt (переопределяет --mit, указанный в глобальной конфигурации).

-t, --test=minitest, --test=rspec, --test=test-unit

Укажите тестовую среду, которую Bundler должен использовать при создании проекта. Допустимыми значениями являются minitest, rspec и test-unit. GEM_NAME.gemspec будет настроен, и на основе этой опции будет создан каталог скелета test/spec. Если опция не указана:

Когда Bundler настроен на создание тестов, по умолчанию используется глобальный параметр конфигурации Bundler gem.test.

Если Bundler настроен так, чтобы не создавать тесты, будет отображаться интерактивная подсказка, и ответ будет использоваться для текущего проекта rubygem.

Когда Bundler не настроен, будет отображаться интерактивная подсказка, а ответ будет сохранен в глобальной конфигурации Bundler для будущего использования bundle gem.

--ci, --ci=github, --ci=gitlab, --ci=circle

Укажите службу непрерывной интеграции, которую Bundler должен использовать при создании проекта. Допустимые значения: github, gitlab и circle. Файл конфигурации будет сгенерирован в каталоге проекта. Если опция не указана:

Когда Bundler настроен на создание файлов CI, по умолчанию используется глобальный параметр конфигурации Bundler gem.ci.

Если Bundler настроен так, чтобы не создавать файлы CI, будет отображаться интерактивная подсказка, и ответ будет использоваться для текущего проекта rubygem.

Когда Bundler не настроен, будет отображаться интерактивная подсказка, а ответ будет сохранен в глобальной конфигурации Bundler для будущего использования bundle gem.

--linter, --linter=rubocop, --linter=standard

Укажите линтер и средство форматирования кода, которые Bundler должен добавить к зависимостям разработки проекта. Допустимые значения: rubocop и стандарт. Файл конфигурации будет сгенерирован в каталоге проекта. Если опция не указана:

Когда Bundler настроен на добавление линтера, по умолчанию используется глобальный параметр конфигурации Bundler gem.linter.

Когда Bundler настроен не добавлять линтер, будет отображаться интерактивная подсказка, и ответ будет использоваться для текущего проекта rubygem.

Когда Bundler не настроен, будет отображаться интерактивная подсказка, а ответ будет сохранен в глобальной конфигурации Bundler для будущего использования bundle gem.

-e, --edit[=EDITOR]

Откройте полученный файл GEM_NAME.gemspec в РЕДАКТОРЕ или в редакторе по умолчанию, если он не указан. По умолчанию используется $BUNDLER_EDITOR, $VISUAL или $EDITOR.

СМОТРИТЕ ТАКЖЕ

  • пакет config(1) bundle-config.1.html