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: remove CommandChatInputRegisterShortcut alias interface, prefer using ApplicationCommandRegistry.RegisterOptions instead #597

Merged
merged 2 commits into from
Feb 5, 2023

Conversation

favna
Copy link
Member

@favna favna commented Feb 5, 2023

The old interface exposed options that were not actually supported
by Sapphire, which was misleading. The whole interface could in fact
be removed as it is was an alias for ApplicationCommandRegistry.RegisterOptions.

Arguebly a breaking change for TypeScript users, but because the transition to ApplicationCommandRegistry.RegisterOptions is a simple find-and-replace we are pushing this out in a minor version.

…ias for `ApplicationCommandRegistry.RegisterOptions`

The old interface exposed options that were not actually supported
by Sapphire, which was misleading. The whole interface could in fact
be removed, but that would be a breaking change, so for now we mark
it as deprecated and make it a type alias.

While normally removing interface options would be a breaking change too,
these particular options already did absolutely nothing and weren't
being read anywhere anymore. Anyone who still had this option and
will get a TypeScript build error can simply remove the options.
@vladfrangu
Copy link
Member

I'd rather we just remove it in a minor version. since it's not used anywhere it's not like it'd matter (yes I KNOW semver and all)

@favna favna changed the title feat(CommandChatInputRegisterShortcut): change interaction to type alias for ApplicationCommandRegistry.RegisterOptions refactor(CommandChatInputRegisterShortcut): change interaction to type alias for ApplicationCommandRegistry.RegisterOptions Feb 5, 2023
@favna favna changed the title refactor(CommandChatInputRegisterShortcut): change interaction to type alias for ApplicationCommandRegistry.RegisterOptions feat(CommandChatInputRegisterShortcut): change interaction to type alias for ApplicationCommandRegistry.RegisterOptions Feb 5, 2023
@favna favna self-assigned this Feb 5, 2023
@favna favna changed the title feat(CommandChatInputRegisterShortcut): change interaction to type alias for ApplicationCommandRegistry.RegisterOptions feat: remove CommandChatInputRegisterShortcut alias interface, prefer using ApplicationCommandRegistry.RegisterOptions instead Feb 5, 2023
@favna
Copy link
Member Author

favna commented Feb 5, 2023

@sapphiredev pack

@sapphiredev
Copy link

sapphiredev bot commented Feb 5, 2023

Heya @favna, I've started to run the deployment workflow on this PR at 0df770f. You can monitor the build here!

@sapphiredev
Copy link

sapphiredev bot commented Feb 5, 2023

Hey @favna, I've released this to NPM. You can install it for testing like so:

npm install @sapphire/framework@pr-597

@favna favna merged commit 18ad9fa into main Feb 5, 2023
@favna favna deleted the feat/remove-deprecated-option branch February 5, 2023 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants