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

feat: Allow users to opt out of compat aliases #79

Merged
merged 4 commits into from
Aug 3, 2023

Conversation

rschristian
Copy link
Member

Closes #78

src/index.ts Outdated
* Whether to use preact/compat aliases
* @default true
*/
compatAliasesEnabled?: boolean;
Copy link
Member Author

Choose a reason for hiding this comment

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

Alternatively, preactCompatAliasesEnabled? Not sure what's best, open to suggestions

Copy link
Member

Choose a reason for hiding this comment

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

I'd also be fine with reactAliases: boolean since it's shorter. Technically we're not aliasing compat to something but rather react to compat.

Copy link
Member Author

Choose a reason for hiding this comment

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

That's true. I suppose we could also go compatEnabled; the end user is probably just looking at enabling/disabling compat, do they need to know it's done via aliases? Just a thought.

I do like having ...Enabled in the name, though -- matches the prefresh & devtools options and is also a bit more obvious that it's a boolean from a naming perspective.

src/index.ts Outdated Show resolved Hide resolved
@rschristian rschristian merged commit 4dfecb3 into main Aug 3, 2023
1 check passed
@rschristian rschristian deleted the feat/compat-aliases-option branch August 3, 2023 19:33
@jschuler
Copy link

Hi, how would I be able to get ahold of this? The latest version is 2.5.0 which was released before this change went in. I'm also not seeing a pre-release version? Thanks!

@rschristian
Copy link
Member Author

@jschuler You can patch your node_modules for now, I might be able to cut a release later this week but no guarantees

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Add compat option to disable preact/compat aliases
4 participants