Public schema for `.all-contributorsrc`
EndBug opened this issue · comments
This is not really a feature request ahahh
I've opened a PR to SchemaStore/schemastore so that we can add a JSON schema for the config file to their database. This way if someone opens the config file in an IDE that supports JSON schemas they'll get intellisense/autocompletion on the properties.
Public schema available here: https://json.schemastore.org/all-contributors.json
Great feature @EndBug ! Just started using it, and I'm not sure if the schema is 100% accurate. I have "commitConvention": "none" in my config, which I think is valid (according to some of the conversation in this repo) but its not accounted for in the schema. I don't know, maybe its since been deprecated.
The "none" option is also not listed in the documentation, adding to the confusion. Maybe a maintainer can provide some more insight into this.
extra: another repo successfully uses "commitConvention": "none"
Nice catch! Yeah, I built the schema from the docs, which seem to be outdated :/
I'll add "none" to the valid options, and maybe also open a PR to update the docs
Thanks ✨
Btw, here's the evidence of "none" being a valid value, different from "": https://github.com/all-contributors/cli/blob/96534ec59b2e45051d517dee56967e2f9e6da371/src/init/commit-conventions.js#L33
Awesome! I was actually crawling through the codebase for "none" but couldn't find it 😄 . Good to know its valid
Just opened a PR in both repos, we just need to wait for the maintainers ;)
Would that be synced up whenever the config schema was updated?
Would that be synced up whenever the config schema was updated?
@Berkmann18 Ideally, the project itself would update the public schema for its users. But when that doesn't happen, anyone can submit a PR to SchemaStore/schemastore to update it, kind of like everyone can update DefinitelyTyped type definitions.
If the project wants to commit to updating the schema itself, then we can change the data in SchemaStore so that it will point to this GitHub repo.
That's good to know. I guess it will be even easier once the new project structure comes into effect (not sure yet when that happens as I will try to get the fetching feature moving).