feat: stricter types for preconditions #226
Merged
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
kyranet
force-pushed
the
refactor/strict-type-preconditions
branch
from
d0e9f99 to
1e3f9c2
Compare
vladfrangu
previously approved these changes
Jul 13, 2021
favna
reviewed
Jul 14, 2021
| * @since 2.0.0 | ||
| * @param options The command options given from the constructor. | ||
| */ | ||
| protected parseConstructorPreConditions(options: CommandOptions): void { |
There was a problem hiding this comment.
Be sure to mention this in discordjs/guide#711 because otherwise people won't know they have to extend this to have their own custom preconditions with a constructor pattern.
favna
requested changes
Jul 14, 2021
favna
reviewed
Jul 14, 2021
There was a problem hiding this comment.
Whoever ends up hitting merge be sure to add a whiteline before the breaking changes:
So:
Fixed cooldown precondition not working when defining alias properties from `Command`.
BREAKING CHANGE: Changed `Command#preconditions` to `PreconditionContainerArray`.
Becomes:
Fixed cooldown precondition not working when defining alias properties from `Command`.
BREAKING CHANGE: Changed `Command#preconditions` to `PreconditionContainerArray`.
Added `Command#parseConstructorPreConditions`. Added `Command#parseConstructorPreConditionsRunIn`. Added `Command#parseConstructorPreConditionsNsfw`. Added `Command#parseConstructorPreConditionsRequiredClientPermissions`. Added `Command#parseConstructorPreConditionsCooldown`. Added `CommandPreConditions.Permissions`. Added `CommandOptions.cooldownScope`. Added `CommandOptions.requiredClientPermissions`. Added `Preconditions` interface, this strict types all precondition names and contexts. Added `PreconditionContainerArray#append`. Added `SimplePreconditionSingleResolvableDetails`. Fixed cooldown precondition not working when defining alias properties from `Command`. BREAKING CHANGE: Changed `Command#preconditions` to `PreconditionContainerArray`. BREAKING CHANGE: Removed `Command#resolveConstructorPreConditions`. BREAKING CHANGE: Renamed `CommandOptions.cooldownBucket` to `cooldownLimit`. BREAKING CHANGE: Renamed `CommandOptions.cooldownDuration` to `cooldownDelay`. BREAKING CHANGE: Renamed `BucketType` to `BucketScope`. BREAKING CHANGE: Changed `PreconditionSingleResolvableDetails` to take a type parameter. BREAKING CHANGE: Changed `PreconditionSingleResolvable` to use `Preconditions`'s type. BREAKING CHANGE: Renamed `CooldownContext.bucketType` to `scope`.
kyranet
force-pushed
the
refactor/strict-type-preconditions
branch
from
1e3f9c2 to
0462736
Compare
|
I force-pushed with a fixed description (and resolved requests), so the separation isn't needed, @favna |
favna
approved these changes
Jul 15, 2021
favna
changed the title
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.
Command#parseConstructorPreConditions.Command#parseConstructorPreConditionsRunIn.Command#parseConstructorPreConditionsNsfw.Command#parseConstructorPreConditionsRequiredClientPermissions.Command#parseConstructorPreConditionsCooldown.CommandPreConditions.Permissions.CommandOptions.cooldownScope.CommandOptions.requiredClientPermissions.Preconditionsinterface, this strict types all precondition names and contexts.PreconditionContainerArray#append.SimplePreconditionSingleResolvableDetails.Command.Command#preconditionstoPreconditionContainerArray.Command#resolveConstructorPreConditions.CommandOptions.cooldownBuckettocooldownLimit.CommandOptions.cooldownDurationtocooldownDelay.BucketTypetoBucketScope.PreconditionSingleResolvableDetailsto take a type parameter.PreconditionSingleResolvableto usePreconditions's type.CooldownContext.bucketTypetoscope.