@kontur.candy/tools
## Перед началом работы
Last updated 2 days ago by svee .
ISC · Repository · Original npm · Tarball · package.json
$ cnpm install @kontur.candy/tools 
SYNC missed versions from official npm registry.

Candy Tools

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

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

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

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

  • build
  • local-server
  • upgrade
  • dev-build
  • form-stats
  • resources-gc
  • localize

candy build

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

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

Опции

  • --watch (-w)

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

  • --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

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

  • --copy-static-files-for-full-build

    Копировать файлы статики, которые требуются для полной сборки ресурсов

  • --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 local-server

Запуск локального сервера форм, для просмотра сгенерированных форм.

Опции

  • --proxy-to (-p)

    URL API Candy, которое будет использоваться вместо локального fake-api. Например https://api.testkontur.ru/candy

  • --include-testing-script

    Подключить скрипт testing.min.js. Опция для поддрежки тестирующих скриптов, которые использют react-selenium-testing.

  • --redirect-to-debug-scripts (-d)

    При запуске страниц с формами делает редирект на страницу с параметром ?debug=true, которая форсирует подключение отладочных версий скриптов.

  • --read-gfv-from-cache-server (-c)

    Считывает gfv не из candy.resources, а из памяти

  • --development-mode

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

  • --verbose (-v)

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

candy upgrade

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

Опции

  • --gfvs (-g)

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

  • --use-ci-build

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

  • --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)

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

  • --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 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)

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

candy resources-gc

Очистка неиспользуемых файлов в каталоге ресурсов.

Опции

  • --dry-run (-d)

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

  • --development-mode

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

  • --verbose (-v)

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

candy localize

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

Опции

  • --gfv (-g)

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

  • --dictionary-only (-d)

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

  • --use-local-generator-sources

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

  • --development-mode

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

  • --verbose (-v)

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

Current Tags

  • 2.35.0                                ...           latest (2 days ago)

113 Versions

  • 2.35.0                                ...           2 days ago
  • 2.34.0                                ...           4 days ago
  • 2.33.0                                ...           4 days ago
  • 2.32.1                                ...           21 days ago
  • 2.32.0                                ...           a month ago
  • 2.31.0                                ...           a month ago
  • 2.30.0                                ...           2 months ago
  • 2.29.0                                ...           2 months ago
  • 2.28.0                                ...           2 months ago
  • 2.27.0                                ...           2 months ago
  • 2.26.0                                ...           2 months ago
  • 2.25.1                                ...           2 months ago
  • 2.25.0                                ...           2 months ago
  • 2.24.1                                ...           3 months ago
  • 2.24.0                                ...           3 months ago
  • 2.23.0                                ...           4 months ago
  • 2.22.0                                ...           4 months ago
  • 2.21.0                                ...           4 months ago
  • 2.20.1                                ...           4 months ago
  • 2.20.0                                ...           4 months ago
  • 2.19.2                                ...           4 months ago
  • 2.19.1                                ...           4 months ago
  • 2.19.0                                ...           4 months ago
  • 2.18.1                                ...           4 months ago
  • 2.18.0                                ...           4 months ago
  • 2.17.1                                ...           4 months ago
  • 2.17.0                                ...           4 months ago
  • 2.16.2                                ...           4 months ago
  • 2.16.1                                ...           4 months ago
  • 2.16.0                                ...           4 months ago
  • 2.15.0                                ...           5 months ago
  • 2.14.0                                ...           5 months ago
  • 2.13.0                                ...           5 months ago
  • 2.12.0-build-server.1                                ...           5 months ago
  • 2.12.0-build-server.0                                ...           5 months ago
  • 2.8.0-build-server.0                                ...           5 months ago
  • 2.11.2                                ...           5 months ago
  • 2.11.1                                ...           5 months ago
  • 2.11.1-localization.0                                ...           5 months ago
  • 2.11.0                                ...           6 months ago
  • 2.10.0                                ...           7 months ago
  • 2.9.0                                ...           7 months ago
  • 2.8.0                                ...           7 months ago
  • 2.7.1                                ...           7 months ago
  • 2.7.0                                ...           8 months ago
  • 2.6.1                                ...           8 months ago
  • 2.7.0-0                                ...           8 months ago
  • 2.6.0                                ...           8 months ago
  • 2.5.2                                ...           8 months ago
  • 2.5.1                                ...           8 months ago
  • 2.5.0                                ...           8 months ago
  • 2.4.4                                ...           9 months ago
  • 2.4.3                                ...           9 months ago
  • 2.4.2                                ...           9 months ago
  • 2.4.1                                ...           9 months ago
  • 2.3.0                                ...           9 months ago
  • 2.2.1                                ...           9 months ago
  • 2.2.0                                ...           9 months ago
  • 2.1.0                                ...           9 months ago
  • 2.0.3                                ...           9 months ago
  • 2.0.2                                ...           9 months ago
  • 2.0.1                                ...           9 months ago
  • 2.0.0                                ...           10 months ago
  • 0.10.11                                ...           10 months ago
  • 0.10.10                                ...           10 months ago
  • 0.10.9                                ...           10 months ago
  • 0.10.8                                ...           10 months ago
  • 0.10.7                                ...           10 months ago
  • 0.10.6                                ...           10 months ago
  • 0.10.5                                ...           10 months ago
  • 0.10.4                                ...           10 months ago
  • 0.10.3                                ...           10 months ago
  • 0.10.2                                ...           10 months ago
  • 0.10.1                                ...           10 months ago
  • 0.10.0                                ...           10 months ago
  • 0.9.1                                ...           10 months ago
  • 0.9.0                                ...           10 months ago
  • 0.8.1                                ...           10 months ago
  • 0.8.0                                ...           10 months ago
  • 0.7.13                                ...           10 months ago
  • 0.7.12                                ...           10 months ago
  • 0.7.11                                ...           10 months ago
  • 0.7.10                                ...           10 months ago
  • 0.7.9                                ...           10 months ago
  • 0.7.8                                ...           10 months ago
  • 0.7.7                                ...           10 months ago
  • 0.7.6                                ...           10 months ago
  • 0.7.5                                ...           10 months ago
  • 0.7.4                                ...           10 months ago
  • 0.7.3                                ...           10 months ago
  • 0.7.2                                ...           10 months ago
  • 0.7.1                                ...           10 months ago
  • 0.7.0                                ...           10 months ago
  • 0.6.0                                ...           10 months ago
  • 0.5.0                                ...           10 months ago
  • 0.4.1                                ...           a year ago
  • 0.4.0                                ...           a year ago
  • 0.3.0                                ...           a year ago
  • 0.2.4                                ...           a year ago
  • 0.2.3                                ...           a year ago
  • 0.2.2                                ...           a year ago
  • 0.2.1                                ...           a year ago
  • 0.2.0                                ...           a year ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           a year ago
  • 0.0.8                                ...           a year ago
  • 0.0.7                                ...           a year ago
  • 0.0.6                                ...           a year ago
  • 0.0.5                                ...           a year ago
  • 0.0.4                                ...           a year ago
  • 0.0.3                                ...           a year ago
  • 0.0.2                                ...           a year ago
  • 0.0.1                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 156
Last Day 115
Last Week 155
Last Month 112
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |