Define widget driver as an interface #128
Draft
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
hughns
force-pushed
the
hughns/widgetdriver-interface
branch
from
9af7782 to
b858623
Compare
- Adds `IWidgetDriver` interface - Renames `WidgetDriver` to `BaseWidgetDriver` with old name (`WidgetDriver`) supported but deprecated The goal here is to mean that a client that is implementing a driver can more easily see at compile time what is changing between versions. However, this would mean that we need to change the versioning policy as any addition to IWidgetDriver would be a breaking change (so major version bump). Whereas, at the moment we don't do a major version bump because the abstract WidgetDriver class doesn't require the implementing client to implement anything.
hughns
force-pushed
the
hughns/widgetdriver-interface
branch
from
b858623 to
697ea19
Compare
|
I like this idea. |
Yes, purpose would be to help us less make fewer mistakes in future. |
|
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.
IWidgetDriverinterfaceWidgetDrivertoBaseWidgetDriverwith old name (WidgetDriver) supported but deprecatedThe goal here is to mean that a client that is implementing a driver can more easily see at compile time what is changing between versions.
However, this would mean that we need to change the versioning policy as any addition to IWidgetDriver would be a breaking change (so major version bump). Whereas, at the moment we don't do a major version bump because the abstract WidgetDriver class doesn't require the implementing client to implement anything.
A further thought: if we want to introduce an optional driver method in future, then we can simply make it an optional field on
IWidgetDriveritself. That way theClientWidgetApiis forced to at least consider compatibility.