Added JSON-Schema and how to set it up in readme

[leorush]

Добавил JSON-схему для авто-дополнения и in-line документации.
Пример работы в IDE Jetbrains:

Пример работы в IDE VSCode:

После добавления в репо, можно будет сделать ПР в JSON-Schema Storage, чтобы схема подтягивалась автоматом.
Предлагаю использовать расширение *.gonkey.yaml для авто-маппинга.

[leorush]

По расширению для тестов есть предложения? Может покороче? *.gnk.yaml например

[leorush]

@What-If-I посмотри пожалуйста.

[fetinin]

По расширению для тестов есть предложения? Может покороче? *.gnk.yaml например

А там ведь по пути до файла как я понял можно маппинг настроить. Может и не нужно более длинное расширение тащить?
Все тесты обычно лежат в папке cases или, если нужно больше конкретики, то gonkey/cases. С таким маппингом не надо будет все существующие тесты переименовывать.

@leorush, что по этому поводу думаешь?

[leorush]

Конечно можно маппинг настроить. Я на будущее, для того чтобы сделать ПР в Schema Store, чтобы вообще ничего настраивать не нужно было. Если включен авто-маппинг в настройках IDE, то она подтягивает схему с Schema Store.
А там нужно уникальное расширение. https://github.com/SchemaStore/schemastore/blob/master/CONTRIBUTING.md

[fetinin]

Понятно. Ещё бы мнения услышать, но мне кажется лучше *.gnk.yaml.
@luza, вы там пользуетесь Gonkey ещё?) Что думаешь?

И ещё наброшу, если подумать на будущее и представить что захочется добавить схему для файлов описывающих фикстуры, то как бы его назвали? gnk.fixture.yaml, gnkf.yaml? Может тогда файлы описывающие cases стоит назвать gnk.case.yaml или gnkc.yaml?🤔

[fetinin]

@keyclaim, ты что думаешь по поводу того как лучше назвать расширение файлов тест кейсов?

[luza]

Привет!

Я вижу примеры, где не требуется уникального расширения:
https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json#L100

Можем мы все-таки этим путем пойти?
Идея с расширениями не очень зашла.

[leorush]

Я вижу примеры, где не требуется уникального расширения
Можем мы все-таки этим путем пойти? Идея с расширениями не очень зашла.

Ну мы всех возможных комбинаций не сможем угадать. Переименовать тесты проще чем перекладывать в определённые папки как в примере.
Всегда остаётся вариант с ручным маппингом.

Ещё, в некоторых плагинах можно задавать схему комментарием: redhat-developer/vscode-yaml#401

[luza]

У меня все gonkey-тесты лежат в:

• /func_tests/cases/
• /func_tests/fixtures/

Мне подходит😁

У вас не устоялось каких-нибудь стандартных путей размещения файлов?

[leorush]

У вас не устоялось каких-нибудь стандартных путей размещения файлов?

Ну, у нас по-разному, test\cases\ и там по фичам/ручкам/т.п. папки.
Можно совместить все подходы, и с папками и с файлами, маска-то может быть не одна.
Главное чтобы не совпадало с какой другой схемой.

[keyclaim]

*.gnk.yaml

мне нравится такой вариант

вообще меня не напрягает подключать схему через путь к папке
но если будет возможность автоматом, то я только за

[fetinin]

Выглядит так что все описанные кейсы ложатся в паттерны **/cases/**/*.yaml и **/cases/*.yaml. В каталоге схемастора такие не заняты.

[leorush]

Ну и какой-нибудь *.gnk.yaml добавить можно. В любом случае, PR в Schema Store лучше делать не мне )

[leorush]

@What-If-I Смержи пожалуйста. И нужно решить кто будет делать ПР в JSON-Schema Storage

[github-actions]

🚀 PR was released in v1.18.3 🚀