Workiva / Workiva/over_react

Add a "Forward unconsumed props" assist to analyzer plugin

Open
#590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-analyzer-plugin
Dominant language
Dart
Stars
432
Forks
57
PR merge metrics
No merged PRs in 30d

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
dart
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.