2.223.3 • Published 5 months ago

@kontur.candy/tools v2.223.3

Weekly downloads
178
License
ISC
Repository
-
Last release
5 months ago

Candy Tools

Перед началом работы

Все операции выполняются через запуск

candy [имя-команды] [...опции]

Имена основных команд:

  • build
  • upgrade
  • dev-build
  • dev-build-server
  • build-server
  • localize
  • init-form
  • form-stats

candy build

Основной сценарий: выполняет сборку форм в каталог с ресурсами. Действия, которые выполняет команда:

  • Получение движка форм версии указанной в form.json,
  • получение генератора форм версии указанной в form.json,
  • генерация и компиляция формы в каталог ресурсов,
  • создание файлов {gfv}.metas.json в каталоге ресурсов
  • копирование конвертеров в каталог ресурсов,
  • копирование схемы в каталог ресурсов.

Опции

  • --watch (-w)

    Watch-режим. Выполняет сборку форм, а затем пересобирает при изменениях. В том числе движка, генератора и статических ресурсов.

  • --clean

    Полностью очищает целевой каталог ресурсов. Используется при полной сборке форм для продакшена

  • --mode

    Разделение сборок на продовую (mode=production) и не продовую (mode=development). По умолчанию development

  • --upgrade-form-json

    Форсирует изменение формата файла form.json на новый

  • --build-cache

    Задаёт режим использования кэша сборки. Возможные значения: disabled - не использовать кэш readonly - использовать кэш для сборки, но не обновляет его (значение по умолчанию) update - использовать кэш для сборки и презаписывать, если не совпадает force-update - всегда выполнять сборку и обновить значения в кэше Отключается при использовании watch-режима

  • --use-last-stable-version

    Устанавливает версию движка в файла form.json в последнюю стабильную версию. Аналогичен запуску candy-build с параметром -ge master

  • --use-prerelease-version

    Устанавливает версию движка в файла form.json в последнюю пререлизную версию в заданным preid. В файле версии генератора и движка будут установлены в pre:some-preid.

  • --no-reformat

    Отлючает форматирование генерируемого кода. Работает, только если версия генератора поддерживает эту опцию. Используется для ускорения сборки форм. (default: true)

  • --gfvs (-g)

    Одна или несколько GFV или GFV-масок для пересборки. Может содержать значки ? и *.

  • --use-version-from-cache

    Использовать версию движка и генератора из файловой системы

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

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

# Сборка формы 104816
candy build 104816
# Сборка все формы группы 1
candy build 1?????
# Собрать форму 104816 и следить за изменениями
candy build 104816 -w
# Использовать последнюю пререлизную версию движка с preid=bso
candy build 104816 --use-prerelease-version bso

Версионирование

При сборке форм, учитывается версия движка и генератора указанные файле form.json. Версии могут указывать не на конкретную версию, а адресовать диапазон в соответствии с semver. В этом случае будет выбрана последняя подходящая версия.

Файл form.json должен выглядеть следующим образом:

{
    // Опционально
    "themes": ["имя-темы", ...],
    "dependencies": {
        "engine": "[версия-движка]",
        "generator": "[версия-генератора]"
    }
}

версия-движка, версия-генератора - Соответственно, диапазоны версий. На данный момент всегда совпадают.

Допустимые варианты версий:

  • Версия в формате semver.
  • Версия с префиксом pre. Например, pre:my-stange-branch-name, где my-stange-branch-name - название предрелизной версии, выпускаемой разработчиками Candy, для предварительного выпуска форм. Версия с префиксом pre используются для движков, которые не являются стабильными и используются для предварительных сборок форм.

candy upgrade

Обновление формата форм или режима одной или нескольких форм.

Опции

  • --gfvs (-g)

    Одна или несколько GFV или GFV-масок для обновления.

  • --use-ci-build

    Приготовить форму к сборке на CI, без необходимости локальной пересборки.

  • --skip-pre-versions

    При обновлении версий форм не обновлять формы с нестабильными версиями.

  • --engine

    Обновляет движок до заданной версии. Можно использовать кокретную версию движка (например, 0.4.82) или latest, для обновления до последней стабильной версии.

  • --preid

    Обновляет движок до последней пререлизной версии указанной в preid.

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

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

Перевод формы на сборку в CI

Выполнить:

candy upgrade --use-ci-build 9900101

Эта команда удалит и заигнорит генерируемые файлы в каталоге farm и поменит форму как собираемую на CI. После этого не требуется далть комиты в репозиторий resources.

Обновлять версию движка формы надо командой:

candy upgrade --engine latest 9900101

candy dev-build

Выполняет сборку форм с ипользованием локальных исходников движка и генератора.

ВАЖНО

Эта команда собирает выполняет сборку форм в каталог ресурсов, но результаты сборки не являеются корректными для выкатывания в продакшен.

