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

Feature: schema validation for blocky configuration #1658

Open
speedst3r opened this issue Dec 8, 2024 · 1 comment
Open

Feature: schema validation for blocky configuration #1658

speedst3r opened this issue Dec 8, 2024 · 1 comment
Labels
🔨 enhancement New feature or request

Comments

@speedst3r
Copy link

When editing YAML documents, it is often helpful to have application specific linting and validation, such as the case with Frigate (https://docs.frigate.video/configuration/#vscode-configuration-schema).

I have cut a first draft of a schema for Blocky's configuration (by no means final, and not heavily tested) and am gauging whether there would be interest in this. An example in code-server with the YAML Language Server plugin is below (this would look similar in VSCode)

image

The current schema is in my fork - https://raw.githubusercontent.com/speedst3r/blocky/refs/heads/json-schema/config/schema.json

If there's appetite to include this I'd be happy to raise a PR.

@0xERR0R 0xERR0R added the 🔨 enhancement New feature or request label Dec 8, 2024
@0xERR0R
Copy link
Owner

0xERR0R commented Dec 8, 2024

I think, providing a JSON schema for the config file is a good idea. We can also use it for config validation on startup (if it provides more readable messages)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants