Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Aug 11, 2022

Conversation

leorush
Copy link
Contributor

@leorush leorush commented Jul 1, 2022

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

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

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@leorush
Copy link
Contributor Author

leorush commented Jul 5, 2022

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

@leorush leorush requested a review from fetinin July 5, 2022 19:02
@leorush
Copy link
Contributor Author

leorush commented Jul 9, 2022

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

@fetinin
Copy link
Contributor

fetinin commented Jul 12, 2022

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

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

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

@fetinin fetinin added documentation Improvements or additions to documentation patch release as patch labels Jul 12, 2022
@leorush
Copy link
Contributor Author

leorush commented Jul 12, 2022

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

@fetinin
Copy link
Contributor

fetinin commented Jul 12, 2022

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

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

@fetinin
Copy link
Contributor

fetinin commented Jul 18, 2022

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

@luza
Copy link
Contributor

luza commented Jul 18, 2022

Привет!

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

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

@leorush
Copy link
Contributor Author

leorush commented Jul 18, 2022

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

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

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

@luza
Copy link
Contributor

luza commented Jul 18, 2022

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

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

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

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

@leorush
Copy link
Contributor Author

leorush commented Jul 18, 2022

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

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

@keyclaim
Copy link
Contributor

keyclaim commented Jul 18, 2022

*.gnk.yaml

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

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

@fetinin
Copy link
Contributor

fetinin commented Jul 18, 2022

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

@leorush
Copy link
Contributor Author

leorush commented Jul 18, 2022

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

@fetinin fetinin added skip-release skip release on merge to master and removed patch release as patch labels Jul 21, 2022
@leorush
Copy link
Contributor Author

leorush commented Aug 8, 2022

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

@vitkarpenko vitkarpenko merged commit 6599169 into lamoda:master Aug 11, 2022
@github-actions
Copy link

🚀 PR was released in v1.18.3 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released skip-release skip release on merge to master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants