vanessa-automation icon indicating copy to clipboard operation
vanessa-automation copied to clipboard

Возможность создавать описание шагов в формате Markdown

Open alkoleft opened this issue 3 years ago • 8 comments

Заполните шаблон обсуждения GIT

Функционал: возможность указывать описание шагов в формате Markdown
   Как разработчик шагов
   Я хочу формировать расширенное форматированное описание шага

Сценарий: Форматированное описание шагов
  Когда: Я создаю шаги и указываю описание шага в формате Markdown
  Тогда: Я получаю красивое структурированное описание шага

Прикладывайте файлы скриншотов

Пример описания:

# Шаг: И Я создаю структуру "ДанныеПоста"

Создает и помещает в переменные структуру данных.
Первая колонка - реквизиты, вторая - значения реквизитов

Пример:

```gherkin
      И Я создаю структуру "ДанныеПоста"
      | title    | Тестовый пост     |
      | body     | Это тестовый пост |
      | userId   | 1                 |
      | comments | $Комментарии$     |

alkoleft avatar Sep 10 '21 15:09 alkoleft

Связанно с #340

alkoleft avatar Sep 10 '21 15:09 alkoleft

@alkoleft Подскажи, где будет отображаться описание шагов в формате markdown?

Pr-Mex avatar Sep 10 '21 17:09 Pr-Mex

Текущая потребность - это форма известных шагов, должно работать и на старых версиях 1С (до использования webView) Но также думаю будет не лишним и во всплывающих подсказках VSCode

alkoleft avatar Sep 10 '21 20:09 alkoleft

@alkoleft А как отображают маркдаун на форме 1С без поля html документа?

Pr-Mex avatar Sep 10 '21 20:09 Pr-Mex

А почему ты решил что без html документа? VA должна взять на себя работу по превращению markdown в html и отображению.

Сейчас смотрю какие есть инструменты для этого

alkoleft avatar Sep 11 '21 08:09 alkoleft

а зачем вообще рендерить маркдаун? он и так довольно выразительный в плане человеко-читаемого отображения. не говоря уже о том, что можно и без маркдауна, просто текстом описать :) пример описания из первого сообщения вполне читабелен и без рендера

nixel2007 avatar Sep 11 '21 10:09 nixel2007

А почему ты решил что без html документа? VA должна взять на себя работу по превращению markdown в html и отображению.

Сейчас смотрю какие есть инструменты для этого

А, ок.

Pr-Mex avatar Sep 11 '21 11:09 Pr-Mex

а зачем вообще рендерить маркдаун? он и так довольно выразительный в плане человеко-читаемого отображения. не говоря уже о том, что можно и без маркдауна, просто текстом описать :) пример описания из первого сообщения вполне читабелен и без рендера

Хочется гибкую или картинку ещё добавить в описание шага. Открывает пользователь библиотеку шагов и сразу видит, что делает шаг. Если конечно шаг имеет отображение.

Pr-Mex avatar Sep 11 '21 11:09 Pr-Mex