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

Write a schema for scenario YAML files #953

Open
xmkg opened this issue Jul 26, 2024 · 3 comments
Open

Write a schema for scenario YAML files #953

xmkg opened this issue Jul 26, 2024 · 3 comments

Comments

@xmkg
Copy link
Contributor

xmkg commented Jul 26, 2024

YAML schemas allow code completion and highlighting for many IDEs and editors, including Eclipse, VS Code, IntelliJ, Emacs, and vim. They're usually stored in a central registry such as https://www.schemastore.org/json/.

A proper YAML schema can make it easier to write scenarios and allow IDEs to lint the scenario files on the fly.

@xmkg
Copy link
Contributor Author

xmkg commented Jul 26, 2024

For this, we'd probably have to switch to an "identifiable" file extension, e.g. ".hotsos.yaml".

@nicolasbock
Copy link
Contributor

Instead of file name, would a particular key/value work too? Something like

hotsos-schema: v1

@xmkg
Copy link
Contributor Author

xmkg commented Jul 29, 2024

Instead of file name, would a particular key/value work too? Something like

There are schema specification methods for different plugins (comments, specific YAML key) but I couldn't find a common denominator. I'll research more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants