Types: allow for arbitrary theme values (for 3rd party plugins) #7926
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
RobinMalfait
force-pushed
the
further-improve-types
branch
from
9349597
to
4147433
Compare
|
@anosadal everything alright buddy? |
This is useful for third party plugins otherwise you will get an error.
This will give you code completion in the `theme()` function. The reason
it is still a WIP is that this only works with the default config right
now and not 100% sure if it is possible to define generics in JSDoc.
The idea would be to:
- Provide types from the default config
- Provide types from the custom config (e.g.: 3rd party plugin)
- Override default config types with the overrides of the user's config
Right now this only provides types for the defaultConfig which might
result in dropping all of this in favor of a much simpler:
```ts
theme<D = any>(path: string, defaultValue: D) => D
```
But this sadly doesn't give you "nice" auto completion. However, the
default might be good enough if we don't error on for example
`theme('customPlugin')` which is currently not the case.
RobinMalfait
force-pushed
the
further-improve-types
branch
from
fa6c107
to
5bed0bf
Compare
RobinMalfait
changed the title
Since currently we don't want to investigate time to make the code completion *perfect* (because it might be even impossible to do it properly due to resolving of overrides, extend and deeply nested presets) For now we will provide a way simpler type, which is better than incorrect types. So far we only had types for the default config theme *only*.
RobinMalfait
force-pushed
the
further-improve-types
branch
from
5bed0bf
to
acb49e4
Compare
47 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR provides more improvements to the types config.
themesection for third party plugins.Provides code completion for thetheme()helper function