-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
fix(types): tools export types added #2802
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
neSpecc
requested review from
gohabereg,
TatianaFomina and
ilyamore88
as code owners
August 3, 2024 19:45
neSpecc
changed the title
fix(type): tools export types added
fix(types): tools export types added
Aug 3, 2024
gohabereg
reviewed
Aug 5, 2024
gohabereg
approved these changes
Aug 5, 2024
TatianaFomina
approved these changes
Aug 7, 2024
gohabereg
approved these changes
Aug 8, 2024
ilyamore88
approved these changes
Aug 9, 2024
HI @neSpecc |
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.
Problem
Some compilers can't build projects with current editor.js import because of errors like that
Resolves #2771
Cause
In #2718 we introduced
api.tool.getBlockTools()
method that returnsBlockTool[]
objects which declared under the npmignored/src
folder.Solution
Confusing names
We have a confusing names in
src/components/tools/
:BlockTool
— it is not a block tool (see types/tools/block-tool.d.ts). It is more like block tool adapaterInlineTool
andBlockTune
So I've renamed them to
BlockToolAdapter
,InlineToolAdapter
,BlockTuneAdapter
across all the code.Now BlockTool has only one meaning declared in types/tools/block-tool.d.ts
Types for adapters
I've manually created types for adapters:
Classes in
src/components/tools/
implements those adapters interfaces.Also
/types
as well, but under.ts
files instead ofd.ts
(complier can't find enums values in d.ts)/types
as well@/types
aliasWe manually maintain
/types
which may be not-best solution today. We can consider autogenerating types in a future.