✨ Add schema to gitmojis
#1263
Merged
✨ Add schema to gitmojis
#1263
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
By using the $schema the editors can more easily provide insight on missing properties rather than waiting for the user to run the lint
This would be helpful in the scenario where someone uses the API to download the gitmojis information, and want to override something locally on their machine. The $schema would help make sure other tools like gitmoji-cli keep working with the local customizations included.
vhoyer
force-pushed
the
add-schema-to-gitmojis-json
branch
from
7ecafdf to
80ad80c
Compare
Otherwise if we imported any other path containing a "src" substring, it would fail the import
packages/gitmojis/package.json
Outdated
| @@ -4,7 +4,9 @@ | |||
| "description": "An emoji guide for your commit messages.", | |||
| "main": "src/gitmojis.json", | |||
| "files": [ | |||
| "src/gitmojis.json" | |||
| "src/gitmojis.d.ts", | |||
There was a problem hiding this comment.
I think we can drop this as it's already specified in types:
Suggested change
| "src/gitmojis.d.ts", |
There was a problem hiding this comment.
I find it strange that we wouldn't need the types in the files array, because the types are declared on the package.json, but when we install the gitmojis pagackage outside the monorepo, the types file isn't present, which would lead to difficulties for other people trying to use the gitmoji type
There was a problem hiding this comment.
@carloscuesta and I think that's a problem, actually, should I open an issue about it, or can we keep using this thread to discuss this?
carloscuesta
force-pushed
the
add-schema-to-gitmojis-json
branch
from
750fbb9 to
cd340d3
Compare
|
thanks for the changes |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Just read the commit messages, I go into detail on why I'm proposing those changes, if you want to discard the last commit (validation through API), and merging only the first one, I also wouldn't see any issue.
Linked issues