over_react icon indicating copy to clipboard operation
over_react copied to clipboard

Add a "Forward unconsumed props" assist to analyzer plugin

Open aaronlademann-wf opened this issue 4 years ago • 0 comments

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

aaronlademann-wf avatar Jun 29 '20 13:06 aaronlademann-wf