docs: recommend interface + symbol over class tokens for services#17792
Open
sdirix wants to merge 1 commit into
Open
docs: recommend interface + symbol over class tokens for services#17792sdirix wants to merge 1 commit into
sdirix wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
What it does
This is a proposal to reverse the "classes over interfaces + symbols" coding guideline. For replaceable services (most public services in Theia), we should recommend declaring an interface + symbol with a default implementation, instead of using a concrete class as both the injection token and the type.
A class token forces adopters to subclass the default implementation. Splitting interface and symbol lets adopters choose: subclass the default, or provide a fully independent implementation. It also makes testing easier, since a test double can satisfy the interface directly.
An exception are internal services that are not meant to be extension points, where a plain class as token/type is fine.
How to test
Nothing to test
Follow-ups
Breaking changes
Attribution
Review checklist
nlsservice (for details, please see the Internationalization/Localization section in the Coding Guidelines)Reminder for reviewers