Опции

  • --watch (-w)

    Watch-режим. Выполняет сборку форм, а затем пересобирает при изменениях. В том числе движка, генератора и статических ресурсов.

  • --gfvs (-g)

    Одна или несколько GFV или GFV-масок для пересобрки.

  • --skip-generation (-n)

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

  • --skip-webpack

    Не запускать компиляцию сгенерированного кода. Для отладки результатов генерации.

  • --skip-engine

    Не запускать сборку runtime-движка. Для отладки результатов генерации.

  • --no-reformat

    Отлючает форматирование генерируемого кода. Работает, только если версия генератора поддерживает эту опцию. Используется для ускорения сборки форм.

  • --continue-on-error

    Не генерирует код ошибки в случае ошибки при генерации или компиляции формы.

  • --debug-only (-d)

    Собирать только debug-сборки движка и форм. ВНИМАНИЕ: при работе в браузере необходимо использовать параметр ?debug=true

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

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

Написание и просмотр форм

В каталоге candy.farm запустить команды

candy build 123456 -w
candy local-server
  • Переход на url http://localhost:9080/123456/form -- создаст черновик и откроет редактор
  • Inner черновиков находится в каталоге candy.resources/.data

Сборка формы для релиза

candy build 123456

Переключение и сборка формы на использование последней стабильной

candy build 123456 --use-last-stable-version

Затем можно использовать пункт 'Написание и просмотр форм'

Отладка форм с локальным движком

В каталоге candy.farm запустить команды

candy dev-build 123456 -w
candy local-server
  • Переход на url http://localhost:9080/123456/form -- создаст черновик и откроет редактор
  • Inner черновиков находится в каталоге candy.resources/.data

Разработка и отладка движка

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

candy dev-build 123456 --watch --debug-only
candy local-server --redirect-to-debug-scripts
  • Переход на url http://localhost:9080/123456/form -- создаст черновик и откроет редактор
  • Inner черновиков находится в каталоге candy.resources/.data

candy dev-build-server

Magic

Опции

  • --gfvs (-g)

    Одна или несколько GFV или GFV-масок для пересобрки.

  • --all-farm-dir (-a)

    Позволяет передать массив путей до всех фармов candy, чтобы открывать из всех них формы. Путь передавать относительно candy

  • --no-client-override

    Отключает перехват client.js. В этом случае не будет работать отображение логов сборки и ожидания сборки формы.

  • --reformat (-r)

    Включает форматирование генерируемого кода. Работает, только если версия генератора поддерживает эту опцию. Используется для отладки и просмотра сгенерированных форм в отдадчике. (default: false)

  • --debug-only (-d)

    Собирать только debug-сборки движка и форм. ВНИМАНИЕ: при работе в браузере необходимо использовать параметр ?debug=true

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

candy build-server

Magic

Опции

  • --gfvs (-g)

    Опция устарела. Оставлена для обратной совместимости.

  • --all-farm-dir (-a)

    Позволяет передать массив путей до всех фармов candy, чтобы открывать из всех них формы. Путь передавать относительно candy

  • --nightly

    Включает сборку форм на движке nightly.

  • --no-client-override

    Отключает перехват client.js. В этом случае не будет работать отображение логов сборки и ожидания сборки формы.

  • --reformat (-r)

    Включает форматирование генерируемого кода. Работает, только если версия генератора поддерживает эту опцию. Используется для отладки и просмотра сгенерированных форм в отдадчике. (default: false)

  • --debug-only (-d)

    Собирать только debug-сборки движка и форм. ВНИМАНИЕ: при работе в браузере необходимо использовать параметр ?debug=true

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

candy localize

Локализация формы. Подготавливает текстовые поля в сахаре для перевода и создает словарь

Опции

  • --gfv (-g)

    GFV формы для локализации

  • --dictionary-only (-d)

    Создать словарь локализации без изменения сахара

  • --use-local-generator-sources

    Использовать исходный код генератора из локальной рабочей копии. Используется в режиме разработке.

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

candy init-form

Создание заготовок для новых форм

Опции

  • --gfvs (-g)

    Одна или несколько GFV для которых будет создана заготовка.

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

  • --hlrng

    Копировать схему rng из highlander.farm.

candy form-stats

Выполняет сборку одной или нескольких форм. Подробнее: https://git.skbkontur.ru/ke/candy-utils/blob/new-candy-tool-cli/README.md

Опции

  • --gfvs (-g)

    Одна или несколько GFV или GFV-масок для пересобрки.

  • --by-engine

    Показать статискиу пе версиям движка.

  • --development-mode

    Используется только в режиме разработки cli.

  • --verbose (-v)

    Выводить отладочную информацию на консоль.

2.224.3-ci-test.0

5 months ago

