Added typescript plugins dev guide #497
Open
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
mrigankmg
changed the title
hborawski
reviewed
Aug 29, 2024
mrigankmg
force-pushed
the
typescript-dev-guide
branch
2 times, most recently
from
a2a55f9
to
d89a41c
Compare
cehan-Chloe
reviewed
Aug 29, 2024
mrigankmg
force-pushed
the
typescript-dev-guide
branch
from
d89a41c
to
0463a4f
Compare
KetanReddy
reviewed
Aug 29, 2024
KetanReddy
reviewed
Aug 29, 2024
| ### Scaffold | ||
| All plugins follow a common structure: | ||
|
|
||
| The basic structure is as follows: |
There was a problem hiding this comment.
I would expand a bit on what that common structure is and why its important to make sure since it might not be immediately understandable by looking at the diagram
KetanReddy
reviewed
Aug 29, 2024
| { | ||
| "name": "@player-ui/example-plugin", | ||
| "version": "0.0.0-PLACEHOLDER", | ||
| "main": "src/index.tsx", |
There was a problem hiding this comment.
Nitpick but technically the entrypoint to a React Plugin doesn't have to be a .tsx file
KetanReddy
reviewed
Aug 29, 2024
KetanReddy
reviewed
Aug 29, 2024
KetanReddy
reviewed
Aug 29, 2024
mrigankmg
force-pushed
the
typescript-dev-guide
branch
from
4b490cf
to
2c4be0f
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #497 +/- ##
=======================================
Coverage 91.97% 91.97%
=======================================
Files 340 340
Lines 26960 26960
Branches 1945 1945
=======================================
Hits 24796 24796
Misses 2150 2150
Partials 14 14 ☔ View full report in Codecov by Sentry. |
mrigankmg
force-pushed
the
typescript-dev-guide
branch
from
2c4be0f
to
e409fe2
Compare
cehan-Chloe
reviewed
Sep 9, 2024
| ### Sections: | ||
| 1. [Setup](#Setup) | ||
| 2. [Adding a new plugin](#adding-a-new-plugin) | ||
| 2. [Dependencies](#Dependencies) |
There was a problem hiding this comment.
Suggested change
| 2. [Dependencies](#Dependencies) | |
| 3. [Dependencies](#Dependencies) |
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.
Added dev guide for typescript plugins.
Change Type (required)
Indicate the type of change your pull request is:
patchminormajorDoes your PR have any documentation updates?