Cardplace.ru

Appearance

Модуль для работы с терминалом. realweb.api.console ​

Совместимость

realweb.api v.6

Модуль позволяет выполнять команды через терминал. Облегчает работу разработчика.

Пример использования ​

shell
php bitrix/tools/console create-module [-m=<name>] [-t=<type>] [-c=<code>]

Команды ​

--help ​

Показать информацию о командах или подробную информацию о команде

shell
php bitrix/tools/console create-module [-m=<name>] [-t=<type>] [-c=<code>]

version ​

Новая версия модуля. При внесении изменений в любой модуль позволяет закоммитить изменения, отправить в репозиторий и проставить в composer.json нужную актуальную версию.

shell
php bitrix/tools/console version [-m=<name>] [-v=<version>] [-c=<comment>]
  • -m=<name> название модуля, доступна краткая запись, например вместо realweb.api.sale просто sale
  • -v=<version> версия: major, minor, fix.
    • major - совпадает с major версией ядра realweb.api
    • minor - содержит обратно несовместимые изменения
    • fix - исправление ошибок, добавление новой функциональности
  • -c=<comment> комментарий

Доступен запуск без параметров. В таком случае параметры запуска необходимо будет внести пошагово.

shell
php bitrix/tools/console version -m=realweb.api -v=fix -c="fix(composer): add require"

create-module ​

Создание нового модуля для ИБ

shell
php bitrix/tools/console create-module [-m=<name>] [-t=<type>] [-c=<code>]
  • -m=<name> название модуля
  • -t=<type> тип инфоблока
  • -c=<code> код инфоблока
shell
php bitrix/tools/console create-module -m=news -t=content -c=news

Доступен запуск без параметров. В таком случае параметры запуска необходимо будет внести пошагово.

create-data ​

Создание "orm" для новой сущности данных

shell
php bitrix/tools/console create-data [-m=<name>] [-p=<path>]
  • -m=<name> название модуля
  • -p=<path> путь
shell
php bitrix/tools/console create-module -m=news -p=element/review

Доступен запуск без параметров. В таком случае параметры запуска необходимо будет внести пошагово.

create-entity ​

Создание "orm" для новой сущности базы данных

shell
php bitrix/tools/console create-entity [-m=<name>] [-p=<path>] [-e=<entity>] [-t=<type>] [-c=<code>]
  • -m=<name> название модуля
  • -p=<path> путь
  • -e=<entity>тип сущности: element, section, hload
  • -t=<type> тип инфоблока
  • -c=<code> код инфоблока
shell
php bitrix/tools/console create-entity -m=news -p=element/rules -e=element -t=content -c=rules

Доступен запуск без параметров. В таком случае параметры запуска необходимо будет внести пошагово.

create ​

Новый модуль, новая сущность базы данных или новая сущность данных. Объединение команд create-module, create-data и create-entity.

shell
php bitrix/tools/console create [-type <type>] [...]
  • -type <type> команда - module entity или data
  • все параметры вызываемой команды
shell
php bitrix/tools/console create -type module -m news -p element/rules -e element -t content -c rules

annotate ​

Генерация аннотаций для orm сущностей бд

shell
php bitrix/tools/console annotate [-m=<name>] [-p=<path>]
  • -m=<name> название модуля
  • -p=<path> путь
shell
php bitrix/tools/console annotate -m=news -p=element

check ​

Проверка кода с помощью линтера

shell
php bitrix/tools/console check
shell
php bitrix/tools/console create -type module -m news -p element/rules -e element -t content -c rules

fix ​

Автоисправление кода с помощью линтера

shell
php bitrix/tools/console fix

starter ​

Автоматическое заполнение стартера переменными проекта

Использование:

shell
php bitrix/tools/console starter [-name=<name>] [-port=<port>]

Параметры:

shell
-name=<name> название проекта
-port=<port> порт node на dev сервере

Пример:

shell
php bitrix/tools/console starter -name=test -port=3084

info ​

Отправление информации об установленных модулях на проекте в мониторинг

shell
php bitrix/tools/console info

По задумке данные об установленных модулях realweb.api отправляются перед коммитом изменений в файле pre-commit.

Инструкция ​

В директорию с файлом composer.json необходимо положить файл такого содержания

shell
#!/bin/bash
preHookPath=`git config core.hooksPath`;
length=${#preHookPath};
if [ $length = 0 ]; then
  preHookPath=".git/hooks";
fi
preCommitFile="../${preHookPath}/pre-commit";
if [ ! -e "$preCommitFile" ]; then
	echo -en "#!/bin/sh \ncd ${PWD} && php bitrix/tools/console info" > $preCommitFile
else
	if ! grep -q "php bitrix/tools/console info" "$preCommitFile"; then
    echo -en "\ncd ${PWD} && php bitrix/tools/console info" >> $preCommitFile
  fi
fi
chmod a+x $preCommitFile;
  1. В composer.json добавляем следующее:
json
...
"scripts": {
"post-update-cmd": [
"./pre-commit"
],
"post-install-cmd": [
"./pre-commit"
]
}
...
  1. Выполняем
shell
composer install --prefer-source --ignore-platform-reqs

Теперь после каждого коммита данные о модулях будут отправлятся в мониторинг https://monitoring.bitrix.dev.realweb.ru/.