2.214.0

7 months ago

2.213.0

8 months ago

2.210.1-cgroupv2.1

11 months ago

2.210.1-cgroupv2.0

11 months ago

2.216.0

6 months ago

2.215.0

6 months ago

2.221.0

5 months ago

2.206.0

11 months ago

2.210.0

11 months ago

2.210.1

11 months ago

2.218.0

6 months ago

2.220.0

5 months ago

2.217.0

6 months ago

2.223.2

5 months ago

2.223.3

5 months ago

2.212.0

10 months ago

2.222.0

5 months ago

2.207.0

11 months ago

2.219.0

6 months ago

2.211.0

10 months ago

2.208.0

11 months ago

2.204.0

12 months ago

2.203.0

12 months ago

2.202.0

1 year ago

2.201.0

1 year ago

2.199.0

1 year ago

2.200.0

1 year ago

2.198.1

1 year ago

2.198.0

1 year ago

2.196.0

1 year ago

2.197.0

1 year ago

2.195.0

1 year ago

2.188.0

1 year ago

2.192.0

1 year ago

2.187.6

1 year ago

2.187.4

1 year ago

2.187.5

1 year ago

2.187.0

1 year ago

2.191.1

1 year ago

2.191.0

1 year ago

2.194.0

1 year ago

2.189.0

1 year ago

2.189.1

1 year ago

2.189.2

1 year ago

2.193.0

1 year ago

2.184.3

1 year ago

2.184.0

1 year ago

2.186.0

1 year ago

2.190.0

1 year ago

2.185.5

1 year ago

2.185.6

1 year ago

2.185.7

1 year ago

2.185.0

1 year ago

2.185.1

1 year ago

2.185.2

1 year ago

2.185.3

1 year ago

2.182.0

2 years ago

2.183.0

2 years ago

2.181.0

2 years ago

2.180.0

2 years ago

2.179.0

2 years ago

2.177.0

2 years ago

2.176.2

2 years ago

2.178.0

2 years ago

2.178.2

2 years ago

2.176.1

2 years ago

2.176.0

2 years ago

2.175.0

2 years ago

2.174.0

2 years ago

2.171.0

2 years ago

2.170.0

2 years ago

2.173.0

2 years ago

2.172.0

2 years ago

2.169.0

2 years ago

2.168.0

2 years ago

2.167.0

2 years ago

2.166.0

2 years ago

2.165.0

2 years ago

2.164.0

2 years ago

2.163.0

2 years ago

2.161.0

2 years ago

2.156.0

2 years ago

2.155.0

2 years ago

2.158.0

2 years ago

2.157.0

2 years ago

2.159.0

2 years ago

2.154.0

2 years ago

2.153.0

2 years ago

2.152.0

2 years ago

2.149.0

3 years ago

2.140.0-debug

3 years ago

2.150.0

3 years ago

2.151.0

3 years ago

2.146.0

3 years ago

2.148.0

3 years ago

2.147.0

3 years ago

2.142.0

3 years ago

2.139.0

3 years ago

2.141.0

3 years ago

2.138.0

3 years ago

2.144.0

3 years ago

2.143.0

3 years ago

2.145.0

3 years ago

2.140.0

3 years ago

2.137.0

3 years ago

2.136.0

3 years ago

2.133.0

3 years ago

2.135.0

3 years ago

2.134.0

3 years ago

2.132.0

3 years ago

2.131.0

3 years ago

2.130.2

4 years ago

2.130.0

4 years ago

2.127.0

4 years ago

2.116.0

4 years ago

2.126.0

4 years ago

2.129.0

4 years ago

2.121.0

4 years ago

2.118.0

4 years ago

2.128.0

4 years ago

2.123.0

4 years ago

2.122.0

4 years ago

2.125.0

4 years ago

2.124.0

4 years ago

2.115.0

4 years ago

2.114.0

4 years ago

2.113.0

4 years ago

2.112.0

4 years ago

2.111.0

4 years ago

2.110.0

4 years ago

2.109.0

4 years ago

2.108.0

4 years ago

2.107.0

4 years ago

2.103.0

4 years ago

2.104.0

4 years ago

2.105.0

4 years ago

2.106.0

4 years ago

3.0.0-1

4 years ago

3.0.0-0

4 years ago

3.0.0-3

4 years ago

3.0.0-2

4 years ago

3.0.0-5

4 years ago

3.0.0-4

4 years ago

2.101.1

5 years ago

2.101.4

5 years ago

2.102.0

5 years ago

2.100.1

5 years ago

2.101.0

5 years ago

2.99.0

5 years ago

2.98.0

5 years ago

2.100.0

5 years ago

2.97.0

5 years ago

2.95.0

5 years ago

2.96.0

5 years ago

2.94.0

5 years ago

2.93.0

