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

fix: expose plugin.configs in types #59

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

fasttime
Copy link
Member

Prerequisites checklist

What is the purpose of this pull request?

Refactor code to fix the types

What changes did you make? (Give an overview)

This PR fixes the tsc-generated type of plugin.configs. It does so by moving the configs object into the plugin declaration rather that assigning its fields in a separate step. I'm using a getter to cyclically reference plugin as plugin.configs.recommended.plugins.json.

Related Issues

fixes #52

Is there anything you'd like reviewers to focus on?

There are currently no type tests in this plugin. Shall we add some type tests as part of this PR?

@eslint-github-bot eslint-github-bot bot added the bug Something isn't working label Nov 12, 2024
@fasttime fasttime marked this pull request as ready for review November 12, 2024 16:44
@burtek
Copy link

burtek commented Nov 12, 2024

honestly, that's a clever fix. Was trying to figure out myself how to best approach this, but this is simple yet powerful and seems to get the job done. Haven't tested but looks like it should work

configs: {
recommended: {
plugins: {
get json() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we want to change this into a getter. We're essentially replacing a property lookup with a function call on a key that is retrieved a lot during config calculation.

Maybe we could leave plugins as an empty object here and just assign json into the object later?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change Request: Correct types for configs
3 participants