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

Public schema for .all-contributorsrc #685

Open
EndBug opened this issue Feb 3, 2023 · 9 comments
Open

Public schema for .all-contributorsrc #685

EndBug opened this issue Feb 3, 2023 · 9 comments
Labels
enhancement New feature or request

Comments

@EndBug
Copy link
Contributor

EndBug commented Feb 3, 2023

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.

PR: SchemaStore/schemastore#2777

@EndBug EndBug added the enhancement New feature or request label Feb 3, 2023
@EndBug
Copy link
Contributor Author

EndBug commented Feb 4, 2023

Public schema available here: https://json.schemastore.org/all-contributors.json

@VeckoTheGecko
Copy link

VeckoTheGecko commented Mar 24, 2023

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"

@EndBug
Copy link
Contributor Author

EndBug commented Mar 24, 2023

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 ✨

@EndBug
Copy link
Contributor Author

EndBug commented Mar 24, 2023

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

@VeckoTheGecko
Copy link

Awesome! I was actually crawling through the codebase for "none" but couldn't find it 😄 . Good to know its valid

@EndBug
Copy link
Contributor Author

EndBug commented Mar 24, 2023

Just opened a PR in both repos, we just need to wait for the maintainers ;)

@Berkmann18
Copy link
Member

Would that be synced up whenever the config schema was updated?

@EndBug
Copy link
Contributor Author

EndBug commented May 20, 2023

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.

@Berkmann18
Copy link
Member

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).

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

3 participants