5 years ago

2.91.0

5 years ago

2.90.1

5 years ago

2.90.0

5 years ago

2.89.0

5 years ago

2.92.0

5 years ago

2.88.0

5 years ago

2.87.0

5 years ago

2.86.0

5 years ago

2.85.0

5 years ago

2.84.0

5 years ago

2.83.0

5 years ago

2.82.0

5 years ago

2.81.0

5 years ago

2.80.0

5 years ago

2.79.0

5 years ago

2.78.1

5 years ago

2.78.0

5 years ago

2.77.0

5 years ago

2.76.0

5 years ago

2.75.0

5 years ago

2.74.0

5 years ago

2.73.0

5 years ago

2.72.0

5 years ago

2.72.0-0

5 years ago

2.71.0

5 years ago

2.70.0

5 years ago

2.69.0

5 years ago

2.68.0

5 years ago

2.67.0

5 years ago

2.66.0

5 years ago

2.65.0

5 years ago

2.64.0

5 years ago

2.63.1

5 years ago

2.63.0

5 years ago

2.62.0

5 years ago

2.61.0

5 years ago

2.60.0

5 years ago

2.59.0

5 years ago

2.58.0

5 years ago

2.57.0

5 years ago

2.56.0

5 years ago

2.55.0

5 years ago

2.54.0

5 years ago

2.53.0

5 years ago

2.53.0-helper.0

5 years ago

2.52.0

6 years ago

2.51.0

6 years ago

2.50.0

6 years ago

2.49.0

6 years ago

2.48.0

6 years ago

2.47.0

6 years ago

2.46.0

6 years ago

2.45.0

6 years ago

2.44.0

6 years ago

2.43.0

6 years ago

2.41.1

6 years ago

2.42.0

6 years ago

2.41.0

6 years ago

2.40.0

6 years ago

2.39.0

6 years ago

2.38.0

6 years ago

2.37.0

6 years ago

2.36.0

6 years ago

2.35.1

6 years ago

2.35.0

6 years ago

2.34.0

6 years ago

2.33.0

6 years ago

2.32.1

6 years ago

2.32.0

6 years ago

2.31.0

6 years ago

2.30.0

6 years ago

2.29.0

6 years ago

2.28.0

6 years ago

2.27.0

6 years ago

2.26.0

6 years ago

2.25.1

6 years ago

2.25.0

6 years ago

2.24.1

6 years ago

2.24.0

6 years ago

2.23.0

6 years ago

2.22.0

6 years ago

2.21.0

6 years ago

2.20.1

6 years ago

2.20.0

6 years ago

2.19.2

6 years ago

2.19.1

6 years ago

2.19.0

6 years ago

2.18.1

6 years ago

2.18.0

6 years ago

2.17.1

6 years ago

2.17.0

6 years ago

2.16.2

6 years ago

2.16.1

6 years ago

2.16.0

6 years ago

2.15.0

6 years ago

2.14.0

6 years ago

2.13.0

6 years ago

2.11.2

6 years ago

2.11.1

6 years ago

2.11.0

6 years ago

2.10.0

6 years ago

2.9.0

6 years ago

2.8.0

7 years ago

2.7.1

7 years ago

2.7.0

7 years ago

2.6.1

7 years ago

2.7.0-0

7 years ago

2.6.0

7 years ago

2.5.2

7 years ago

2.5.1

7 years ago

2.5.0

7 years ago

2.4.4

7 years ago

2.4.3

7 years ago

2.4.2

7 years ago

2.4.1

7 years ago

2.3.0

7 years ago

2.2.1

7 years ago

2.2.0

7 years ago

2.1.0

7 years ago

2.0.3

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago

0.10.11

7 years ago

0.10.10

7 years ago

0.10.9

7 years ago

0.10.8

7 years ago

0.10.7

7 years ago

0.10.6

7 years ago

0.10.5

7 years ago

0.10.4

7 years ago

0.10.3

7 years ago

0.10.2

7 years ago

0.10.1

7 years ago

0.10.0

7 years ago

0.9.1

7 years ago

0.9.0

7 years ago

0.8.1

7 years ago

0.8.0

7 years ago

0.7.13

7 years ago

0.7.12

7 years ago

0.7.11

7 years ago

0.7.10

7 years ago

0.7.9

7 years ago

0.7.8

7 years ago

0.7.7

7 years ago

0.7.6

7 years ago

0.7.5

7 years ago

0.7.4

7 years ago

0.7.3

7 years ago

0.7.2

7 years ago

0.7.1

7 years ago

0.7.0

7 years ago

0.6.0

7 years ago

0.5.0

7 years ago

0.4.1

7 years ago

0.4.0

7 years ago

0.3.0

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago

0.0.8

7 years ago

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago

1.2.2

7 years ago