Add a "Forward unconsumed props" assist to analyzer plugin
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
Research direction
Start with the analyzer-plugin assist that adds a ref, then inspect the related issues #41 and #591. Define the assist for Dom.* builders and custom component builders, including automatic or placeholder consumedProps handling for the described mixin cases. Done means the assist inserts the correct modifyProps call and preserves a selectable FIXME group when mixins are ambiguous.
Written by the indexing model from the issue text.
Description
Similar to the assist that adds a ref, this assist would automatically add:
..modifyProps(addUnconsumedDomProps)
To Dom.* builders, and:
..modifyProps(addUnconsumedProps)
to custom component builders.
For the addUnconsumedProps one - the assist should also check to see if consumedProps is set, and if not - set it to:
@override
get consumedProps => propsMeta.forMixins({
NameOfSinglePropsMixinUsedByComponent
});
if the component only uses a single mixin, or if there is a mixin used by a concrete props class that matches the form: <NameOfFactory>PropsMixin.
If the prop mixin situation is more complicated than that, and there isn't already a consumedProps override in the class, add something like this - with the comment as a linked group so that the user's selection is there after the assist runs so that its highlighted, and so they can easily start typing the name of the mixin(s) they want to consume.
@override
get consumedProps => propsMeta.forMixins({
// FIXME: Add the names of mixin(s) with prop keys that should not be forwarded to the child component
});
Related to https://github.com/Workiva/over_react_analyzer_plugin/issues/41 / #591
Transferred from https://github.com/Workiva/over_react_analyzer_plugin/issues/56
- Dominant language
- Dart
- Stars
- 432
- Forks
- 57
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Workiva/over_react
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Workiva/over_react#981 · 4 comments · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Workiva/over_react#947 · 8 comments · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Workiva/over_react#942 · 8 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Workiva/over_react#939 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 20/100
Workiva/over_react#644 · 3 comments ·
All issues in Workiva/over_react
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
cat: puzzle
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
lichess-org/mobile#3826 ·
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
saber-notes/saber#1844 ·
-
area-clientside-dartpad
Difficulty 1/5 Under an hour Newbie friendliness 64/100
Maintainers usually reply within 2 days
-
🚀 [firebase_core] Bump Firebase iOS SDK (12.19.0 → 13.0.0)Possibly taken @SelaseKay claimed this today. OpenNeeds Attention type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
firebase/flutterfire#18769 · 1 comment ·
Maintainers usually reply within 1 day