Плагин для IntelliJ IDEA для работы с платформой Citeck

Плагин для IntelliJ IDEA ускоряет работу с проектами и артефактами платформы Citeck. Поддерживаются Community и Ultimate версии IntelliJ IDEA.

Исходный код плагина: ecos-idea-plugin

Примечание

Минимально необходимые версии:

  • IntelliJ IDEA — 2022.2.5.

  • Citeck — 4.2

Установка плагина

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

Далее установите плагин в IDEA: Settings -> Plugins -> Install Plugin from disk

../../_images/install_disk.png

Обновление плагина

Для обновления скачайте последнюю версию дистрибутива плагина из release page

Удалите старую версию из Settings -> Plugins и установите последнюю версию плагина Settings -> Plugins -> Install Plugin from disk

Функционал плагина

Создание новых проектов Citeck

Плагин позволяет создавать новые проекты Citeck (приложение, микросервис).

File -> New project

Доступен пункт Citeck и варианты создания приложения/ микросервиса:

../../_images/0113.png
../../_images/0212.png

Создается проект с соответствующей структурой:

Приложение

../../_images/038.png

Микросервис

../../_images/046.png

Создание артефактов по шаблону

По правой кнопке в контекстном меню доступен пункт New - Citeck Artifact:

../../_images/056.png

Вводим название:

../../_images/067.png

Артефакт генерируется в соответствии с шаблоном:

../../_images/077.png

Загрузка и выгрузка артефактов

Загрузка/выгрузка артефактов на/с локального сервера (формы, журналы, дашборды, процессы).

Для артефакта доступны следующие действия:

../../_images/087.png

  • Deploy File — выгрузка артефакта на сервер.

  • Fetch File — загрузка артефакта с сервера

  • Open In Browser — просмотр артефакта в браузере

  • Open Documentation — переход на страницу с документацией по артефакту

Пример: редактирование формы через no-code редактор

  1. Выгрузите артефакт по кнопке Deploy File на стенд или локально:

    ../../_images/deploy_a.png
    ../../_images/select_server.png
    ../../_images/deploy_b.png

  2. Откройте артефакт (например, форму) по кнопке Open In Browser в no-code редакторе на стенде или локально, отредактируйте:

    ../../_images/form_1.png
    ../../_images/form_2.png

  3. Загрузите измененный артефакт обратно по кнопке Fetch File:

    ../../_images/08_1.png

JSON-схемы для артефактов

Доступна подсветка синтаксиса при конфигурировании json/yaml артефактов.

../../_images/scheme_01.png
../../_images/scheme_02.png

Поиск артефактов

Поиск артефактов по их идентификаторам (расширение для search everywhere):

../../_images/095.png

Навигация в коде по артефактам

Навигация в коде по артефактам Citeck через гиперссылки:

../../_images/104.png

Автодополнение кода JavaScript

Типы

Для атрибутов formRef, journalRef и parentRef:

../../_images/autocomplete.png

Формы

Автодополнение объекта data списком компонент формы (IDEA Ultimate):

../../_images/115.png
../../_images/124.png

Навигация в файлах

  • Формы (быстрый переход к компонентам по их имени);

  • Журналы (навигация по колонкам);

  • Типы данных (быстрый переход к атрибутам, ролям, статусам и т.д.)

../../_images/134.png
../../_images/13_1.png

Инспекции кода

Формы — проверка уникальности ключей компонентов форм с учетом областей (container, datagrid).

../../_images/143.png

Генерация компонентов формы

Если в форме задан typeRef:

../../_images/comp_gen_01.png

то доступна генерация компонентов по атрибутам указанного в typeRef типа данных.

../../_images/comp_gen_02.png
../../_images/comp_gen_03.png
../../_images/comp_gen_04.png
../../_images/comp_gen_05.png

Расширение областей поиска

Расширение областей поиска файлами, содержащими артефакты Citeck:

../../_images/153.png

Конвертация YAML и JSON

Конвертация YAML -> JSON, JSON -> YAML:

../../_images/convert.png

Language Injection (JavaScript) в формах

../../_images/164.png

Деплой проекта

Деплой проекта возможен из meta.yml по нажатию на Deploy File:

../../_images/deploy_app_1.png

Далее можно нажать Open In Browser, чтобы посмотреть и отредактировать приложение в Citeck:

../../_images/app.png

Также деплоить можно из контекстного меню, выбрав Citeck-Deploy Application:

../../_images/deploy_app_2.png

Конфигурация серверов

Настройка серверов Citeck: Settings -> Citeck -> Servers.

Достаточно указать host, остальные параметры опциональны. Примеры настройки:

../../_images/server_settings.png

Для локального стенда используется метод basic.

Ввод логина и пароля для OIDC происходит в окне браузера, и плагин никак не взаимодействует с логином и паролем напрямую.

Для метода OAuth2 Client ID и Client Secret можно получить в соответствии с инструкцией.

Сборка дистрибутива плагина

  1. Для корректной сборки дистрибутива плагина необходимо убедиться, что используемая версия Gradle JVM не ниже 17.

    Настроить используемую JVM для Gradle в IDEA можно по следующему пути: Settings -> Build, Execution, Deployment -> Build Tools -> Gradle -> Gradle JVM

  2. Сборка осуществляется Gradle задачей buildPlugin.

  3. Собранный дистрибутив будет расположен по следующему пути: build/distributions/

Разработка

Для разработки плагина можно использовать Gradle задачу runIde.

При выполнении задачи будет запущен новый экземпляр IDEA с пересобранным плагином.