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

[NEOS-1577] Auto-generate CLI Config JSON Schema #2868

Open
nickzelei opened this issue Oct 25, 2024 · 1 comment
Open

[NEOS-1577] Auto-generate CLI Config JSON Schema #2868

nickzelei opened this issue Oct 25, 2024 · 1 comment
Labels
CLI Created by Linear-GitHub Sync enhancement New feature or request good first issue Good for newcomers Hacktober Created by Linear-GitHub Sync

Comments

@nickzelei
Copy link
Member

nickzelei commented Oct 25, 2024

Would be awesome if we could have an auto-generated via go generate JSON schema for the CLI config yaml struct.

cmdConfig - https://github.com/nucleuscloud/neosync/blob/main/cli/internal/cmds/neosync/sync/sync.go#L76

I think we will need to add json tags to the struct, but then we could use https://github.com/invopop/jsonschema to generate one and have it committed into the repo. This would be great for folks to add further validation to their configs.

From SyncLinear.com | NEOS-1577

@nickzelei nickzelei added enhancement New feature or request good first issue Good for newcomers Hacktober Created by Linear-GitHub Sync labels Oct 25, 2024
@nickzelei
Copy link
Member Author

Might be worth investigating seeing how goreleaser does this:
https://goreleaser.com/cmd/goreleaser_jsonschema/

@nickzelei nickzelei added the CLI Created by Linear-GitHub Sync label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI Created by Linear-GitHub Sync enhancement New feature or request good first issue Good for newcomers Hacktober Created by Linear-GitHub Sync
Projects
None yet
Development

No branches or pull requests

1 participant